docs: validate input-required elicitation examples - #2756
Open
sravan-v wants to merge 1 commit into
Open
Conversation
|
@modelcontextprotocol/client
@modelcontextprotocol/codemod
@modelcontextprotocol/core
@modelcontextprotocol/server
@modelcontextprotocol/server-legacy
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
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.
Updates the input-required examples to validate client-provided elicitation content at runtime and fail closed when confirmation or scope responses are invalid.
Fixes #2542.
Motivation and Context
ctx.mcpReq.inputResponsescontains client-provided, untrusted data. Several examples used the genericacceptedContent<T>()overload, which provides compile-time typing but no runtime validation.Some confirmation examples also checked only whether the response object existed instead of requiring
confirm === true. Thewipe-cacheexample defaulted a missing or malformed scope toall, which is unsafe for a destructive operation.This change:
acceptedContent()for runtime validationtrueallscopeHow Has This Been Tested?
The following checks passed locally:
pnpm build:all— all 52 workspace packages built successfullypnpm sync:snippets --checkinput-requiredguide exampleThe tested scenarios include:
trueA broad e2e invocation also executed unrelated stdio lifecycle scenarios. Six environment-sensitive stdio cases failed while 2,633 tests passed; the isolated MRTR scenario affected by this change passes.
Breaking Changes
No breaking changes.
This updates defensive example usage, generated documentation, and corresponding test fixtures. It does not change the
acceptedContent()API.Types of changes
Checklist
Additional context
The same Zod schema instance is used both to describe the requested elicitation input and to validate the accepted response.
For the sequential
wipe-cacheexample, an invalid scope response reissues only the scope request and mints{ step: 'confirmed' }again. This avoids asking for confirmation again while ensuring an invalid scope can never silently becomeall.