<!-- Provide a brief summary of your changes --> ## Motivation and Context The SEP-2624 spec defines interceptor modes as "active" | "audit". This change aligns the Go SDK's interceptor `Mode` value with the SEP spec. ## How Has This Been Tested? - go test ./... from go/sdk — all packages pass (chain, extension, integrations/gomiddleware). - gofmt -l . — clean. - go vet ./... — clean. ## Breaking Changes Yes: - The exported constant interceptors.ModeEnforce is removed and replaced by interceptors.ModeActive. Callers referencing ModeEnforce must rename. - The serialized mode value changes from "enforce" to "active". Any config expecting "enforce" must be updated. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Signed-off-by: monikaicampbell <mcampbell350@bloomberg.net>
293 lines
9.3 KiB
Go
293 lines
9.3 KiB
Go
package extension_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/modelcontextprotocol/ext-interceptors/go/sdk/interceptors"
|
|
"github.com/modelcontextprotocol/ext-interceptors/go/sdk/interceptors/extension"
|
|
"github.com/modelcontextprotocol/ext-interceptors/go/sdk/interceptors/integrations/gomiddleware"
|
|
)
|
|
|
|
// --- Server setup ---
|
|
|
|
// setup creates an HTTP test server with interceptor support and a connected
|
|
// client session. The server has a single "echo" tool registered for
|
|
// EventToolsCall. Cleanup is registered via t.Cleanup.
|
|
func setup(t *testing.T, is ...interceptors.Interceptor) *mcp.ClientSession {
|
|
t.Helper()
|
|
return setupWithTools(t, defaultTools(), is...)
|
|
}
|
|
|
|
// setupWithTools creates an HTTP test server with the given tools and
|
|
// interceptors. Uses LocalChain to create a chain that invokes
|
|
// interceptors via interceptor/invoke over in-memory transport.
|
|
// Cleanup is registered via t.Cleanup.
|
|
func setupWithTools(t *testing.T, tools []testTool, is ...interceptors.Interceptor) *mcp.ClientSession {
|
|
t.Helper()
|
|
|
|
mcpServer := mcp.NewServer(&mcp.Implementation{
|
|
Name: "test-server",
|
|
Version: "0.1.0",
|
|
}, nil)
|
|
|
|
for _, tool := range tools {
|
|
mcpServer.AddTool(tool.tool, tool.handler)
|
|
}
|
|
|
|
ext := extension.New()
|
|
for _, i := range is {
|
|
ext.AddInterceptor(i)
|
|
}
|
|
require.NoError(t, ext.Install(mcpServer))
|
|
|
|
// Create a chain via LocalChain (in-memory transport).
|
|
chain, err := ext.LocalChain(context.Background(), mcpServer)
|
|
require.NoError(t, err)
|
|
|
|
// Install the middleware for automatic interceptor execution.
|
|
mcpServer.AddReceivingMiddleware(gomiddleware.Middleware(chain))
|
|
|
|
handler := mcp.NewStreamableHTTPHandler(
|
|
func(r *http.Request) *mcp.Server { return mcpServer },
|
|
nil,
|
|
)
|
|
httpServer := httptest.NewServer(handler)
|
|
t.Cleanup(httpServer.Close)
|
|
|
|
client := mcp.NewClient(&mcp.Implementation{Name: "test-client", Version: "0.1.0"}, nil)
|
|
require.NoError(t, extension.RegisterSendingMethods(client))
|
|
cs, err := client.Connect(context.Background(), &mcp.StreamableClientTransport{
|
|
Endpoint: httpServer.URL,
|
|
}, nil)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { cs.Close() })
|
|
|
|
return cs
|
|
}
|
|
|
|
// --- Tool definitions ---
|
|
|
|
// testTool pairs a tool definition with its handler for use with setupWithTools.
|
|
type testTool struct {
|
|
tool *mcp.Tool
|
|
handler mcp.ToolHandler
|
|
}
|
|
|
|
// defaultTools returns the standard "echo" tool used by most tests.
|
|
func defaultTools() []testTool {
|
|
return []testTool{
|
|
{
|
|
tool: &mcp.Tool{
|
|
Name: "echo",
|
|
Description: "echoes input",
|
|
InputSchema: map[string]any{"type": "object"},
|
|
},
|
|
handler: func(_ context.Context, req *mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
|
return &mcp.CallToolResult{
|
|
Content: []mcp.Content{&mcp.TextContent{Text: fmt.Sprintf("echo: %s", req.Params.Arguments)}},
|
|
}, nil
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
// --- Call helpers ---
|
|
|
|
// callEcho calls the "echo" tool and returns the result.
|
|
func callEcho(t *testing.T, cs *mcp.ClientSession) (*mcp.CallToolResult, error) {
|
|
t.Helper()
|
|
return cs.CallTool(context.Background(), &mcp.CallToolParams{
|
|
Name: "echo",
|
|
Arguments: map[string]any{"text": "hello"},
|
|
})
|
|
}
|
|
|
|
// callEchoWithTimeout calls the "echo" tool with a context timeout.
|
|
func callEchoWithTimeout(t *testing.T, cs *mcp.ClientSession, timeout time.Duration) (*mcp.CallToolResult, error) {
|
|
t.Helper()
|
|
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
|
defer cancel()
|
|
return cs.CallTool(ctx, &mcp.CallToolParams{
|
|
Name: "echo",
|
|
Arguments: map[string]any{"text": "hello"},
|
|
})
|
|
}
|
|
|
|
// --- Assertion helpers ---
|
|
|
|
// resultText extracts the first TextContent string from a CallToolResult.
|
|
// Fails the test if the result has no content or the first item isn't TextContent.
|
|
func resultText(t *testing.T, result *mcp.CallToolResult) string {
|
|
t.Helper()
|
|
require.NotEmpty(t, result.Content)
|
|
tc, ok := result.Content[0].(*mcp.TextContent)
|
|
require.True(t, ok, "expected TextContent, got %T", result.Content[0])
|
|
return tc.Text
|
|
}
|
|
|
|
// --- Low-level server primitives ---
|
|
|
|
// buildServer creates an interceptor server with the echo tool and the given
|
|
// interceptors. It does not start serving or connect a client, so callers can
|
|
// install middleware before calling connectHTTPClient.
|
|
func buildServer(t *testing.T, is ...interceptors.Interceptor) *mcp.Server {
|
|
t.Helper()
|
|
mcpServer := mcp.NewServer(&mcp.Implementation{Name: "test-server", Version: "0.1.0"}, nil)
|
|
for _, tt := range defaultTools() {
|
|
mcpServer.AddTool(tt.tool, tt.handler)
|
|
}
|
|
ext := extension.New()
|
|
for _, i := range is {
|
|
ext.AddInterceptor(i)
|
|
}
|
|
require.NoError(t, ext.Install(mcpServer))
|
|
|
|
return mcpServer
|
|
}
|
|
|
|
// connectHTTPClient starts an HTTP test server backed by srv and returns a
|
|
// connected client session. Cleanup is registered via t.Cleanup.
|
|
func connectHTTPClient(t *testing.T, srv *mcp.Server) *mcp.ClientSession {
|
|
t.Helper()
|
|
handler := mcp.NewStreamableHTTPHandler(
|
|
func(r *http.Request) *mcp.Server { return srv },
|
|
nil,
|
|
)
|
|
httpServer := httptest.NewServer(handler)
|
|
t.Cleanup(httpServer.Close)
|
|
client := mcp.NewClient(&mcp.Implementation{Name: "test-client", Version: "0.1.0"}, nil)
|
|
require.NoError(t, extension.RegisterSendingMethods(client))
|
|
cs, err := client.Connect(context.Background(), &mcp.StreamableClientTransport{
|
|
Endpoint: httpServer.URL,
|
|
}, nil)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { cs.Close() })
|
|
return cs
|
|
}
|
|
|
|
// setupRPCServer creates an interceptor server with the given interceptors
|
|
// and returns a connected client session for raw JSON-RPC method calls.
|
|
func setupRPCServer(t *testing.T, is ...interceptors.Interceptor) *mcp.ClientSession {
|
|
t.Helper()
|
|
srv := buildServer(t, is...)
|
|
return connectHTTPClient(t, srv)
|
|
}
|
|
|
|
// --- Interceptor builders ---
|
|
// All handlers work with json.RawMessage payloads since that's what
|
|
// interceptor/invoke delivers.
|
|
|
|
// prefixMutator creates a mutator that prepends tag to each TextContent
|
|
// in a CallToolResult (response phase).
|
|
func prefixMutator(name, tag string, phase interceptors.InterceptionPhase, priority int, mode interceptors.Mode) *interceptors.Mutator {
|
|
return &interceptors.Mutator{
|
|
Metadata: interceptors.Metadata{
|
|
Name: name,
|
|
Hooks: []interceptors.Hook{{
|
|
Events: []string{interceptors.EventToolsCall},
|
|
Phase: phase,
|
|
}},
|
|
Mode: mode,
|
|
PriorityHint: interceptors.NewPriority(priority),
|
|
},
|
|
Handler: func(_ context.Context, inv *interceptors.Invocation) (*interceptors.MutationResult, error) {
|
|
raw, ok := inv.Payload.(json.RawMessage)
|
|
if !ok {
|
|
return nil, fmt.Errorf("unexpected payload type %T", inv.Payload)
|
|
}
|
|
var result mcp.CallToolResult
|
|
if err := json.Unmarshal(raw, &result); err != nil {
|
|
return nil, err
|
|
}
|
|
for _, c := range result.Content {
|
|
if tc, ok := c.(*mcp.TextContent); ok {
|
|
tc.Text = tag + " " + tc.Text
|
|
}
|
|
}
|
|
data, err := json.Marshal(&result)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &interceptors.MutationResult{Modified: true, Payload: json.RawMessage(data)}, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
// failMutator creates a mutator that always returns an error.
|
|
func failMutator(name string, phase interceptors.InterceptionPhase, priority int) *interceptors.Mutator {
|
|
return &interceptors.Mutator{
|
|
Metadata: interceptors.Metadata{
|
|
Name: name,
|
|
Hooks: []interceptors.Hook{{
|
|
Events: []string{interceptors.EventToolsCall},
|
|
Phase: phase,
|
|
}},
|
|
Mode: interceptors.ModeActive,
|
|
PriorityHint: interceptors.NewPriority(priority),
|
|
},
|
|
Handler: func(_ context.Context, _ *interceptors.Invocation) (*interceptors.MutationResult, error) {
|
|
return nil, fmt.Errorf("simulated failure")
|
|
},
|
|
}
|
|
}
|
|
|
|
// blockToolValidator creates a request validator that rejects calls to the named tool.
|
|
func blockToolValidator(toolName string) *interceptors.Validator {
|
|
return &interceptors.Validator{
|
|
Metadata: interceptors.Metadata{
|
|
Name: "block-" + toolName,
|
|
Hooks: []interceptors.Hook{{
|
|
Events: []string{interceptors.EventToolsCall},
|
|
Phase: interceptors.PhaseRequest,
|
|
}},
|
|
Mode: interceptors.ModeActive,
|
|
},
|
|
Handler: func(_ context.Context, inv *interceptors.Invocation) (*interceptors.ValidationResult, error) {
|
|
raw, ok := inv.Payload.(json.RawMessage)
|
|
if !ok {
|
|
return nil, fmt.Errorf("unexpected payload type %T", inv.Payload)
|
|
}
|
|
var params struct {
|
|
Name string `json:"name"`
|
|
}
|
|
if err := json.Unmarshal(raw, ¶ms); err != nil {
|
|
return nil, err
|
|
}
|
|
if params.Name == toolName {
|
|
return &interceptors.ValidationResult{
|
|
Valid: false,
|
|
Messages: []interceptors.ValidationMessage{
|
|
{Message: toolName + " is blocked", Severity: interceptors.SeverityError},
|
|
},
|
|
}, nil
|
|
}
|
|
return &interceptors.ValidationResult{Valid: true}, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
// allowAllValidator creates a request validator that allows all calls.
|
|
func allowAllValidator(name string) *interceptors.Validator {
|
|
return &interceptors.Validator{
|
|
Metadata: interceptors.Metadata{
|
|
Name: name,
|
|
Hooks: []interceptors.Hook{{
|
|
Events: []string{interceptors.EventToolsCall},
|
|
Phase: interceptors.PhaseRequest,
|
|
}},
|
|
Mode: interceptors.ModeActive,
|
|
},
|
|
Handler: func(_ context.Context, _ *interceptors.Invocation) (*interceptors.ValidationResult, error) {
|
|
return &interceptors.ValidationResult{Valid: true}, nil
|
|
},
|
|
}
|
|
}
|