-
Notifications
You must be signed in to change notification settings - Fork 548
feat: relax outputSchema to accept non-object JSON Schema types (SEP-2106) #895
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
Open
branben
wants to merge
3
commits into
modelcontextprotocol:main
Choose a base branch
from
branben:feat/sep-2106-output-schema-non-object
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+302
−53
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -65,13 +65,7 @@ pub trait ToolBase { | |||||||||||||
| /// | ||||||||||||||
| /// If the tool does not have any output, you should override this methods to return [`None`]. | ||||||||||||||
| fn output_schema() -> Option<Arc<JsonObject>> { | ||||||||||||||
| Some(schema_for_output::<Self::Output>().unwrap_or_else(|e| { | ||||||||||||||
| panic!( | ||||||||||||||
| "Invalid output schema for ToolBase::Output type `{0}`: {1}", | ||||||||||||||
| std::any::type_name::<Self::Output>(), | ||||||||||||||
| e, | ||||||||||||||
| ); | ||||||||||||||
| })) | ||||||||||||||
| Some(schema_for_output::<Self::Output>()) | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| fn annotations() -> Option<ToolAnnotations> { | ||||||||||||||
|
|
@@ -346,4 +340,43 @@ mod tests { | |||||||||||||
| assert_eq!(result, ErrorData::invalid_params("invalid params", None)); | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| struct ArrayTool; | ||||||||||||||
| impl ToolBase for ArrayTool { | ||||||||||||||
| type Parameter = AddParameter; | ||||||||||||||
| type Output = Vec<AddOutput>; | ||||||||||||||
| type Error = ErrorData; | ||||||||||||||
|
|
||||||||||||||
| fn name() -> Cow<'static, str> { | ||||||||||||||
| "array-tool".into() | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| impl SyncTool<TraitBasedToolServer> for ArrayTool { | ||||||||||||||
| fn invoke( | ||||||||||||||
| _service: &TraitBasedToolServer, | ||||||||||||||
| _param: Self::Parameter, | ||||||||||||||
| ) -> Result<Self::Output, Self::Error> { | ||||||||||||||
| Ok(vec![]) | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| impl AsyncTool<TraitBasedToolServer> for ArrayTool { | ||||||||||||||
| async fn invoke( | ||||||||||||||
| _service: &TraitBasedToolServer, | ||||||||||||||
| _param: Self::Parameter, | ||||||||||||||
| ) -> Result<Self::Output, Self::Error> { | ||||||||||||||
| Ok(vec![]) | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
Comment on lines
+354
to
+369
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What are these for? |
||||||||||||||
|
|
||||||||||||||
| #[test] | ||||||||||||||
| fn test_toolbase_output_schema_with_array_output() { | ||||||||||||||
| let schema = ArrayTool::output_schema(); | ||||||||||||||
| assert!(schema.is_some()); | ||||||||||||||
| let schema = schema.unwrap(); | ||||||||||||||
| let schema_value: serde_json::Value = serde_json::from_str( | ||||||||||||||
| &serde_json::to_string(&*schema).expect("failed to serialize schema"), | ||||||||||||||
| ) | ||||||||||||||
| .expect("failed to parse schema JSON"); | ||||||||||||||
| assert_eq!(schema_value["type"], "array"); | ||||||||||||||
|
Comment on lines
+376
to
+380
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Public API Checkis red in CI because theschema_for_outputreturn-type change is a breaking change:That's expected and fine, and the plan is to batch all 2026-07-28 spec breaking changes into v3.0. So this SEP-2106 implementation belongs in that major.
We need to mark the introducing commit breaking though replacing
feat:withfeat!:so the CI gate computesmajorandPublic API Checkpasses.