go-sdk/docs

Overview

The SDK consists of several importable packages:

• The github.com/modelcontextprotocol/go-sdk/mcp package defines the primary APIs for constructing and using MCP clients and servers.
• The github.com/modelcontextprotocol/go-sdk/jsonrpc package is for users implementing their own transports.
• The github.com/modelcontextprotocol/go-sdk/auth package provides some primitives for supporting OAuth.
• The github.com/modelcontextprotocol/go-sdk/oauthex package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.

These docs mirror the official MCP spec. Use the index below to learn how the SDK implements a particular aspect of the protocol.

Base Protocol

1. Lifecycle (Clients, Servers, and Sessions).
2. Transports
   1. Stdio transport
   2. Streamable transport
   3. Custom transports
3. Authorization
4. Security
5. Utilities
   1. Cancellation
   2. Ping
   3. Progress

Client Features

1. Roots
2. Sampling
3. Elicitation

Server Features

1. Prompts
2. Resources
3. Tools
4. Utilities
   1. Completion
   2. Logging
   3. Pagination

TroubleShooting

See troubleshooting.md for a troubleshooting guide.

Backwards compatibility

See mcpgodebug.md for a list of backwards incompatible behavior changes and description how they can be temporarily undone.

Rough edges

See rough_edges.md for a list of rough edges or API oversights that can't be addressed due to our compatibility promise. We'll revisit these if/when we move to a v2 of the SDK.