parent
84a568bf89
commit
4e9a387d04
4 changed files with 175 additions and 2 deletions
|
|
@ -450,7 +450,90 @@ _ = mcp.NewServer(&mcp.Implementation{Name: "server"}, &mcp.ServerOptions{
|
||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
|
||||||
<!-- TODO -->
|
MCP servers can send logging messages to MCP clients.
|
||||||
|
(This form of logging is distinct from server-side logging, where the
|
||||||
|
server produces logs that remain server-side, for use by server maintainers.)
|
||||||
|
|
||||||
|
**Server-side**:
|
||||||
|
The minimum log level is part of the server state.
|
||||||
|
For stateful sessions, there is no default log level: no log messages will be sent
|
||||||
|
until the client calls `SetLevel` (see below).
|
||||||
|
For stateful sessions, the level defaults to "info".
|
||||||
|
|
||||||
|
[`ServerSession.Log`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ServerSession.Log) is the low-level way for servers to log to clients.
|
||||||
|
It sends a logging notification to the client if the level of the message
|
||||||
|
is at least the minimum log level.
|
||||||
|
|
||||||
|
For a simpler API, use [`NewLoggingHandler`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#NewLoggingHandler) to obtain a [`slog.Handler`](https://pkg.go.dev/log/slog#Handler).
|
||||||
|
By setting [`LoggingHandlerOptions.MinInterval`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#LoggingHandlerOptions.MinInterval), the handler can be rate-limited
|
||||||
|
to avoid spamming clients with too many messages.
|
||||||
|
|
||||||
|
Servers always report the logging capability.
|
||||||
|
|
||||||
|
|
||||||
|
**Client-side**:
|
||||||
|
Set [`ClientOptions.LoggingMessageHandler`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ClientOptions.LoggingMessageHandler) to receive log messages.
|
||||||
|
|
||||||
|
Call [`ClientSession.SetLevel`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ClientSession.SetLevel) to change the log level for a session.
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Example_logging() {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
// Create a server.
|
||||||
|
s := mcp.NewServer(&mcp.Implementation{Name: "server", Version: "v0.0.1"}, nil)
|
||||||
|
|
||||||
|
// Create a client that displays log messages.
|
||||||
|
done := make(chan struct{}) // solely for the example
|
||||||
|
var nmsgs atomic.Int32
|
||||||
|
c := mcp.NewClient(
|
||||||
|
&mcp.Implementation{Name: "client", Version: "v0.0.1"},
|
||||||
|
&mcp.ClientOptions{
|
||||||
|
LoggingMessageHandler: func(_ context.Context, r *mcp.LoggingMessageRequest) {
|
||||||
|
m := r.Params.Data.(map[string]any)
|
||||||
|
fmt.Println(m["msg"], m["value"])
|
||||||
|
if nmsgs.Add(1) == 2 { // number depends on logger calls below
|
||||||
|
close(done)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
// Connect the server and client.
|
||||||
|
t1, t2 := mcp.NewInMemoryTransports()
|
||||||
|
ss, err := s.Connect(ctx, t1, nil)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
defer ss.Close()
|
||||||
|
cs, err := c.Connect(ctx, t2, nil)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
defer cs.Close()
|
||||||
|
|
||||||
|
// Set the minimum log level to "info".
|
||||||
|
if err := cs.SetLoggingLevel(ctx, &mcp.SetLoggingLevelParams{Level: "info"}); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a slog.Logger for the server session.
|
||||||
|
logger := slog.New(mcp.NewLoggingHandler(ss, nil))
|
||||||
|
|
||||||
|
// Log some things.
|
||||||
|
logger.Info("info shows up", "value", 1)
|
||||||
|
logger.Debug("debug doesn't show up", "value", 2)
|
||||||
|
logger.Warn("warn shows up", "value", 3)
|
||||||
|
|
||||||
|
// Wait for them to arrive on the client.
|
||||||
|
// In a real application, the log messages would appear asynchronously
|
||||||
|
// while other work was happening.
|
||||||
|
<-done
|
||||||
|
|
||||||
|
// Output:
|
||||||
|
// info shows up 1
|
||||||
|
// warn shows up 3
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Pagination
|
### Pagination
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -215,7 +215,33 @@ requests.
|
||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
|
||||||
<!-- TODO -->
|
MCP servers can send logging messages to MCP clients.
|
||||||
|
(This form of logging is distinct from server-side logging, where the
|
||||||
|
server produces logs that remain server-side, for use by server maintainers.)
|
||||||
|
|
||||||
|
**Server-side**:
|
||||||
|
The minimum log level is part of the server state.
|
||||||
|
For stateful sessions, there is no default log level: no log messages will be sent
|
||||||
|
until the client calls `SetLevel` (see below).
|
||||||
|
For stateful sessions, the level defaults to "info".
|
||||||
|
|
||||||
|
[`ServerSession.Log`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ServerSession.Log) is the low-level way for servers to log to clients.
|
||||||
|
It sends a logging notification to the client if the level of the message
|
||||||
|
is at least the minimum log level.
|
||||||
|
|
||||||
|
For a simpler API, use [`NewLoggingHandler`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#NewLoggingHandler) to obtain a [`slog.Handler`](https://pkg.go.dev/log/slog#Handler).
|
||||||
|
By setting [`LoggingHandlerOptions.MinInterval`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#LoggingHandlerOptions.MinInterval), the handler can be rate-limited
|
||||||
|
to avoid spamming clients with too many messages.
|
||||||
|
|
||||||
|
Servers always report the logging capability.
|
||||||
|
|
||||||
|
|
||||||
|
**Client-side**:
|
||||||
|
Set [`ClientOptions.LoggingMessageHandler`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ClientOptions.LoggingMessageHandler) to receive log messages.
|
||||||
|
|
||||||
|
Call [`ClientSession.SetLevel`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp#ClientSession.SetLevel) to change the log level for a session.
|
||||||
|
|
||||||
|
%include ../../mcp/server_example_test.go logging -
|
||||||
|
|
||||||
### Pagination
|
### Pagination
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -70,6 +70,7 @@ type LoggingHandlerOptions struct {
|
||||||
// The value for the "logger" field of logging notifications.
|
// The value for the "logger" field of logging notifications.
|
||||||
LoggerName string
|
LoggerName string
|
||||||
// Limits the rate at which log messages are sent.
|
// Limits the rate at which log messages are sent.
|
||||||
|
// Excess messages are dropped.
|
||||||
// If zero, there is no rate limiting.
|
// If zero, there is no rate limiting.
|
||||||
MinInterval time.Duration
|
MinInterval time.Duration
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,8 @@ import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
|
"log/slog"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
"github.com/modelcontextprotocol/go-sdk/mcp"
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
||||||
)
|
)
|
||||||
|
|
@ -83,6 +85,67 @@ func Example_prompts() {
|
||||||
|
|
||||||
// !-prompts
|
// !-prompts
|
||||||
|
|
||||||
|
// !+logging
|
||||||
|
|
||||||
|
func Example_logging() {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
// Create a server.
|
||||||
|
s := mcp.NewServer(&mcp.Implementation{Name: "server", Version: "v0.0.1"}, nil)
|
||||||
|
|
||||||
|
// Create a client that displays log messages.
|
||||||
|
done := make(chan struct{}) // solely for the example
|
||||||
|
var nmsgs atomic.Int32
|
||||||
|
c := mcp.NewClient(
|
||||||
|
&mcp.Implementation{Name: "client", Version: "v0.0.1"},
|
||||||
|
&mcp.ClientOptions{
|
||||||
|
LoggingMessageHandler: func(_ context.Context, r *mcp.LoggingMessageRequest) {
|
||||||
|
m := r.Params.Data.(map[string]any)
|
||||||
|
fmt.Println(m["msg"], m["value"])
|
||||||
|
if nmsgs.Add(1) == 2 { // number depends on logger calls below
|
||||||
|
close(done)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
// Connect the server and client.
|
||||||
|
t1, t2 := mcp.NewInMemoryTransports()
|
||||||
|
ss, err := s.Connect(ctx, t1, nil)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
defer ss.Close()
|
||||||
|
cs, err := c.Connect(ctx, t2, nil)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
defer cs.Close()
|
||||||
|
|
||||||
|
// Set the minimum log level to "info".
|
||||||
|
if err := cs.SetLoggingLevel(ctx, &mcp.SetLoggingLevelParams{Level: "info"}); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get a slog.Logger for the server session.
|
||||||
|
logger := slog.New(mcp.NewLoggingHandler(ss, nil))
|
||||||
|
|
||||||
|
// Log some things.
|
||||||
|
logger.Info("info shows up", "value", 1)
|
||||||
|
logger.Debug("debug doesn't show up", "value", 2)
|
||||||
|
logger.Warn("warn shows up", "value", 3)
|
||||||
|
|
||||||
|
// Wait for them to arrive on the client.
|
||||||
|
// In a real application, the log messages would appear asynchronously
|
||||||
|
// while other work was happening.
|
||||||
|
<-done
|
||||||
|
|
||||||
|
// Output:
|
||||||
|
// info shows up 1
|
||||||
|
// warn shows up 3
|
||||||
|
}
|
||||||
|
|
||||||
|
// !-logging
|
||||||
|
|
||||||
// !+resources
|
// !+resources
|
||||||
func Example_resources() {
|
func Example_resources() {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue