mcp: statically type the server-side tool params (#378)

Introduce CallToolParamsRaw on the server side, so that tool handlers
see in the type system that a tool's arguments are a json.RawMessage.

Fixes #377.
This commit is contained in:
Jonathan Amsterdam 2025-08-30 08:16:06 -04:00 • committed by GitHub
commit 7bfde44981
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 17 additions and 22 deletions

View file

@ -494,7 +494,6 @@ func TestEndToEnd(t *testing.T) {
if result.Action != "accept" { if result.Action != "accept" {
t.Errorf("got action %q, want %q", result.Action, "accept") t.Errorf("got action %q, want %q", result.Action, "accept")
} }
}) })
// Disconnect. // Disconnect.
@ -1638,7 +1637,7 @@ func TestPointerArgEquivalence(t *testing.T) {
// //
// We handle a few different types of results, to assert they behave the // We handle a few different types of results, to assert they behave the
// same in all cases. // same in all cases.
AddTool(s, &Tool{Name: "pointer"}, func(_ context.Context, req *ServerRequest[*CallToolParams], in *input) (*CallToolResult, *output, error) { AddTool(s, &Tool{Name: "pointer"}, func(_ context.Context, req *CallToolRequest, in *input) (*CallToolResult, *output, error) {
switch in.In { switch in.In {
case "": case "":
return nil, nil, fmt.Errorf("must provide input") return nil, nil, fmt.Errorf("must provide input")
@ -1652,7 +1651,7 @@ func TestPointerArgEquivalence(t *testing.T) {
panic("unreachable") panic("unreachable")
} }
}) })
AddTool(s, &Tool{Name: "nonpointer"}, func(_ context.Context, req *ServerRequest[*CallToolParams], in input) (*CallToolResult, output, error) { AddTool(s, &Tool{Name: "nonpointer"}, func(_ context.Context, req *CallToolRequest, in input) (*CallToolResult, output, error) {
switch in.In { switch in.In {
case "": case "":
return nil, output{}, fmt.Errorf("must provide input") return nil, output{}, fmt.Errorf("must provide input")

View file

@ -40,6 +40,7 @@ type Annotations struct {
Priority float64 `json:"priority,omitempty"` Priority float64 `json:"priority,omitempty"`
} }
// CallToolParams is used by clients to call a tool.
type CallToolParams struct { type CallToolParams struct {
// This property is reserved by the protocol to allow clients and servers to // This property is reserved by the protocol to allow clients and servers to
// attach additional metadata to their responses. // attach additional metadata to their responses.
@ -48,20 +49,13 @@ type CallToolParams struct {
Arguments any `json:"arguments,omitempty"` Arguments any `json:"arguments,omitempty"`
} }
// When unmarshalling CallToolParams on the server side, we need to delay unmarshaling of the arguments. // CallToolParamsRaw is passed to tool handlers on the server.
func (c *CallToolParams) UnmarshalJSON(data []byte) error { type CallToolParamsRaw struct {
var raw struct { // This property is reserved by the protocol to allow clients and servers to
Meta `json:"_meta,omitempty"` // attach additional metadata to their responses.
Name string `json:"name"` Meta `json:"_meta,omitempty"`
RawArguments json.RawMessage `json:"arguments,omitempty"` Name string `json:"name"`
} Arguments json.RawMessage `json:"arguments,omitempty"`
if err := json.Unmarshal(data, &raw); err != nil {
return err
}
c.Meta = raw.Meta
c.Name = raw.Name
c.Arguments = raw.RawArguments
return nil
} }
// The server's response to a tool call. // The server's response to a tool call.
@ -115,6 +109,10 @@ func (x *CallToolParams) isParams() {}
func (x *CallToolParams) GetProgressToken() any { return getProgressToken(x) } func (x *CallToolParams) GetProgressToken() any { return getProgressToken(x) }
func (x *CallToolParams) SetProgressToken(t any) { setProgressToken(x, t) } func (x *CallToolParams) SetProgressToken(t any) { setProgressToken(x, t) }
func (x *CallToolParamsRaw) isParams() {}
func (x *CallToolParamsRaw) GetProgressToken() any { return getProgressToken(x) }
func (x *CallToolParamsRaw) SetProgressToken(t any) { setProgressToken(x, t) }
type CancelledParams struct { type CancelledParams struct {
// This property is reserved by the protocol to allow clients and servers to // This property is reserved by the protocol to allow clients and servers to
// attach additional metadata to their responses. // attach additional metadata to their responses.

View file

@ -7,7 +7,7 @@
package mcp package mcp
type ( type (
CallToolRequest = ServerRequest[*CallToolParams] CallToolRequest = ServerRequest[*CallToolParamsRaw]
CompleteRequest = ServerRequest[*CompleteParams] CompleteRequest = ServerRequest[*CompleteParams]
GetPromptRequest = ServerRequest[*GetPromptParams] GetPromptRequest = ServerRequest[*GetPromptParams]
InitializedRequest = ServerRequest[*InitializedParams] InitializedRequest = ServerRequest[*InitializedParams]

View file

@ -9,7 +9,6 @@ import (
"context" "context"
"encoding/base64" "encoding/base64"
"encoding/gob" "encoding/gob"
"encoding/json"
"fmt" "fmt"
"iter" "iter"
"maps" "maps"
@ -234,10 +233,9 @@ func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHan
th := func(ctx context.Context, req *CallToolRequest) (*CallToolResult, error) { th := func(ctx context.Context, req *CallToolRequest) (*CallToolResult, error) {
// Unmarshal and validate args. // Unmarshal and validate args.
rawArgs := req.Params.Arguments.(json.RawMessage)
var in In var in In
if rawArgs != nil { if req.Params.Arguments != nil {
if err := unmarshalSchema(rawArgs, inputResolved, &in); err != nil { if err := unmarshalSchema(req.Params.Arguments, inputResolved, &in); err != nil {
return nil, err return nil, err
} }
} }