| // Copyright 2025 The Go Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file. |
| |
| //go:generate go run generate.go |
| //go:generate ./internal/readme/build.sh |
| |
| // The mcp package provides an SDK for writing model context protocol clients |
| // and servers. |
| // |
| // To get started, create either a [Client] or [Server], and connect it to a |
| // peer using a [Transport]. The diagram below illustrates how this works: |
| // |
| // Client Server |
| // ⇅ (jsonrpc2) ⇅ |
| // ClientSession ⇄ Client Transport ⇄ Server Transport ⇄ ServerSession |
| // |
| // A [Client] is an MCP client, which can be configured with various client |
| // capabilities. Clients may be connected to a [Server] instance |
| // using the [Client.Connect] method. |
| // |
| // Similarly, a [Server] is an MCP server, which can be configured with various |
| // server capabilities. Servers may be connected to one or more [Client] |
| // instances using the [Server.Connect] method, which creates a |
| // [ServerSession]. |
| // |
| // A [Transport] connects a bidirectional [Connection] of jsonrpc2 messages. In |
| // practice, transports in the MCP spec are either client transports or |
| // server transports. For example, the [StdioTransport] is a server transport |
| // that communicates over stdin/stdout, and its counterpart is a |
| // [CommandTransport] that communicates with a subprocess over its |
| // stdin/stdout. |
| // |
| // Some transports may hide more complicated details, such as an |
| // [SSEClientTransport], which reads messages via server-sent events on a |
| // hanging GET request, and writes them to a POST endpoint. Users of this SDK |
| // may define their own custom Transports by implementing the [Transport] |
| // interface. |
| package mcp |
