experimental-ext-interceptors/go/sdk/interceptors/integrations/gomiddleware/middleware.go
Kurt Degiorgio c9900f02ab
Implement Go interceptor chain (#4)
## Summary

Implements the Go SDK for MCP interceptors — validation and mutation
middleware for any MCP server.

The framework treats interceptors as first-class MCP primitives: they
are registered on an MCP server, discoverable via `interceptors/list`,
and invocable via `interceptor/invoke` — the same JSON-RPC pattern as
tools, prompts, and resources. A chain engine orchestrates execution
across one or more interceptor servers, and an optional go-sdk
middleware integration applies interceptors automatically on every
matching request/response.

## Architecture

**Three-layer design:**

1. **`interceptors`** — Protocol-agnostic core. Defines interceptor
types (validators, mutators), metadata, invocation, wire types, and
results. Zero MCP dependencies.

2. **`interceptors/mcpserver`** — MCP server integration. Wraps
`mcp.Server` to register `interceptors/list` and `interceptor/invoke` as
custom JSON-RPC methods and advertise interceptor capabilities during
`initialize`.

3. **`interceptors/chain`** — Chain engine. Orchestrates execution
across N interceptor servers with trust-boundary-aware ordering,
priority-based mutation sequencing, parallel validation, audit-mode
isolation, and fail-open/fail-closed semantics.

4. **`interceptors/integrations/gomiddleware`** — Optional go-sdk
middleware. Installs on `mcp.Server` via `AddReceivingMiddleware()` to
automatically run the interceptor chain on every matching
request/response.

**Key design decisions:**

- **Trust-boundary ordering** — request phase: validate → mutate;
response phase: mutate → validate. Validation always guards the boundary
crossing.
- **Wire-level invocation** — the chain calls `interceptor/invoke` over
the MCP transport (even in-process via `LocalChain()`), so local and
remote interceptor servers use the same interface.
- **Audit-mode isolation** — audit-mode mutators compute transformations
without applying them. Only audit mutators pay the serialization cost.
- **Concurrency** — validators run in parallel; mutators run
sequentially in priority order.

### Package Structure

| Package | File | Responsibility |
|---------|------|----------------|
| `interceptors` | `interceptor.go` | Enums, Metadata, Interceptor
interface, Validator/Mutator structs, handler types, Invocation |
| `interceptors` | `wire.go` | Wire types: ListParams/Result,
InvokeParams/Result, InterceptorInfo, event/method constants |
| `interceptors` | `priority.go` | Priority with phase-aware resolution
and JSON marshaling |
| `interceptors` | `doc.go` | Package documentation with examples |
| `interceptors/chain` | `chain.go` | Chain engine: discovery,
filtering, sorting, execution orchestration |
| `interceptors/chain` | `result.go` | ExecutionResult, AbortInfo |
| `interceptors/chain` | `doc.go` | Sub-package documentation |
| `interceptors/mcpserver` | `server.go` | MCP server wrapper,
interceptor registry, capability advertisement, `LocalChain()` |
| `interceptors/mcpserver` | `rpc.go` | `interceptors/list` and
`interceptor/invoke` JSON-RPC handlers |
| `interceptors/mcpserver` | `doc.go` | Sub-package documentation |
| `integrations/gomiddleware` | `middleware.go` | go-sdk `Middleware`
that runs the chain on every request/response |
| `integrations/gomiddleware` | `errors.go` | Abort-to-JSONRPC error
conversion |
| `integrations/gomiddleware` | `doc.go` | Sub-package documentation |

### Documentation

- `doc/DESIGN.md` — architecture, execution model, integration with
go-sdk
- `doc/CONFORMANCE.md` — SEP conformance status
- `doc/PERFORMANCE.md` — per-request cost model

### Examples

- `examples/validator` — blocks dangerous tool calls, demonstrates
`WithContextProvider`
- `examples/mutator` — tags tool responses with audit trail

## Vendor: go-sdk v1.4.0 with custom method support

Vendors `go-sdk` with minimal extensions for custom JSON-RPC methods:

- `Server.AddCustomMethod` — registers a handler that bypasses the typed
pipeline
- `ClientSession.CallCustom` — sends raw JSON-RPC calls for custom
methods

These changes are generic (not interceptor-specific) and enable any MCP
extension to define its own JSON-RPC methods.

## TODO

- More integration tests
- Unit tests
- Support wildcards for event interception (separate PR)

---------

Signed-off-by: Kurt Degiorgio <kdegiorgio@bloomberg.net>
2026-04-29 15:29:25 +01:00

176 lines
5.2 KiB
Go

// Copyright 2025 The MCP Interceptors Authors. All rights reserved.
// Use of this source code is governed by an Apache-2.0
// license that can be found in the LICENSE file.
package gomiddleware
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"github.com/modelcontextprotocol/go-sdk/mcp"
"github.com/modelcontextprotocol/ext-interceptors/go/sdk/interceptors"
"github.com/modelcontextprotocol/ext-interceptors/go/sdk/interceptors/chain"
)
// Option configures the middleware.
type Option func(*config)
type config struct {
logger *slog.Logger
contextProvider ContextProviderFunc
}
// ContextProviderFunc extracts an InvocationContext from an incoming MCP
// request. This is called once per intercepted request and the result is
// passed to all interceptor handlers via the chain execution params.
//
// Typical use: extract principal identity from OAuth tokens available on
// the request's session (via RequestExtra.TokenInfo).
type ContextProviderFunc func(ctx context.Context, req mcp.Request) *interceptors.InvocationContext
// WithLogger sets the logger for the middleware.
// If not set, slog.Default() is used.
func WithLogger(l *slog.Logger) Option {
return func(c *config) {
c.logger = l
}
}
// WithContextProvider sets a function that populates InvocationContext
// for every intercepted request. Without this, the context is nil.
func WithContextProvider(f ContextProviderFunc) Option {
return func(c *config) {
c.contextProvider = f
}
}
// skipMethods are methods that should not be intercepted to prevent
// recursion when the chain connects back to the same server, plus
// lifecycle methods that don't need interception.
var skipMethods = map[string]bool{
"initialize": true,
"notifications/initialized": true,
"notifications/cancelled": true,
interceptors.MethodList: true,
interceptors.MethodInvoke: true,
}
// Middleware creates an [mcp.Middleware] that intercepts incoming requests
// and outgoing responses, running the interceptor chain for each.
//
// The middleware calls chain.Execute() which invokes interceptors via
// interceptor/invoke RPCs. Install it on an [mcp.Server] via
// [mcp.Server.AddReceivingMiddleware]:
//
// chain, _ := srv.LocalChain(ctx)
// mcpServer.AddReceivingMiddleware(
// gomiddleware.Middleware(chain, gomiddleware.WithLogger(logger)),
// )
func Middleware(ch *chain.Chain, opts ...Option) mcp.Middleware {
cfg := &config{}
for _, opt := range opts {
opt(cfg)
}
if cfg.logger == nil {
cfg.logger = slog.Default()
}
return func(next mcp.MethodHandler) mcp.MethodHandler {
return func(ctx context.Context, method string, req mcp.Request) (mcp.Result, error) {
// Skip interceptor and lifecycle methods to prevent recursion.
if skipMethods[method] {
return next(ctx, method, req)
}
event := method
// Extract invocation context from the request using the context provider, if set.
var invCtx *interceptors.InvocationContext
if cfg.contextProvider != nil {
invCtx = cfg.contextProvider(ctx, req)
}
// --- Request phase ---
reqPayload, err := json.Marshal(req.GetParams())
if err != nil {
return nil, err
}
reqResult, err := ch.Execute(ctx, &chain.ExecutionParams{
Event: event,
Phase: interceptors.PhaseRequest,
Payload: reqPayload,
Context: invCtx,
})
if err != nil {
return nil, err
}
if len(reqResult.AbortedAt) > 0 {
logAborts(cfg.logger, "request", event, reqResult.AbortedAt)
return nil, abortToJSONRPCError(reqResult.AbortedAt)
}
// Apply mutated payload back to the request params if modified.
if reqResult.FinalPayload != nil {
if err := json.Unmarshal(reqResult.FinalPayload, req.GetParams()); err != nil {
return nil, fmt.Errorf("interceptors: failed to apply mutated request payload: %w", err)
}
}
// Call the next handler.
result, err := next(ctx, method, req)
if err != nil {
return result, err
}
// Notification methods return nil result — skip response phase.
if result == nil {
return nil, nil
}
// --- Response phase ---
respPayload, err := json.Marshal(result)
if err != nil {
return nil, fmt.Errorf("interceptors: failed to marshal response payload for interception: %w", err)
}
respResult, err := ch.Execute(ctx, &chain.ExecutionParams{
Event: event,
Phase: interceptors.PhaseResponse,
Payload: respPayload,
Context: invCtx,
})
if err != nil {
return nil, err
}
if len(respResult.AbortedAt) > 0 {
logAborts(cfg.logger, "response", event, respResult.AbortedAt)
return nil, abortToJSONRPCError(respResult.AbortedAt)
}
// Apply mutated response payload if it was modified.
if respResult.FinalPayload != nil {
if err := json.Unmarshal(respResult.FinalPayload, result); err != nil {
return nil, fmt.Errorf("interceptors: failed to apply mutated response payload: %w", err)
}
}
return result, nil
}
}
}
// logAborts logs each abort entry at warn level.
func logAborts(logger *slog.Logger, phase, event string, aborts []chain.AbortInfo) {
for _, a := range aborts {
logger.Warn("interceptors: "+phase+" aborted",
"event", event,
"interceptor", a.Interceptor,
"reason", a.Reason,
)
}
}