mcp: don't mark the server sesion as initialized prematurely
Update ServerSession so that the session is not marked as initialized until 'notifications/initialized' is actually received from the client. Include a new test of this lifecycle strictness. Fixes #225
This commit is contained in:
parent
4608401cc4
commit
5ab63feefa
6 changed files with 90 additions and 22 deletions
|
|
@ -567,11 +567,25 @@ func (s *Server) Connect(ctx context.Context, t Transport) (*ServerSession, erro
|
||||||
return connect(ctx, t, s)
|
return connect(ctx, t, s)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) callInitializedHandler(ctx context.Context, ss *ServerSession, params *InitializedParams) (Result, error) {
|
func (ss *ServerSession) initialized(ctx context.Context, params *InitializedParams) (Result, error) {
|
||||||
if s.opts.KeepAlive > 0 {
|
if ss.server.opts.KeepAlive > 0 {
|
||||||
ss.startKeepalive(s.opts.KeepAlive)
|
ss.startKeepalive(ss.server.opts.KeepAlive)
|
||||||
}
|
}
|
||||||
return callNotificationHandler(ctx, s.opts.InitializedHandler, ss, params)
|
ss.mu.Lock()
|
||||||
|
hasParams := ss.initializeParams != nil
|
||||||
|
wasInitialized := ss._initialized
|
||||||
|
if hasParams {
|
||||||
|
ss._initialized = true
|
||||||
|
}
|
||||||
|
ss.mu.Unlock()
|
||||||
|
|
||||||
|
if !hasParams {
|
||||||
|
return nil, fmt.Errorf("%q before %q", notificationInitialized, methodInitialize)
|
||||||
|
}
|
||||||
|
if wasInitialized {
|
||||||
|
return nil, fmt.Errorf("duplicate %q received", notificationInitialized)
|
||||||
|
}
|
||||||
|
return callNotificationHandler(ctx, ss.server.opts.InitializedHandler, ss, params)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) callRootsListChangedHandler(ctx context.Context, ss *ServerSession, params *RootsListChangedParams) (Result, error) {
|
func (s *Server) callRootsListChangedHandler(ctx context.Context, ss *ServerSession, params *RootsListChangedParams) (Result, error) {
|
||||||
|
|
@ -603,7 +617,7 @@ type ServerSession struct {
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
logLevel LoggingLevel
|
logLevel LoggingLevel
|
||||||
initializeParams *InitializeParams
|
initializeParams *InitializeParams
|
||||||
initialized bool
|
_initialized bool
|
||||||
keepaliveCancel context.CancelFunc
|
keepaliveCancel context.CancelFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -702,7 +716,7 @@ var serverMethodInfos = map[string]methodInfo{
|
||||||
methodSetLevel: newMethodInfo(sessionMethod((*ServerSession).setLevel), 0),
|
methodSetLevel: newMethodInfo(sessionMethod((*ServerSession).setLevel), 0),
|
||||||
methodSubscribe: newMethodInfo(serverMethod((*Server).subscribe), 0),
|
methodSubscribe: newMethodInfo(serverMethod((*Server).subscribe), 0),
|
||||||
methodUnsubscribe: newMethodInfo(serverMethod((*Server).unsubscribe), 0),
|
methodUnsubscribe: newMethodInfo(serverMethod((*Server).unsubscribe), 0),
|
||||||
notificationInitialized: newMethodInfo(serverMethod((*Server).callInitializedHandler), notification|missingParamsOK),
|
notificationInitialized: newMethodInfo(sessionMethod((*ServerSession).initialized), notification|missingParamsOK),
|
||||||
notificationRootsListChanged: newMethodInfo(serverMethod((*Server).callRootsListChangedHandler), notification|missingParamsOK),
|
notificationRootsListChanged: newMethodInfo(serverMethod((*Server).callRootsListChangedHandler), notification|missingParamsOK),
|
||||||
notificationProgress: newMethodInfo(sessionMethod((*ServerSession).callProgressNotificationHandler), notification),
|
notificationProgress: newMethodInfo(sessionMethod((*ServerSession).callProgressNotificationHandler), notification),
|
||||||
}
|
}
|
||||||
|
|
@ -729,13 +743,13 @@ func (ss *ServerSession) getConn() *jsonrpc2.Connection { return ss.conn }
|
||||||
// handle invokes the method described by the given JSON RPC request.
|
// handle invokes the method described by the given JSON RPC request.
|
||||||
func (ss *ServerSession) handle(ctx context.Context, req *jsonrpc.Request) (any, error) {
|
func (ss *ServerSession) handle(ctx context.Context, req *jsonrpc.Request) (any, error) {
|
||||||
ss.mu.Lock()
|
ss.mu.Lock()
|
||||||
initialized := ss.initialized
|
initialized := ss._initialized
|
||||||
ss.mu.Unlock()
|
ss.mu.Unlock()
|
||||||
// From the spec:
|
// From the spec:
|
||||||
// "The client SHOULD NOT send requests other than pings before the server
|
// "The client SHOULD NOT send requests other than pings before the server
|
||||||
// has responded to the initialize request."
|
// has responded to the initialize request."
|
||||||
switch req.Method {
|
switch req.Method {
|
||||||
case "initialize", "ping":
|
case methodInitialize, methodPing, notificationInitialized:
|
||||||
default:
|
default:
|
||||||
if !initialized {
|
if !initialized {
|
||||||
return nil, fmt.Errorf("method %q is invalid during session initialization", req.Method)
|
return nil, fmt.Errorf("method %q is invalid during session initialization", req.Method)
|
||||||
|
|
@ -753,16 +767,8 @@ func (ss *ServerSession) initialize(ctx context.Context, params *InitializeParam
|
||||||
return nil, fmt.Errorf("%w: \"params\" must be be provided", jsonrpc2.ErrInvalidParams)
|
return nil, fmt.Errorf("%w: \"params\" must be be provided", jsonrpc2.ErrInvalidParams)
|
||||||
}
|
}
|
||||||
ss.mu.Lock()
|
ss.mu.Lock()
|
||||||
defer ss.mu.Unlock()
|
|
||||||
ss.initializeParams = params
|
ss.initializeParams = params
|
||||||
|
ss.mu.Unlock()
|
||||||
// Mark the connection as initialized when this method exits.
|
|
||||||
// TODO(#26): Technically, the server should not be considered initialized
|
|
||||||
// until it has *responded*, but since jsonrpc2 is currently serialized we
|
|
||||||
// can mark the session as initialized here. If we ever implement a
|
|
||||||
// concurrency model (#26), we need to guarantee that initialize is not
|
|
||||||
// handled concurrently to other requests.
|
|
||||||
ss.initialized = true
|
|
||||||
|
|
||||||
// If we support the client's version, reply with it. Otherwise, reply with our
|
// If we support the client's version, reply with it. Otherwise, reply with our
|
||||||
// latest version.
|
// latest version.
|
||||||
|
|
|
||||||
|
|
@ -38,11 +38,12 @@ code_review
|
||||||
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
{"jsonrpc":"2.0", "id": 3, "method": "notifications/initialized"}
|
{ "jsonrpc":"2.0", "id": 3, "method": "notifications/initialized" }
|
||||||
{"jsonrpc":"2.0", "method":"ping"}
|
{ "jsonrpc":"2.0", "method": "notifications/initialized" }
|
||||||
{"jsonrpc":"2.0", "id": 4, "method": "logging/setLevel"}
|
{ "jsonrpc":"2.0", "method":"ping" }
|
||||||
{"jsonrpc":"2.0", "id": 5, "method": "completion/complete"}
|
{ "jsonrpc":"2.0", "id": 4, "method": "logging/setLevel" }
|
||||||
{"jsonrpc":"2.0", "id": 4, "method": "logging/setLevel", "params": null}
|
{ "jsonrpc":"2.0", "id": 5, "method": "completion/complete" }
|
||||||
|
{ "jsonrpc":"2.0", "id": 4, "method": "logging/setLevel", "params": null }
|
||||||
|
|
||||||
-- server --
|
-- server --
|
||||||
{
|
{
|
||||||
|
|
|
||||||
57
mcp/testdata/conformance/server/lifecycle.txtar
vendored
Normal file
57
mcp/testdata/conformance/server/lifecycle.txtar
vendored
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
This test checks that the server obeys the rules for initialization lifecycle,
|
||||||
|
and rejects non-ping requests until 'initialized' is received.
|
||||||
|
|
||||||
|
See also modelcontextprotocol/go-sdk#225.
|
||||||
|
|
||||||
|
-- client --
|
||||||
|
{ "jsonrpc":"2.0", "method": "notifications/initialized" }
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 1,
|
||||||
|
"method": "initialize",
|
||||||
|
"params": {
|
||||||
|
"protocolVersion": "2024-11-05",
|
||||||
|
"capabilities": {},
|
||||||
|
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{ "jsonrpc":"2.0", "id": 1, "method":"ping" }
|
||||||
|
{ "jsonrpc": "2.0", "id": 2, "method": "tools/list" }
|
||||||
|
{ "jsonrpc":"2.0", "method": "notifications/initialized" }
|
||||||
|
{ "jsonrpc": "2.0", "id": 3, "method": "tools/list" }
|
||||||
|
|
||||||
|
-- server --
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 1,
|
||||||
|
"result": {
|
||||||
|
"capabilities": {
|
||||||
|
"logging": {}
|
||||||
|
},
|
||||||
|
"protocolVersion": "2024-11-05",
|
||||||
|
"serverInfo": {
|
||||||
|
"name": "testServer",
|
||||||
|
"version": "v1.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 1,
|
||||||
|
"result": {}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 2,
|
||||||
|
"error": {
|
||||||
|
"code": 0,
|
||||||
|
"message": "method \"tools/list\" is invalid during session initialization"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"id": 3,
|
||||||
|
"result": {
|
||||||
|
"tools": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -18,9 +18,11 @@ code_review
|
||||||
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
{ "jsonrpc":"2.0", "method": "notifications/initialized" }
|
||||||
{ "jsonrpc": "2.0", "id": 2, "method": "tools/list" }
|
{ "jsonrpc": "2.0", "id": 2, "method": "tools/list" }
|
||||||
{ "jsonrpc": "2.0", "id": 4, "method": "prompts/list" }
|
{ "jsonrpc": "2.0", "id": 4, "method": "prompts/list" }
|
||||||
{ "jsonrpc": "2.0", "id": 5, "method": "prompts/get" }
|
{ "jsonrpc": "2.0", "id": 5, "method": "prompts/get" }
|
||||||
|
|
||||||
-- server --
|
-- server --
|
||||||
{
|
{
|
||||||
"jsonrpc": "2.0",
|
"jsonrpc": "2.0",
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,7 @@ info.txt
|
||||||
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
{ "jsonrpc":"2.0", "method": "notifications/initialized" }
|
||||||
{ "jsonrpc": "2.0", "id": 2, "method": "resources/list" }
|
{ "jsonrpc": "2.0", "id": 2, "method": "resources/list" }
|
||||||
{
|
{
|
||||||
"jsonrpc": "2.0", "id": 3,
|
"jsonrpc": "2.0", "id": 3,
|
||||||
|
|
|
||||||
1
mcp/testdata/conformance/server/tools.txtar
vendored
1
mcp/testdata/conformance/server/tools.txtar
vendored
|
|
@ -20,6 +20,7 @@ greet
|
||||||
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
"clientInfo": { "name": "ExampleClient", "version": "1.0.0" }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
{"jsonrpc":"2.0", "method": "notifications/initialized"}
|
||||||
{ "jsonrpc": "2.0", "id": 2, "method": "tools/list" }
|
{ "jsonrpc": "2.0", "id": 2, "method": "tools/list" }
|
||||||
{ "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" }
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue