docs: comprehensive documentation audit for MCP 2025-11-25 #82
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
- Fix HTML tag warning in handler.rs (wrap generics in backticks) - Fix broken intra-doc links in resources-demo (wrap macros in backticks) - Fix URL hyperlink warnings in OAuth modules (add angle brackets) - Update README with MCP 2025-11-25 announcement - Update version numbers from 0.4.1 to 0.15 - Update code examples with new API patterns (builder, with_description) - Update Tool struct fields and CallToolResult convenience methods - Remove references to deleted crates, add mcp-macros section
- Update mcp-server lib.rs Quick Start with builder pattern - Use Implementation::with_description() instead of struct literals - Use ServerCapabilities::builder().enable_tools().build() - Use CallToolResult::empty() convenience method - Fix next_cursor: Option<String> in examples - Update MACRO_GUIDE.md version from 0.6 to 0.15
Code Coverage Report 📊Local Coverage: 22.66%
Coverage Details📋 Full Report: View on Codecov |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
PR Validation ResultsQuick Validation: ✅
Compatibility Check: ✅
Summary: ✅ All checks passed |
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.
Summary
Changes
Rustdoc Fixes
mcp-server/handler.rs: WrapHashMap<ClientId, HashSet<String>>in backticks (HTML tag warning)examples/resources-demo/main.rs: Wrap#[mcp_resource]in backticks (broken intra-doc link)mcp-auth/oauth/*.rs: Add angle brackets around URLs for proper hyperlinksREADME Updates
ServerCapabilities::builder().enable_tools().build()Implementation::with_description()CallToolResult::text()Toolstruct fieldsDocumentation Updates
mcp-server/lib.rs: Updated Quick Start example with MCP 2025-11-25 patternsdocs/MACRO_GUIDE.md: Updated version from 0.6 to 0.15Test Plan
cargo doc --workspace --no-depsproduces zero warningscargo test --workspacepasses all testsCloses #39