fix(docs): use correct Parameters<T> syntax in tool examples#814
Open
lutz-grex wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
fix(docs): use correct Parameters<T> syntax in tool examples#814lutz-grex wants to merge 1 commit intomodelcontextprotocol:mainfrom
lutz-grex wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
The README examples used `#[tool(param)]` on function parameters, which is not a supported syntax and fails to compile. Replace with the `Parameters<T>` wrapper pattern that the macros actually expect. Closes modelcontextprotocol#812
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
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.
The README examples used
#[tool(param)]on function parameters, which is not a supported syntax and fails to compile. Replace with theParameters<T>wrapper pattern that the macros actually expect.Closes #812
Motivation and Context
Users copying the README tool examples get a compile error:
The
#[tool(param)]attribute on function parameters was never implemented. The correct pattern isParameters<T>with a struct deriving
JsonSchema, as used inexamples/servers/src/common/calculator.rs.How Has This Been Tested?
cargo checkexamples/servers/src/common/calculator.rsBreaking Changes
None
Types of changes
Checklist
Additional context
Both the English (
README.md) and Chinese (docs/readme/README.zh-cn.md) READMEs contained the same incorrectexamples - both are fixed in this PR.