go-sdk/internal/docs/README.src.md
Robert Findley 32d84d8421
docs: document known rough edges (#609)
Start keeping a log of rough edges we've discovered post v1.0.0, so that
they're discoverable (along with their workarounds), and so that we can
fix them in v2.
2025-10-29 10:57:45 -04:00

45 lines
1.4 KiB
Markdown

# Features
These docs mirror the [official MCP spec](https://modelcontextprotocol.io/specification/2025-06-18).
Use the index below to learn how the SDK implements a particular aspect of the
protocol.
## Base Protocol
1. [Lifecycle (Clients, Servers, and Sessions)](protocol.md#lifecycle).
1. [Transports](protocol.md#transports)
1. [Stdio transport](protocol.md#stdio-transport)
1. [Streamable transport](protocol.md#streamable-transport)
1. [Custom transports](protocol.md#stateless-mode)
1. [Authorization](protocol.md#authorization)
1. [Security](protocol.md#security)
1. [Utilities](protocol.md#utilities)
1. [Cancellation](protocol.md#cancellation)
1. [Ping](protocol.md#ping)
1. [Progress](protocol.md#progress)
## Client Features
1. [Roots](client.md#roots)
1. [Sampling](client.md#sampling)
1. [Elicitation](client.md#elicitation)
## Server Features
1. [Prompts](server.md#prompts)
1. [Resources](server.md#resources)
1. [Tools](server.md#tools)
1. [Utilities](server.md#utilities)
1. [Completion](server.md#completion)
1. [Logging](server.md#logging)
1. [Pagination](server.md#pagination)
# TroubleShooting
See [troubleshooting.md](troubleshooting.md) for a troubleshooting guide.
# Rough edges
See [rough_edges.md](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.