Skip to content

Allow enum in registerPrompt argsSchema #710

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

Closed
wants to merge 2 commits into from

Conversation

ataylorme
Copy link

Motivation and Context

Being able to take user input that is enumerated values is useful when creating prompt callback functions and allows deeper prompt argument validation. Zod enum enforce a fixed set of strings at the SDK layer while still sending strings to the spec.

How Has This Been Tested?

Unit test coverage added

Breaking Changes

No breaking changes, backwards compatibility is maintained

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

Additional context

Follow up to #691 with enum only. Spec changes will be needed to support other Zod schema types, such as boolean, as the spec currently only supports strings.

sunrabbit123 pushed a commit to sunrabbit123/typescript-sdk that referenced this pull request Jun 30, 2025
Added optional _meta field to ResourceContentsSchema, PromptSchema, and EmbeddedResourceSchema to align with spec change PR modelcontextprotocol#710. These were the only schemas missing the _meta field that were required by the specification update.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@ihrpr
Copy link
Contributor

ihrpr commented Jul 7, 2025

Thank you for splitting #691. Sorry, I need to close this one for now as it breaks spec compliance.

The issue: PR #729 will introduce compile-time type checking between SDK and spec types. This changes would cause these checks to fail:

Type '{ [x: string]: string | { type: "enum"; enum: string[]; }; }' is not assignable to type '{ [key: string]: string; }'

The spec defines GetPromptRequest.params.arguments as Record<string, string>. This PR changes it to accept a union type that includes enum objects, which diverges from the spec.

Our policy is to maintain strict type compatibility with the MCP specification. Any changes to the type system need to:

  1. Land in the spec first: https://github.com/modelcontextprotocol/modelcontextprotocol
  2. Then get implemented in the SDK

If Enum changes in the spec are approved, we can implement it here as well.

@ihrpr ihrpr closed this Jul 7, 2025
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.

2 participants