docs: Annotate unused parameters for structured output examples#1787
Closed
xtzie wants to merge 1 commit intomodelcontextprotocol:mainfrom
Closed
docs: Annotate unused parameters for structured output examples#1787xtzie wants to merge 1 commit intomodelcontextprotocol:mainfrom
xtzie wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Update README and example code to indicate parameters are available but not used for the examples
Contributor
|
Not really needed. These are more pseudo code examples rather than production code, it doesn't make much sense to show that the params aren't used since they clearly wouldn't be with dummy data. They're there for demonstration purposes rather than actual functinoality. |
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
2 participants
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
Update the README and example code to clarify that parameters are defined but not used in the examples.
Rationale
All other example snippets consistently use passed parameters. It was briefly confusing when I read the structured output snippets and had to double back to ensure they were indeed placeholder variables.