Tutorial scaffolding 01 #1293
Closed
Tutorial scaffolding 01 #1293
+2,952
−269
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive instructions for building and viewing documentation locally, including macOS Cairo library workaround and development workflow details.
Add documentation build section to CONTRIBUTING.md
* fix indentation in CONTRIBUTING.md * fix (more) indentation in CONTRIBUTING.md
* docs: improve comprehensive docstring coverage throughout MCP SDK Add extensive docstrings following Google Python Style Guide with Markdown formatting for mkdocs-material compatibility. ## Enhanced documentation for: ### Core framework - **FastMCP**: Main server class with detailed Args/Examples sections - **Context**: Request context with capability descriptions - **Tool/Resource/Prompt**: Base classes with comprehensive attributes ### Client implementation - **ClientSession**: Enhanced call_tool() with extensive examples - Added initialization and core method documentation ### Exception handling - **FastMCPError hierarchy**: Detailed error descriptions and use cases - **McpError**: Protocol error handling documentation ### Utilities and helpers - **RequestContext**: Request metadata and session information - **ToolManager/Resource classes**: Registration and execution docs ## Standards followed: - Google Python Style Guide format (Args/Returns/Raises) - Sentence case headings throughout - Examples properly placed in Examples sections - mkdocs-material compatible Markdown formatting - Type safety maintained (all tests pass) ## Quality assurance: ✅ Code formatted with Ruff ✅ Type checking passes (Pyright) ✅ Linting checks pass ✅ Full test suite passes (528 tests) Improves developer experience with comprehensive API documentation covering public interfaces, usage patterns, and examples. * fix escaped docstring fencing * Revert "fix escaped docstring fencing" This reverts commit 1e25f60.
* Fix griffe warnings in mkdocs documentation generation - Remove **extra parameter documentation that doesn't match function signature in fastmcp/server.py - Fix malformed docstring structure in func_metadata.py by moving content to proper Note section - Correct parameter name mismatch in lowlevel/server.py lifespan function docstring 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * autgenerate API reference nav --------- Co-authored-by: Claude <noreply@anthropic.com>
* site config (URL, site name, API ref tweaks) * Shard README into *.md in docs/ * minor quickstart tweak
* new example docs * fixed nav * fix doc index and TOC * examples feature matrix * populate transport column * link to example headings
* misc doc work * Enhance SDK docstrings for better new user experience Add comprehensive documentation for key MCP SDK methods and request context: - send_log_message: Access patterns, logging levels, examples - check_client_capability: Capability checking with real examples - elicit methods: Interactive data collection documentation - Request context ecosystem: RequestContext, Context, access patterns - Cross-references and practical examples throughout All changes follow Google Python Style Guide and include verified code examples. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
- Fix absolute link to relative in examples-lowlevel-servers.md - Add missing return type annotation to session property - Remove broken cross-references to type aliases (RequestId, ElicitationResult) - Update CLAUDE.md documentation build command
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context