docs(core): clarify resetTimeoutOnProgress requires onprogress#2082
Open
Jefsky wants to merge 3 commits into
Open
docs(core): clarify resetTimeoutOnProgress requires onprogress#2082Jefsky wants to merge 3 commits into
Jefsky wants to merge 3 commits into
Conversation
added 3 commits
May 13, 2026 23:21
registerPrompt() was destructuring only { title, description, argsSchema, _meta }
from the config, silently dropping icons. The MCP 2025-11-25 spec explicitly
allows icons on PromptDefinition, and the Icon interface already exists.
This change:
- Adds icons?: Icon[] to all three registerPrompt() overloads
- Passes icons through _createRegisteredPrompt()
- Stores icons on RegisteredPrompt
- Includes icons in the prompts/list response
- Adds icons to the update() method
Closes modelcontextprotocol#2054
refreshAuthorization() + saveTokens() were wrapped in a single try/catch. If saveTokens() threw an I/O error (filesystem, file lock, etc.), it was silently discarded by the same catch block that handled AS-side failures. Separating the two: - refreshAuthorization failure → fall through to re-auth (as before) - saveTokens failure → propagates naturally so caller can handle it Also adds a comment clarifying the I/O error case should propagate. Fixes modelcontextprotocol#2034
The resetTimeoutOnProgress option only works when a progress token is included in the request, which requires onprogress to be set. Without onprogress, no token is sent so the server never sends progress notifications and the timeout reset never triggers. Documents the behavior clearly so users don't expect it to work when progress is consumed via lower-level transport features without onprogress being set. Fixes modelcontextprotocol#2076
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@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
1 participant
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
The
resetTimeoutOnProgressoption only works when a progress token is included in the request, which requiresonprogressto be set. Withoutonprogress, no token is sent so the server never sends progress notifications and the timeout reset never triggers.This documents the behavior clearly so users don't expect it to work when progress is consumed via lower-level transport features without
onprogressbeing set.What changed
packages/core/src/shared/protocol.ts— updated JSDoc forresetTimeoutOnProgressto explain:onprogressis explicitly providedresetTimeoutOnProgressonly takes effect whenonprogressis also setonprogresscallback to enable timeout reset on progressThis is a documentation-only fix. The suggested workaround (providing a no-op
onprogress) is the correct approach for users who want to useresetTimeoutOnProgresswith transport-level progress consumption.Closes #2076