Skip to content

[tools] add support for structured responses #81

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

honzasterba
Copy link
Contributor

@honzasterba honzasterba commented Jul 17, 2025

Add new response class to be able to return structuredContent as part of tools response in a backwards compatible way

Motivation and Context

Structured responses are an established part of the spec and the SDK should support it.

How Has This Been Tested?

Add new tested and tested with internal MCP server implementation.

Breaking Changes

None

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

@dieter-medium
Copy link

Nice job!

Does this not also require an 'outputSchema'?

@honzasterba
Copy link
Contributor Author

output schema is optional for structured output, for now I just added support for the response field

@@ -17,7 +17,7 @@

require_relative "instrumentation_test_helper"

Minitest::Reporters.use!(Minitest::Reporters::ProgressReporter.new)
Minitest::Reporters.use!(Minitest::Reporters::ProgressReporter.new) unless ENV["RM_INFO"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain where/when RM_INFO comes from? (Explicitly calling out this change in the PR description or punting it to its specific PR would be favourable.)

attr_reader :content, :is_error

# @param structured_content [Hash] The structured content of the response, must be provided.
# @param content [String, nil] The content array of the response, can be nil. If nil will generate a single element with structured content converted to JSON string.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For backwards compatibility, a tool that returns structured content SHOULD also return the serialized JSON in a TextContent block.

Not a MUST, but a SHOULD, but I agree with doing it for backwards compatibility in this gem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants