bc84c08031
Move examples from package doc to README.md with package decl and imports to ensure it's compilable. Move status of the package from package doc to README.md. Add core concepts of MCP with example code snippets and testing recommendations. Change-Id: I5bf5000b922fa3942aba922713b12d0347295811 Reviewed-on: https://go-review.googlesource.com/c/tools/+/670316 Reviewed-by: Sam Thanawalla <samthanawalla@google.com> Reviewed-by: Jonathan Amsterdam <jba@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
49 lines
2.1 KiB
Go
49 lines
2.1 KiB
Go
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// 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) ⇅
|
|
// Client Transport ⇄ Server Transport ⇄ ClientConnection
|
|
//
|
|
// 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
|
|
// [ClientConnection].
|
|
//
|
|
// A [Transport] connects a bidirectional [Stream] of jsonrpc2 messages. In
|
|
// practice, transports in the MCP spec are 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.
|
|
//
|
|
// # TODO
|
|
//
|
|
// - Support all content types.
|
|
// - Support pagination.
|
|
// - Support completion.
|
|
// - Support oauth.
|
|
// - Support all client/server operations.
|
|
// - Pass the client connection in the context.
|
|
// - Support streamable HTTP transport.
|
|
// - Support multiple versions of the spec.
|
|
// - Implement full JSON schema support, with both client-side and
|
|
// server-side validation.
|
|
package mcp
|