modelcontextprotocol/ruby-sdk
Watch
1
0
Fork
You've already forked ruby-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix server_context description for Exception Reporting

Browse source 
## 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 commit is contained in:
Koichi ITO 2026-04-11 13:54:00 +09:00
commit 8c91130451
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -423,10 +423,10 @@ The exception reporter receives two arguments:
- `exception`: The Ruby exception object that was raised - `exception`: The Ruby exception object that was raised
- `server_context`: A hash containing contextual information about where the error occurred - `server_context`: A hash containing contextual information about where the error occurred
The server_context hash includes: The `server_context` hash includes:
- For tool calls: `{ tool_name: "name", arguments: { ... } }` - For request handling failures: `{ request: { ... } }` (the raw JSON-RPC request hash)
- For general request handling: `{ request: { ... } }` - For notification delivery failures: `{ notification: "tools_list_changed" }` (or the relevant notification name)
When an exception occurs: When an exception occurs: