Skip to content

Improve client documentation #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged

Improve client documentation #517

merged 1 commit into from
May 20, 2025

Conversation

jlowin
Copy link
Owner

@jlowin jlowin commented May 20, 2025

No description provided.

@Copilot Copilot AI review requested due to automatic review settings May 20, 2025 15:44
@github-actions github-actions bot added documentation Improvements or additions to documentation tests component: client labels May 20, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the client documentation and makes minor code adjustments to align parameter naming for log handling. Key changes include:

  • Renaming a parameter in tests for clarity.
  • Refactoring the logging type alias and callback usage.
  • Updating documentation by adding a new features page and revising the client usage guide.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/client/test_logs.py Renamed parameter in handle_log for improved clarity.
src/fastmcp/client/logging.py Refactored logging type alias and added create_log_callback for better API design.
src/fastmcp/client/client.py Updated logging callback setup to leverage create_log_callback.
docs/docs.json Added a new documentation page reference under Clients.
docs/clients/features.mdx Introduced an advanced features documentation page detailing new capabilities.
docs/clients/client.mdx Revised the client documentation structure and removed some outdated sections.
Comments suppressed due to low confidence (2)

tests/client/test_logs.py:12

  • The renaming from 'params' to 'message' improves clarity; please verify that all call sites and related documentation have been updated accordingly.
async def handle_log(self, message: LogMessage) -> None:

docs/clients/client.mdx:264

  • [nitpick] The removal of sections covering progress tracking, LLM sampling, and logging examples may leave gaps; please ensure that essential guidance for these features remains accessible to users.
#### Error Handling

@jlowin jlowin merged commit 4851f6e into main May 20, 2025
6 checks passed
@jlowin jlowin deleted the client-docs branch May 20, 2025 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: client documentation Improvements or additions to documentation tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant