mcp: propertly validate against JSON, independent of Go values
Our validation logic was avoiding double-unmarshalling as much as possible, by parsing before validation and validating the Go type. This only works if the Go type has the same structure as its JSON representation, which may not be the case in the presence of types with custom MarshalJSON or UnmarshalJSON methods (such as time.Time). But even if the Go type doesn't use any custom marshalling, validation is broken, because we can't differentiate zero values from missing values. Bite the bullet and use double-unmarshalling for both input and output schemas. Coincidentally, this fixes three bugs: - We were accepting case-insensitive JSON keys, since we parsed first, even though they should have been rejected. A number of tests were wrong. - Defaults were overriding present-yet-zero values, as noted in an incorrect test case. - When "arguments" was missing, validation wasn't performed, no defaults were applied, and unmarshalling failed even if all properties were optional. First unmarshalling to map[string]any allows us to fix all these bugs. Unfortunately, it means a 3x increase in the number of reflection operations (we need to unmarshal, apply defaults and validate, re-marshal with the defaults, and then unmarshal into the Go type). However, this is not likely to be a significant overhead, and we can always optimize in the future. Update github.com/google/jsonschema-go to pick up necessary improvements supporting this change. Additionally, fix the error codes for invalid tool parameters, to be consistent with other SDKs (Invalid Params: -32602). Fixes #447 Fixes #449 Updates #450
This commit is contained in:
parent
eddef064df
commit
9f1b8646bd
12 changed files with 287 additions and 85 deletions
2
go.mod
2
go.mod
|
|
@ -4,7 +4,7 @@ go 1.23.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/google/go-cmp v0.7.0
|
github.com/google/go-cmp v0.7.0
|
||||||
github.com/google/jsonschema-go v0.2.2
|
github.com/google/jsonschema-go v0.2.3-0.20250911201137-bbdc431016d2
|
||||||
github.com/yosida95/uritemplate/v3 v3.0.2
|
github.com/yosida95/uritemplate/v3 v3.0.2
|
||||||
golang.org/x/tools v0.34.0
|
golang.org/x/tools v0.34.0
|
||||||
)
|
)
|
||||||
|
|
|
||||||
4
go.sum
4
go.sum
|
|
@ -1,7 +1,7 @@
|
||||||
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
||||||
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
||||||
github.com/google/jsonschema-go v0.2.2 h1:qb9KM/pATIqIPuE9gEDwPsco8HHCTlA88IGFYHDl03A=
|
github.com/google/jsonschema-go v0.2.3-0.20250911201137-bbdc431016d2 h1:IIj7X4SH1HKy0WfPR4nNEj4dhIJWGdXM5YoBAbfpdoo=
|
||||||
github.com/google/jsonschema-go v0.2.2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=
|
github.com/google/jsonschema-go v0.2.3-0.20250911201137-bbdc431016d2/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=
|
||||||
github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
|
github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
|
||||||
github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
|
github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
|
||||||
golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo=
|
golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo=
|
||||||
|
|
|
||||||
|
|
@ -20,9 +20,11 @@ import (
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"testing/synctest"
|
"testing/synctest"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/google/go-cmp/cmp"
|
"github.com/google/go-cmp/cmp"
|
||||||
"github.com/google/go-cmp/cmp/cmpopts"
|
"github.com/google/go-cmp/cmp/cmpopts"
|
||||||
|
"github.com/google/jsonschema-go/jsonschema"
|
||||||
"github.com/modelcontextprotocol/go-sdk/internal/jsonrpc2"
|
"github.com/modelcontextprotocol/go-sdk/internal/jsonrpc2"
|
||||||
"github.com/modelcontextprotocol/go-sdk/jsonrpc"
|
"github.com/modelcontextprotocol/go-sdk/jsonrpc"
|
||||||
"golang.org/x/tools/txtar"
|
"golang.org/x/tools/txtar"
|
||||||
|
|
@ -97,16 +99,40 @@ func TestServerConformance(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type input struct {
|
type structuredInput struct {
|
||||||
In string `jsonschema:"the input"`
|
In string `jsonschema:"the input"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type output struct {
|
type structuredOutput struct {
|
||||||
Out string `jsonschema:"the output"`
|
Out string `jsonschema:"the output"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func structuredTool(ctx context.Context, req *CallToolRequest, args *input) (*CallToolResult, *output, error) {
|
func structuredTool(ctx context.Context, req *CallToolRequest, args *structuredInput) (*CallToolResult, *structuredOutput, error) {
|
||||||
return nil, &output{"Ack " + args.In}, nil
|
return nil, &structuredOutput{"Ack " + args.In}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type tomorrowInput struct {
|
||||||
|
Now time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
type tomorrowOutput struct {
|
||||||
|
Tomorrow time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func tomorrowTool(ctx context.Context, req *CallToolRequest, args tomorrowInput) (*CallToolResult, tomorrowOutput, error) {
|
||||||
|
return nil, tomorrowOutput{args.Now.Add(24 * time.Hour)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type incInput struct {
|
||||||
|
X int `json:"x,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type incOutput struct {
|
||||||
|
Y int `json:"y"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func incTool(_ context.Context, _ *CallToolRequest, args incInput) (*CallToolResult, incOutput, error) {
|
||||||
|
return nil, incOutput{args.X + 1}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// runServerTest runs the server conformance test.
|
// runServerTest runs the server conformance test.
|
||||||
|
|
@ -124,6 +150,15 @@ func runServerTest(t *testing.T, test *conformanceTest) {
|
||||||
}, sayHi)
|
}, sayHi)
|
||||||
case "structured":
|
case "structured":
|
||||||
AddTool(s, &Tool{Name: "structured"}, structuredTool)
|
AddTool(s, &Tool{Name: "structured"}, structuredTool)
|
||||||
|
case "tomorrow":
|
||||||
|
AddTool(s, &Tool{Name: "tomorrow"}, tomorrowTool)
|
||||||
|
case "inc":
|
||||||
|
inSchema, err := jsonschema.For[incInput](nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
inSchema.Properties["x"].Default = json.RawMessage(`6`)
|
||||||
|
AddTool(s, &Tool{Name: "inc", InputSchema: inSchema}, incTool)
|
||||||
default:
|
default:
|
||||||
t.Fatalf("unknown tool %q", tn)
|
t.Fatalf("unknown tool %q", tn)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -224,7 +224,7 @@ func TestEndToEnd(t *testing.T) {
|
||||||
// ListTools is tested in client_list_test.go.
|
// ListTools is tested in client_list_test.go.
|
||||||
gotHi, err := cs.CallTool(ctx, &CallToolParams{
|
gotHi, err := cs.CallTool(ctx, &CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "user"},
|
Arguments: map[string]any{"Name": "user"},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
|
@ -648,7 +648,7 @@ func TestServerClosing(t *testing.T) {
|
||||||
}()
|
}()
|
||||||
if _, err := cs.CallTool(ctx, &CallToolParams{
|
if _, err := cs.CallTool(ctx, &CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "user"},
|
Arguments: map[string]any{"Name": "user"},
|
||||||
}); err != nil {
|
}); err != nil {
|
||||||
t.Fatalf("after connecting: %v", err)
|
t.Fatalf("after connecting: %v", err)
|
||||||
}
|
}
|
||||||
|
|
@ -1646,7 +1646,7 @@ var testImpl = &Implementation{Name: "test", Version: "v1.0.0"}
|
||||||
// If anyone asks, we can add an option that controls how pointers are treated.
|
// If anyone asks, we can add an option that controls how pointers are treated.
|
||||||
func TestPointerArgEquivalence(t *testing.T) {
|
func TestPointerArgEquivalence(t *testing.T) {
|
||||||
type input struct {
|
type input struct {
|
||||||
In string
|
In string `json:",omitempty"`
|
||||||
}
|
}
|
||||||
type output struct {
|
type output struct {
|
||||||
Out string
|
Out string
|
||||||
|
|
|
||||||
|
|
@ -105,6 +105,13 @@ type CallToolResult struct {
|
||||||
IsError bool `json:"isError,omitempty"`
|
IsError bool `json:"isError,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO(#64): consider exposing setError (and getError), by adding an error
|
||||||
|
// field on CallToolResult.
|
||||||
|
func (r *CallToolResult) setError(err error) {
|
||||||
|
r.Content = []Content{&TextContent{Text: err.Error()}}
|
||||||
|
r.IsError = true
|
||||||
|
}
|
||||||
|
|
||||||
func (*CallToolResult) isResult() {}
|
func (*CallToolResult) isResult() {}
|
||||||
|
|
||||||
// UnmarshalJSON handles the unmarshalling of content into the Content
|
// UnmarshalJSON handles the unmarshalling of content into the Content
|
||||||
|
|
|
||||||
|
|
@ -189,7 +189,6 @@ func (s *Server) AddTool(t *Tool, h ToolHandler) {
|
||||||
func() bool { s.tools.add(st); return true })
|
func() bool { s.tools.add(st); return true })
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO(v0.3.0): test
|
|
||||||
func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHandler, error) {
|
func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHandler, error) {
|
||||||
tt := *t
|
tt := *t
|
||||||
|
|
||||||
|
|
@ -221,11 +220,23 @@ 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) {
|
||||||
|
var input json.RawMessage
|
||||||
|
if req.Params.Arguments != nil {
|
||||||
|
input = req.Params.Arguments
|
||||||
|
}
|
||||||
|
// Validate input and apply defaults.
|
||||||
|
var err error
|
||||||
|
input, err = applySchema(input, inputResolved)
|
||||||
|
if err != nil {
|
||||||
|
// TODO(#450): should this be considered a tool error? (and similar below)
|
||||||
|
return nil, fmt.Errorf("%w: validating \"arguments\": %v", jsonrpc2.ErrInvalidParams, err)
|
||||||
|
}
|
||||||
|
|
||||||
// Unmarshal and validate args.
|
// Unmarshal and validate args.
|
||||||
var in In
|
var in In
|
||||||
if req.Params.Arguments != nil {
|
if input != nil {
|
||||||
if err := unmarshalSchema(req.Params.Arguments, inputResolved, &in); err != nil {
|
if err := json.Unmarshal(input, &in); err != nil {
|
||||||
return nil, err
|
return nil, fmt.Errorf("%w: %v", jsonrpc2.ErrInvalidParams, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -241,22 +252,15 @@ func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHan
|
||||||
return nil, wireErr
|
return nil, wireErr
|
||||||
}
|
}
|
||||||
// For regular errors, embed them in the tool result as per MCP spec
|
// For regular errors, embed them in the tool result as per MCP spec
|
||||||
return &CallToolResult{
|
var errRes CallToolResult
|
||||||
Content: []Content{&TextContent{Text: err.Error()}},
|
errRes.setError(err)
|
||||||
IsError: true,
|
return &errRes, nil
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate output schema, if any.
|
|
||||||
// Skip if out is nil: we've removed "null" from the output schema, so nil won't validate.
|
|
||||||
if v := reflect.ValueOf(out); v.Kind() == reflect.Pointer && v.IsNil() {
|
|
||||||
} else if err := validateSchema(outputResolved, &out); err != nil {
|
|
||||||
return nil, fmt.Errorf("tool output: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if res == nil {
|
if res == nil {
|
||||||
res = &CallToolResult{}
|
res = &CallToolResult{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Marshal the output and put the RawMessage in the StructuredContent field.
|
// Marshal the output and put the RawMessage in the StructuredContent field.
|
||||||
var outval any = out
|
var outval any = out
|
||||||
if elemZero != nil {
|
if elemZero != nil {
|
||||||
|
|
@ -272,7 +276,16 @@ func toolForErr[In, Out any](t *Tool, h ToolHandlerFor[In, Out]) (*Tool, ToolHan
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("marshaling output: %w", err)
|
return nil, fmt.Errorf("marshaling output: %w", err)
|
||||||
}
|
}
|
||||||
res.StructuredContent = json.RawMessage(outbytes) // avoid a second marshal over the wire
|
outJSON := json.RawMessage(outbytes)
|
||||||
|
// Validate the output JSON, and apply defaults.
|
||||||
|
//
|
||||||
|
// We validate against the JSON, rather than the output value, as
|
||||||
|
// some types may have custom JSON marshalling (issue #447).
|
||||||
|
outJSON, err = applySchema(outJSON, outputResolved)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("validating tool output: %w", err)
|
||||||
|
}
|
||||||
|
res.StructuredContent = outJSON // avoid a second marshal over the wire
|
||||||
|
|
||||||
// If the Content field isn't being used, return the serialized JSON in a
|
// If the Content field isn't being used, return the serialized JSON in a
|
||||||
// TextContent block, as the spec suggests:
|
// TextContent block, as the spec suggests:
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,7 @@ import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"log"
|
"log"
|
||||||
"slices"
|
"slices"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
|
@ -491,7 +492,7 @@ func TestAddTool(t *testing.T) {
|
||||||
|
|
||||||
type schema = jsonschema.Schema
|
type schema = jsonschema.Schema
|
||||||
|
|
||||||
func testToolForSchema[In, Out any](t *testing.T, tool *Tool, in string, out Out, wantIn, wantOut *schema, wantErr bool) {
|
func testToolForSchema[In, Out any](t *testing.T, tool *Tool, in string, out Out, wantIn, wantOut *schema, wantErrContaining string) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
th := func(context.Context, *CallToolRequest, In) (*CallToolResult, Out, error) {
|
th := func(context.Context, *CallToolRequest, In) (*CallToolResult, Out, error) {
|
||||||
return nil, out, nil
|
return nil, out, nil
|
||||||
|
|
@ -513,34 +514,48 @@ func testToolForSchema[In, Out any](t *testing.T, tool *Tool, in string, out Out
|
||||||
}
|
}
|
||||||
_, err = goth(context.Background(), ctr)
|
_, err = goth(context.Background(), ctr)
|
||||||
|
|
||||||
if gotErr := err != nil; gotErr != wantErr {
|
if wantErrContaining != "" {
|
||||||
t.Errorf("got error: %t, want error: %t", gotErr, wantErr)
|
if err == nil {
|
||||||
|
t.Errorf("got nil error, want error containing %q", wantErrContaining)
|
||||||
|
} else {
|
||||||
|
if !strings.Contains(err.Error(), wantErrContaining) {
|
||||||
|
t.Errorf("got error %q, want containing %q", err, wantErrContaining)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if err != nil {
|
||||||
|
t.Errorf("got error %v, want no error", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestToolForSchemas(t *testing.T) {
|
func TestToolForSchemas(t *testing.T) {
|
||||||
// Validate that ToolFor handles schemas properly.
|
// Validate that toolForErr handles schemas properly.
|
||||||
|
type in struct {
|
||||||
|
P int `json:"p,omitempty"`
|
||||||
|
}
|
||||||
|
type out struct {
|
||||||
|
B bool `json:"b,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
falseSchema = &schema{Not: &schema{}}
|
||||||
|
inSchema = &schema{Type: "object", AdditionalProperties: falseSchema, Properties: map[string]*schema{"p": {Type: "integer"}}}
|
||||||
|
inSchema2 = &schema{Type: "object", AdditionalProperties: falseSchema, Properties: map[string]*schema{"p": {Type: "string"}}}
|
||||||
|
outSchema = &schema{Type: "object", AdditionalProperties: falseSchema, Properties: map[string]*schema{"b": {Type: "boolean"}}}
|
||||||
|
outSchema2 = &schema{Type: "object", AdditionalProperties: falseSchema, Properties: map[string]*schema{"b": {Type: "integer"}}}
|
||||||
|
)
|
||||||
|
|
||||||
// Infer both schemas.
|
// Infer both schemas.
|
||||||
testToolForSchema[int](t, &Tool{}, "3", true,
|
testToolForSchema[in](t, &Tool{}, `{"p":3}`, out{true}, inSchema, outSchema, "")
|
||||||
&schema{Type: "integer"}, &schema{Type: "boolean"}, false)
|
|
||||||
// Validate the input schema: expect an error if it's wrong.
|
// Validate the input schema: expect an error if it's wrong.
|
||||||
// We can't test that the output schema is validated, because it's typed.
|
// We can't test that the output schema is validated, because it's typed.
|
||||||
testToolForSchema[int](t, &Tool{}, `"x"`, true,
|
testToolForSchema[in](t, &Tool{}, `{"p":"x"}`, out{true}, inSchema, outSchema, `want "integer"`)
|
||||||
&schema{Type: "integer"}, &schema{Type: "boolean"}, true)
|
|
||||||
|
|
||||||
// Ignore type any for output.
|
// Ignore type any for output.
|
||||||
testToolForSchema[int, any](t, &Tool{}, "3", 0,
|
testToolForSchema[in, any](t, &Tool{}, `{"p":3}`, 0, inSchema, nil, "")
|
||||||
&schema{Type: "integer"}, nil, false)
|
|
||||||
// Input is still validated.
|
// Input is still validated.
|
||||||
testToolForSchema[int, any](t, &Tool{}, `"x"`, 0,
|
testToolForSchema[in, any](t, &Tool{}, `{"p":"x"}`, 0, inSchema, nil, `want "integer"`)
|
||||||
&schema{Type: "integer"}, nil, true)
|
|
||||||
|
|
||||||
// Tool sets input schema: that is what's used.
|
// Tool sets input schema: that is what's used.
|
||||||
testToolForSchema[int, any](t, &Tool{InputSchema: &schema{Type: "string"}}, "3", 0,
|
testToolForSchema[in, any](t, &Tool{InputSchema: inSchema2}, `{"p":3}`, 0, inSchema2, nil, `want "string"`)
|
||||||
&schema{Type: "string"}, nil, true) // error: 3 is not a string
|
|
||||||
|
|
||||||
// Tool sets output schema: that is what's used, and validation happens.
|
// Tool sets output schema: that is what's used, and validation happens.
|
||||||
testToolForSchema[string, any](t, &Tool{OutputSchema: &schema{Type: "integer"}}, "3", "x",
|
testToolForSchema[in, any](t, &Tool{OutputSchema: outSchema2}, `{"p":3}`, out{true},
|
||||||
&schema{Type: "string"}, &schema{Type: "integer"}, true) // error: "x" is not an integer
|
inSchema, outSchema2, `want "integer"`)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,8 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
type AddParams struct {
|
type AddParams struct {
|
||||||
X, Y int
|
X int `json:"x"`
|
||||||
|
Y int `json:"y"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func Add(ctx context.Context, req *mcp.CallToolRequest, args AddParams) (*mcp.CallToolResult, any, error) {
|
func Add(ctx context.Context, req *mcp.CallToolRequest, args AddParams) (*mcp.CallToolResult, any, error) {
|
||||||
|
|
|
||||||
|
|
@ -144,7 +144,7 @@ func TestStreamableTransports(t *testing.T) {
|
||||||
// The "greet" tool should just work.
|
// The "greet" tool should just work.
|
||||||
params := &CallToolParams{
|
params := &CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "foo"},
|
Arguments: map[string]any{"Name": "foo"},
|
||||||
}
|
}
|
||||||
got, err := session.CallTool(ctx, params)
|
got, err := session.CallTool(ctx, params)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
@ -239,10 +239,11 @@ func TestStreamableServerShutdown(t *testing.T) {
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
defer clientSession.Close()
|
||||||
|
|
||||||
params := &CallToolParams{
|
params := &CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "foo"},
|
Arguments: map[string]any{"Name": "foo"},
|
||||||
}
|
}
|
||||||
// Verify that we can call a tool.
|
// Verify that we can call a tool.
|
||||||
if _, err := clientSession.CallTool(ctx, params); err != nil {
|
if _, err := clientSession.CallTool(ctx, params); err != nil {
|
||||||
|
|
|
||||||
127
mcp/testdata/conformance/server/tools.txtar
vendored
127
mcp/testdata/conformance/server/tools.txtar
vendored
|
|
@ -5,10 +5,17 @@ Fixed bugs:
|
||||||
- "_meta" should not be nil
|
- "_meta" should not be nil
|
||||||
- empty resource or prompts should not be returned as 'null'
|
- empty resource or prompts should not be returned as 'null'
|
||||||
- the server should not crash when params are passed to tools/call
|
- the server should not crash when params are passed to tools/call
|
||||||
|
- missing required input fields should be rejected (#449)
|
||||||
|
- output and input should be validated against their actual json, not Go
|
||||||
|
representation
|
||||||
|
- When arguments are missing, the request should succeed if all properties are
|
||||||
|
optional, and observe any default values.
|
||||||
|
|
||||||
-- tools --
|
-- tools --
|
||||||
greet
|
greet
|
||||||
structured
|
structured
|
||||||
|
tomorrow
|
||||||
|
inc
|
||||||
|
|
||||||
-- client --
|
-- client --
|
||||||
{
|
{
|
||||||
|
|
@ -26,9 +33,14 @@ structured
|
||||||
{ "jsonrpc": "2.0", "id": 3, "method": "resources/list" }
|
{ "jsonrpc": "2.0", "id": 3, "method": "resources/list" }
|
||||||
{ "jsonrpc": "2.0", "id": 4, "method": "prompts/list" }
|
{ "jsonrpc": "2.0", "id": 4, "method": "prompts/list" }
|
||||||
{ "jsonrpc": "2.0", "id": 5, "method": "tools/call" }
|
{ "jsonrpc": "2.0", "id": 5, "method": "tools/call" }
|
||||||
{ "jsonrpc": "2.0", "id": 6, "method": "tools/call", "params": {"name": "greet", "arguments": {"name": "you"} } }
|
{ "jsonrpc": "2.0", "id": 6, "method": "tools/call", "params": {"name": "greet", "arguments": {"Name": "you"} } }
|
||||||
{ "jsonrpc": "2.0", "id": 1, "result": {} }
|
{ "jsonrpc": "2.0", "id": 1, "result": {} }
|
||||||
{ "jsonrpc": "2.0", "id": 7, "method": "tools/call", "params": {"name": "structured", "arguments": {"In": "input"} } }
|
{ "jsonrpc": "2.0", "id": 7, "method": "tools/call", "params": {"name": "structured", "arguments": {"In": "input"} } }
|
||||||
|
{ "jsonrpc": "2.0", "id": 8, "method": "tools/call", "params": {"name": "structured", "arguments": {} } }
|
||||||
|
{ "jsonrpc": "2.0", "id": 9, "method": "tools/call", "params": {"name": "tomorrow", "arguments": { "Now": "2025-06-18T15:04:05Z" } } }
|
||||||
|
{ "jsonrpc": "2.0", "id": 10, "method": "tools/call", "params": {"name": "greet" } }
|
||||||
|
{ "jsonrpc": "2.0", "id": 11, "method": "tools/call", "params": {"name": "inc", "arguments": { "x": 3 } } }
|
||||||
|
{ "jsonrpc": "2.0", "id": 11, "method": "tools/call", "params": {"name": "inc" } }
|
||||||
|
|
||||||
-- server --
|
-- server --
|
||||||
{
|
{
|
||||||
|
|
@ -69,6 +81,31 @@ structured
|
||||||
},
|
},
|
||||||
"name": "greet"
|
"name": "greet"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"inputSchema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"x": {
|
||||||
|
"type": "integer",
|
||||||
|
"default": 6
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"name": "inc",
|
||||||
|
"outputSchema": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"y"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"y": {
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"inputSchema": {
|
"inputSchema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
|
|
@ -97,6 +134,33 @@ structured
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"inputSchema": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"Now"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"Now": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"name": "tomorrow",
|
||||||
|
"outputSchema": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"Tomorrow"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"Tomorrow": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
@ -155,3 +219,64 @@ structured
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 8,
|
||||||
|
"error": {
|
||||||
|
"code": -32602,
|
||||||
|
"message": "invalid params: validating \"arguments\": validating root: required: missing properties: [\"In\"]"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 9,
|
||||||
|
"result": {
|
||||||
|
"content": [
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"text": "{\"Tomorrow\":\"2025-06-19T15:04:05Z\"}"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"structuredContent": {
|
||||||
|
"Tomorrow": "2025-06-19T15:04:05Z"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 10,
|
||||||
|
"error": {
|
||||||
|
"code": -32602,
|
||||||
|
"message": "invalid params: validating \"arguments\": validating root: required: missing properties: [\"Name\"]"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 11,
|
||||||
|
"result": {
|
||||||
|
"content": [
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"text": "{\"y\":4}"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"structuredContent": {
|
||||||
|
"y": 4
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 11,
|
||||||
|
"result": {
|
||||||
|
"content": [
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"text": "{\"y\":7}"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"structuredContent": {
|
||||||
|
"y": 7
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
64
mcp/tool.go
64
mcp/tool.go
|
|
@ -5,7 +5,6 @@
|
||||||
package mcp
|
package mcp
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
@ -61,41 +60,44 @@ type serverTool struct {
|
||||||
handler ToolHandler
|
handler ToolHandler
|
||||||
}
|
}
|
||||||
|
|
||||||
// unmarshalSchema unmarshals data into v and validates the result according to
|
// applySchema validates whether data is valid JSON according to the provided
|
||||||
// the given resolved schema.
|
// schema, after applying schema defaults.
|
||||||
func unmarshalSchema(data json.RawMessage, resolved *jsonschema.Resolved, v any) error {
|
//
|
||||||
|
// Returns the JSON value augmented with defaults.
|
||||||
|
func applySchema(data json.RawMessage, resolved *jsonschema.Resolved) (json.RawMessage, error) {
|
||||||
// TODO: use reflection to create the struct type to unmarshal into.
|
// TODO: use reflection to create the struct type to unmarshal into.
|
||||||
// Separate validation from assignment.
|
// Separate validation from assignment.
|
||||||
|
|
||||||
// Disallow unknown fields.
|
// Use default JSON marshalling for validation.
|
||||||
// Otherwise, if the tool was built with a struct, the client could send extra
|
//
|
||||||
// fields and json.Unmarshal would ignore them, so the schema would never get
|
// This avoids inconsistent representation due to custom marshallers, such as
|
||||||
// a chance to declare the extra args invalid.
|
// time.Time (issue #449).
|
||||||
dec := json.NewDecoder(bytes.NewReader(data))
|
//
|
||||||
dec.DisallowUnknownFields()
|
// Additionally, unmarshalling into a map ensures that the resulting JSON is
|
||||||
if err := dec.Decode(v); err != nil {
|
// at least {}, even if data is empty. For example, arguments is technically
|
||||||
return fmt.Errorf("unmarshaling: %w", err)
|
// an optional property of callToolParams, and we still want to apply the
|
||||||
}
|
// defaults in this case.
|
||||||
return validateSchema(resolved, v)
|
//
|
||||||
}
|
// TODO(rfindley): in which cases can resolved be nil?
|
||||||
|
|
||||||
func validateSchema(resolved *jsonschema.Resolved, value any) error {
|
|
||||||
if resolved != nil {
|
if resolved != nil {
|
||||||
if err := resolved.ApplyDefaults(value); err != nil {
|
v := make(map[string]any)
|
||||||
return fmt.Errorf("applying defaults from \n\t%s\nto\n\t%v:\n%w", schemaJSON(resolved.Schema()), value, err)
|
if len(data) > 0 {
|
||||||
|
if err := json.Unmarshal(data, &v); err != nil {
|
||||||
|
return nil, fmt.Errorf("unmarshaling arguments: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if err := resolved.Validate(value); err != nil {
|
if err := resolved.ApplyDefaults(&v); err != nil {
|
||||||
return fmt.Errorf("validating\n\t%v\nagainst\n\t %s:\n %w", value, schemaJSON(resolved.Schema()), err)
|
return nil, fmt.Errorf("applying schema defaults:\n%w", err)
|
||||||
|
}
|
||||||
|
if err := resolved.Validate(&v); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
// We must re-marshal with the default values applied.
|
||||||
|
var err error
|
||||||
|
data, err = json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("marshalling with defaults: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return data, nil
|
||||||
}
|
|
||||||
|
|
||||||
// schemaJSON returns the JSON value for s as a string, or a string indicating an error.
|
|
||||||
func schemaJSON(s *jsonschema.Schema) string {
|
|
||||||
m, err := json.Marshal(s)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Sprintf("<!%s>", err)
|
|
||||||
}
|
|
||||||
return string(m)
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@ import (
|
||||||
"github.com/modelcontextprotocol/go-sdk/internal/jsonrpc2"
|
"github.com/modelcontextprotocol/go-sdk/internal/jsonrpc2"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestUnmarshalSchema(t *testing.T) {
|
func TestApplySchema(t *testing.T) {
|
||||||
schema := &jsonschema.Schema{
|
schema := &jsonschema.Schema{
|
||||||
Type: "object",
|
Type: "object",
|
||||||
Properties: map[string]*jsonschema.Schema{
|
Properties: map[string]*jsonschema.Schema{
|
||||||
|
|
@ -39,20 +39,23 @@ func TestUnmarshalSchema(t *testing.T) {
|
||||||
want any
|
want any
|
||||||
}{
|
}{
|
||||||
{`{"x": 1}`, new(S), &S{X: 1}},
|
{`{"x": 1}`, new(S), &S{X: 1}},
|
||||||
{`{}`, new(S), &S{X: 3}}, // default applied
|
{`{}`, new(S), &S{X: 3}}, // default applied
|
||||||
{`{"x": 0}`, new(S), &S{X: 3}}, // FAIL: should be 0. (requires double unmarshal)
|
{`{"x": 0}`, new(S), &S{X: 0}},
|
||||||
{`{"x": 1}`, new(map[string]any), &map[string]any{"x": 1.0}},
|
{`{"x": 1}`, new(map[string]any), &map[string]any{"x": 1.0}},
|
||||||
{`{}`, new(map[string]any), &map[string]any{"x": 3.0}}, // default applied
|
{`{}`, new(map[string]any), &map[string]any{"x": 3.0}}, // default applied
|
||||||
{`{"x": 0}`, new(map[string]any), &map[string]any{"x": 0.0}},
|
{`{"x": 0}`, new(map[string]any), &map[string]any{"x": 0.0}},
|
||||||
} {
|
} {
|
||||||
raw := json.RawMessage(tt.data)
|
raw := json.RawMessage(tt.data)
|
||||||
if err := unmarshalSchema(raw, resolved, tt.v); err != nil {
|
raw, err = applySchema(raw, resolved)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &tt.v); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(tt.v, tt.want) {
|
if !reflect.DeepEqual(tt.v, tt.want) {
|
||||||
t.Errorf("got %#v, want %#v", tt.v, tt.want)
|
t.Errorf("got %#v, want %#v", tt.v, tt.want)
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue