Skip to content

Commit b774809

Browse files
authored
examples: Update and fix outdated (#420)
Update examples/server/rate-limiting to use the same replace directive strategy as the auth-middleware example, and fix the breakages. Also remove the unneeded type parameters in examples/client/middleware.
1 parent 9d34aff commit b774809

File tree

4 files changed

+32
-25
lines changed

4 files changed

+32
-25
lines changed

examples/client/middleware/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ var nextProgressToken atomic.Int64
1717
// from the client.
1818
func main() {
1919
c := mcp.NewClient(&mcp.Implementation{Name: "test"}, nil)
20-
c.AddSendingMiddleware(addProgressToken[*mcp.ClientSession])
20+
c.AddSendingMiddleware(addProgressToken)
2121
}
2222

23-
func addProgressToken[S mcp.Session](h mcp.MethodHandler) mcp.MethodHandler {
23+
func addProgressToken(h mcp.MethodHandler) mcp.MethodHandler {
2424
return func(ctx context.Context, method string, req mcp.Request) (result mcp.Result, err error) {
2525
if rp, ok := req.GetParams().(mcp.RequestParams); ok {
2626
rp.SetProgressToken(nextProgressToken.Add(1))

examples/server/rate-limiting/go.mod

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@ module github.com/modelcontextprotocol/go-sdk/examples/rate-limiting
22

33
go 1.23.0
44

5-
toolchain go1.24.4
6-
75
require (
8-
github.com/modelcontextprotocol/go-sdk v0.1.0
6+
github.com/modelcontextprotocol/go-sdk v0.3.0
97
golang.org/x/time v0.12.0
108
)
9+
10+
require (
11+
github.com/google/jsonschema-go v0.2.1-0.20250825175020-748c325cec76 // indirect
12+
github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
13+
)
14+
15+
replace github.com/modelcontextprotocol/go-sdk => ../../../

examples/server/rate-limiting/go.sum

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
22
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
3-
github.com/modelcontextprotocol/go-sdk v0.1.0 h1:ItzbFWYNt4EHcUrScX7P8JPASn1FVYb29G773Xkl+IU=
4-
github.com/modelcontextprotocol/go-sdk v0.1.0/go.mod h1:DcXfbr7yl7e35oMpzHfKw2nUYRjhIGS2uou/6tdsTB0=
3+
github.com/google/jsonschema-go v0.2.1-0.20250825175020-748c325cec76 h1:mBlBwtDebdDYr+zdop8N62a44g+Nbv7o2KjWyS1deR4=
4+
github.com/google/jsonschema-go v0.2.1-0.20250825175020-748c325cec76/go.mod h1:r5quNTdLOYEz95Ru18zA0ydNbBuYoo9tgaYcxEYhJVE=
5+
github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
6+
github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
57
golang.org/x/time v0.12.0 h1:ScB/8o8olJvc+CQPWrK3fPZNfh7qgwCrY0zJmoEQLSE=
68
golang.org/x/time v0.12.0/go.mod h1:CDIdPxbZBQxdj6cxyCIdrNogrJKMJ7pr37NYpMcMDSg=
79
golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo=

examples/server/rate-limiting/main.go

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,54 +18,54 @@ import (
1818
// GlobalRateLimiterMiddleware creates a middleware that applies a global rate limit.
1919
// Every request attempting to pass through will try to acquire a token.
2020
// If a token cannot be acquired immediately, the request will be rejected.
21-
func GlobalRateLimiterMiddleware[S mcp.Session](limiter *rate.Limiter) mcp.Middleware[S] {
22-
return func(next mcp.MethodHandler[S]) mcp.MethodHandler[S] {
23-
return func(ctx context.Context, session S, method string, params mcp.Params) (mcp.Result, error) {
21+
func GlobalRateLimiterMiddleware(limiter *rate.Limiter) mcp.Middleware {
22+
return func(next mcp.MethodHandler) mcp.MethodHandler {
23+
return func(ctx context.Context, method string, req mcp.Request) (mcp.Result, error) {
2424
if !limiter.Allow() {
2525
return nil, errors.New("JSON RPC overloaded")
2626
}
27-
return next(ctx, session, method, params)
27+
return next(ctx, method, req)
2828
}
2929
}
3030
}
3131

3232
// PerMethodRateLimiterMiddleware creates a middleware that applies rate limiting
3333
// on a per-method basis.
3434
// Methods not specified in limiters will not be rate limited by this middleware.
35-
func PerMethodRateLimiterMiddleware[S mcp.Session](limiters map[string]*rate.Limiter) mcp.Middleware[S] {
36-
return func(next mcp.MethodHandler[S]) mcp.MethodHandler[S] {
37-
return func(ctx context.Context, session S, method string, params mcp.Params) (mcp.Result, error) {
35+
func PerMethodRateLimiterMiddleware(limiters map[string]*rate.Limiter) mcp.Middleware {
36+
return func(next mcp.MethodHandler) mcp.MethodHandler {
37+
return func(ctx context.Context, method string, req mcp.Request) (mcp.Result, error) {
3838
if limiter, ok := limiters[method]; ok {
3939
if !limiter.Allow() {
4040
return nil, errors.New("JSON RPC overloaded")
4141
}
4242
}
43-
return next(ctx, session, method, params)
43+
return next(ctx, method, req)
4444
}
4545
}
4646
}
4747

4848
// PerSessionRateLimiterMiddleware creates a middleware that applies rate limiting
4949
// on a per-session basis for receiving requests.
50-
func PerSessionRateLimiterMiddleware[S mcp.Session](limit rate.Limit, burst int) mcp.Middleware[S] {
50+
func PerSessionRateLimiterMiddleware(limit rate.Limit, burst int) mcp.Middleware {
5151
// A map to store limiters, keyed by the session ID.
5252
var (
5353
sessionLimiters = make(map[string]*rate.Limiter)
5454
mu sync.Mutex
5555
)
5656

57-
return func(next mcp.MethodHandler[S]) mcp.MethodHandler[S] {
58-
return func(ctx context.Context, session S, method string, params mcp.Params) (mcp.Result, error) {
57+
return func(next mcp.MethodHandler) mcp.MethodHandler {
58+
return func(ctx context.Context, method string, req mcp.Request) (mcp.Result, error) {
5959
// It's possible that session.ID() may be empty at this point in time
6060
// for some transports (e.g., stdio) or until the MCP initialize handshake
6161
// has completed.
62-
sessionID := session.ID()
62+
sessionID := req.GetSession().ID()
6363
if sessionID == "" {
6464
// In this situation, you could apply a single global identifier
6565
// if session ID is empty or bypass the rate limiter.
6666
// In this example, we bypass the rate limiter.
6767
log.Printf("Warning: Session ID is empty for method %q. Skipping per-session rate limiting.", method)
68-
return next(ctx, session, method, params) // Skip limiting if ID is unavailable
68+
return next(ctx, method, req) // Skip limiting if ID is unavailable
6969
}
7070
mu.Lock()
7171
limiter, ok := sessionLimiters[sessionID]
@@ -77,19 +77,19 @@ func PerSessionRateLimiterMiddleware[S mcp.Session](limit rate.Limit, burst int)
7777
if !limiter.Allow() {
7878
return nil, errors.New("JSON RPC overloaded")
7979
}
80-
return next(ctx, session, method, params)
80+
return next(ctx, method, req)
8181
}
8282
}
8383
}
8484

8585
func main() {
86-
server := mcp.NewServer("greeter1", "v0.0.1", nil)
87-
server.AddReceivingMiddleware(GlobalRateLimiterMiddleware[*mcp.ServerSession](rate.NewLimiter(rate.Every(time.Second/5), 10)))
88-
server.AddReceivingMiddleware(PerMethodRateLimiterMiddleware[*mcp.ServerSession](map[string]*rate.Limiter{
86+
server := mcp.NewServer(&mcp.Implementation{Name: "greeter1", Version: "v0.0.1"}, nil)
87+
server.AddReceivingMiddleware(GlobalRateLimiterMiddleware(rate.NewLimiter(rate.Every(time.Second/5), 10)))
88+
server.AddReceivingMiddleware(PerMethodRateLimiterMiddleware(map[string]*rate.Limiter{
8989
"callTool": rate.NewLimiter(rate.Every(time.Second), 5), // once a second with a burst up to 5
9090
"listTools": rate.NewLimiter(rate.Every(time.Minute), 20), // once a minute with a burst up to 20
9191
}))
92-
server.AddReceivingMiddleware(PerSessionRateLimiterMiddleware[*mcp.ServerSession](rate.Every(time.Second/5), 10))
92+
server.AddReceivingMiddleware(PerSessionRateLimiterMiddleware(rate.Every(time.Second/5), 10))
9393
// Run Server logic.
9494
log.Println("MCP Server instance created with Middleware (but not running).")
9595
log.Println("This example demonstrates configuration, not live interaction.")

0 commit comments

Comments
 (0)