[Doc] Fix server_context description for Exception Reporting#370
Open
koic wants to merge 1 commit into
Open
Conversation
## Motivation and Context
The README's Exception Reporting section claimed that `server_context` includes
`{ tool_name: "name", arguments: { ... } }` for tool calls. This matched
the implementation in 0.3.0 through 0.5.0, but the `{ tool_name:, arguments: }`
context was removed in 0.5.1 when exception reporting was consolidated into
the centralized `{ request: request }` path. The README was never updated to reflect this.
`Server#report_exception` is now only called with `{ request: request }`
(from `handle_request`) or `{ notification: "..." }` (from notification delivery rescues),
and tool call failures flow through the `{ request: ... }` path after being wrapped in
a `RequestHandlerError`.
The stale description misled users into expecting `tool_name` and `arguments`
in their exception reporter callbacks.
## How Has This Been Tested?
Documentation-only change. No behavioral modification.
## Breaking Changes
None.
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.
Motivation and Context
The README's Exception Reporting section claimed that
server_contextincludes{ tool_name: "name", arguments: { ... } }for tool calls. This matched the implementation in 0.3.0 through 0.5.0, but the{ tool_name:, arguments: }context was removed in 0.5.1 when exception reporting was consolidated into the centralized{ request: request }path. The README was never updated to reflect this.Server#report_exceptionis now only called with{ request: request }(fromhandle_request) or{ notification: "..." }(from notification delivery rescues), and tool call failures flow through the{ request: ... }path after being wrapped in aRequestHandlerError.The stale description misled users into expecting
tool_nameandargumentsin their exception reporter callbacks.How Has This Been Tested?
Documentation-only change. No behavioral modification.
Breaking Changes
None.
Types of changes
Checklist