internal/mcp: update CONTRIBUTING.md and README.md for the official SDK
Change CONTRIBUTING.md and README.md to reflect that the MCP SDK is being moved to github.com/modelcontextprotocol/go-sdk, and to include content from the 'Governance' section of the design doc. Also, include the antitrust policy as a section in CONTRIBUTING.md. Change-Id: I46784d8e57b2a2cab8895593f633d20a2e15c8ba Reviewed-on: https://go-review.googlesource.com/c/tools/+/682976 Reviewed-by: Sam Thanawalla <samthanawalla@google.com> Auto-Submit: Robert Findley <rfindley@google.com> Reviewed-by: Alan Donovan <adonovan@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
This commit is contained in:
parent
a6ec3f5f4e
commit
f4ed9b5904
5 changed files with 408 additions and 109 deletions
274
CONTRIBUTING.md
274
CONTRIBUTING.md
|
|
@ -1,26 +1,270 @@
|
||||||
# Contributing to Go MCP package
|
# Contributing to the Go MCP SDK
|
||||||
|
|
||||||
Go is an open source project.
|
Thank you for your interest in contributing! The Go SDK needs active
|
||||||
|
contributions to keep up with changes in the MCP spec, fix bugs, and accomodate
|
||||||
|
new and emerging use-cases. We welcome all forms of contribution, from filing
|
||||||
|
and reviewing issues, to contributing fixes, to proposing and implementing new
|
||||||
|
features.
|
||||||
|
|
||||||
It is the work of hundreds of contributors. We appreciate your help!
|
As described in the [design document](./design/design.md), it is important for
|
||||||
|
the MCP SDK to remain idiomatic, future-proof, and extensible. The process
|
||||||
|
described here is intended to ensure that the SDK evolves safely and
|
||||||
|
transparently, while adhering to these goals.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
This module can be built and tested using the standard Go toolchain. Run `go
|
||||||
|
test ./...` to run all its tests.
|
||||||
|
|
||||||
|
To test changes to this module against another module that uses the SDK, we
|
||||||
|
recommend using a [`go.work` file](https://go.dev/doc/tutorial/workspaces) to
|
||||||
|
define a multi-module workspace. For example, if your directory contains a
|
||||||
|
`project` directory containing your project, and a `go-sdk` directory
|
||||||
|
containing the SDK, run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go work init ./project ./go-sdk
|
||||||
|
```
|
||||||
|
|
||||||
## Filing issues
|
## Filing issues
|
||||||
|
|
||||||
When [filing an issue](https://golang.org/issue/new), make sure to answer these five questions:
|
This project uses the [GitHub issue
|
||||||
|
tracker](https://github.com/modelcontextprotocol/go-sdk/issues) for issues. The
|
||||||
|
process for filing bugs and proposals is described below.
|
||||||
|
|
||||||
1. What version of Go are you using (`go version`)?
|
TODO(rfindley): describe a process for asking general questions in the public
|
||||||
2. What operating system and processor architecture are you using?
|
MCP discord server.
|
||||||
3. What did you do?
|
|
||||||
4. What did you expect to see?
|
|
||||||
5. What did you see instead?
|
|
||||||
|
|
||||||
General questions should go to the [golang-nuts mailing list](https://groups.google.com/group/golang-nuts) instead of the issue tracker.
|
### Bugs
|
||||||
The gophers there will answer or ask you to file an issue if you've tripped over a bug.
|
|
||||||
|
Please [report
|
||||||
|
bugs](https://github.com/modelcontextprotocol/go-sdk/issues/new). If the SDK is
|
||||||
|
not working as you expected, it is likely due to a bug or inadequate
|
||||||
|
documentation, and reporting an issue will help us address this shortcoming.
|
||||||
|
|
||||||
|
When reporting a bug, make sure to answer these five questions:
|
||||||
|
|
||||||
|
1. What did you do?
|
||||||
|
2. What did you see?
|
||||||
|
3. What did you expect to see?
|
||||||
|
4. What version of the Go MCP SDK are you using?
|
||||||
|
5. What version of Go are you using (`go version`)?
|
||||||
|
|
||||||
|
### Proposals
|
||||||
|
|
||||||
|
A proposal is an issue that proposes a new API for the SDK, or a change to the
|
||||||
|
signature or behavior of an existing API. Proposals are be labeled with the
|
||||||
|
'Proposal' label, and require an explicit approval from a maintainer before
|
||||||
|
being accepted (indicated by the 'Proposal-Accepted' label). Proposals must
|
||||||
|
remain open for at least a week to allow discussion before being accepted or
|
||||||
|
declined by a maintainer.
|
||||||
|
|
||||||
|
Proposals that are straightforward and uncontroversial may be approved based on
|
||||||
|
GitHub discussion. However, proposals that are deemed to be sufficiently
|
||||||
|
unclear or complicated may be deferred to a regular steering meeting (see
|
||||||
|
'Governance' below).
|
||||||
|
|
||||||
|
This process is similar to the [Go proposal
|
||||||
|
process](https://github.com/golang/proposal), but is necessarily lighter weight
|
||||||
|
to accommodate the greater rate of change expected for the SDK.
|
||||||
|
|
||||||
## Contributing code
|
## Contributing code
|
||||||
|
|
||||||
Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html)
|
The project uses GitHub pull requests (PRs) to review changes.
|
||||||
before sending patches.
|
|
||||||
|
|
||||||
Unless otherwise noted, the Go source files are distributed under
|
Any significant change should be associated with a GitHub issue. Issues that
|
||||||
the BSD-style license found in the LICENSE file.
|
are deemed to be good opportunities for contribution are be labeled ['Help
|
||||||
|
Wanted'](https://github.com/modelcontextprotocol/go-sdk/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22).
|
||||||
|
If you want to work on such an issue, please first comment on the issue to say
|
||||||
|
that you're interested in contributing. For issues _not_ labeled 'Help Wanted',
|
||||||
|
it is recommended that you ask (and wait for confirmation) on the issue before
|
||||||
|
contributing, to avoid duplication of effort or wasted work. For nontrivial
|
||||||
|
changes that _don't_ relate to an existing issue, please file an issue first.
|
||||||
|
|
||||||
|
Changes should be high quality and well tested, and should generally follow the
|
||||||
|
[Google Go style guide](https://google.github.io/styleguide/go/). Commit
|
||||||
|
messages should follow the [format used by the Go
|
||||||
|
project](https://go.dev/wiki/CommitMessage).
|
||||||
|
|
||||||
|
Unless otherwise noted, the Go source files are distributed under the MIT-style
|
||||||
|
license found in the LICENSE file. All Go files in the SDK should have a
|
||||||
|
copyright header following the format below:
|
||||||
|
|
||||||
|
```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.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
This project follows the [Go Community Code of Conduct](https://go.dev/conduct).
|
||||||
|
If you encounter a conduct-related issue, please mail conduct@golang.org.
|
||||||
|
|
||||||
|
## Governance
|
||||||
|
|
||||||
|
Initially, the Go SDK repository will be administered by the Go team and
|
||||||
|
Anthropic, and they will be the Approvers (the set of people able to merge PRs
|
||||||
|
to the SDK). The policies here are also intended to satisfy necessary
|
||||||
|
constraints of the Go team's participation in the project. This may change in
|
||||||
|
the future: see 'Ongoing Evaluation' below.
|
||||||
|
|
||||||
|
### Steering meetings
|
||||||
|
|
||||||
|
On a regular basis, the maintainers will host a virtual steering meeting to
|
||||||
|
discuss outstanding proposals and other changes to the SDK. These meetings and
|
||||||
|
their agendas will be announced in advance, and open to all to join. The
|
||||||
|
meetings will be recorded, and recordings and meeting notes will be made
|
||||||
|
available afterward. (TODO: decide on a mechanism for tracking these
|
||||||
|
meetings--likely a GitHub issue.)
|
||||||
|
|
||||||
|
This process is similar to the [Go Tools
|
||||||
|
call](https://go.dev/wiki/golang-tools), though it is expected that meetings
|
||||||
|
will at least initially occur on a more frequent basis.
|
||||||
|
|
||||||
|
### Discord
|
||||||
|
|
||||||
|
Discord (either the public or private Anthropic discord servers) should only be
|
||||||
|
used for logistical coordination or answering questions. For transparency and
|
||||||
|
durability, design discussion and decisions should occur in GitHub issues or
|
||||||
|
public steering meetings.
|
||||||
|
|
||||||
|
### Antitrust considerations
|
||||||
|
|
||||||
|
It is important that the SDK avoids bias toward specific integration paths or
|
||||||
|
providers. The antitrust policy below details precise terms that should be
|
||||||
|
avoided to ensure that the evolution and governance of the SDK remain
|
||||||
|
procompetitive.
|
||||||
|
|
||||||
|
A note to readers: this policy was drafted in consultation with counsel, and so
|
||||||
|
uses terms like 'Steering Committee', which may be confusing in the context of
|
||||||
|
other 'steering committees' for model context protocol. In the context here,
|
||||||
|
'Steering Committee' means the set of Approvers, who are able to approve pull
|
||||||
|
requests and/or make administrative changes to the project.
|
||||||
|
|
||||||
|
### Antitrust policy
|
||||||
|
|
||||||
|
Note: all changes to the policy in this section must be approved by legal
|
||||||
|
counsel.
|
||||||
|
|
||||||
|
The Go+Anthropic MCP SDK Steering Committee (the “Committee”) is established to
|
||||||
|
guide and review technical contributions to an open-source Go software
|
||||||
|
development kit (“SDK”) for the Model Context Protocol (“MCP”). The Committee
|
||||||
|
and its members are committed to operating for procompetitive purposes that
|
||||||
|
accelerate AI development and benefit businesses and consumers. This
|
||||||
|
collaboration is focused on technical and infrastructure objectives – namely,
|
||||||
|
developing and maintaining a neutral, open-source, and MIT-licensed tool.
|
||||||
|
Google and Anthropic, as well as other stakeholders, participate with the
|
||||||
|
understanding that the Committee’s sole purpose is to improve interoperability
|
||||||
|
and innovation in the MCP ecosystem.
|
||||||
|
|
||||||
|
Antitrust law recognizes that when competitors collaborate for valid reasons
|
||||||
|
(e.g., joint R&D or standard-setting), such collaborations can be
|
||||||
|
procompetitive. This Antitrust Compliance Policy (the “Policy”) therefore
|
||||||
|
outlines guidelines and safeguards to ensure the collaboration remains focused
|
||||||
|
on its technical mission.
|
||||||
|
|
||||||
|
The Policy applies to all Committee activities and communications, including
|
||||||
|
official meetings, subcommittee discussions, emails, shared documents, and any
|
||||||
|
other interactions under the Committee’s auspices (e.g., group chats, version
|
||||||
|
control systems). It applies to all participants from Google, Anthropic, and
|
||||||
|
any other member organizations or independent contributors involved. Each
|
||||||
|
participating entity should ensure its representatives understand and uphold
|
||||||
|
these rules. By participating, members agree to follow the Policy in both
|
||||||
|
letter and spirit.
|
||||||
|
|
||||||
|
#### Governance Procedures and Principles
|
||||||
|
|
||||||
|
- **Participant Guidelines.** Participants should generally be limited to
|
||||||
|
individuals in technical roles who are directly involved in the MCP SDK
|
||||||
|
project. These participants should not be key decision-makers in their
|
||||||
|
company’s AI commercial strategy, sales, marketing, pricing, or other
|
||||||
|
competitively or strategically sensitive business planning.
|
||||||
|
- **Agenda Preparation.** A written agenda should be circulated before each
|
||||||
|
Committee meeting. Agenda items should focus on the SDK’s technical
|
||||||
|
development, maintenance, or documentation. Where appropriate, counsel should
|
||||||
|
review the agenda prior to circulation to ensure compliance with the Policy.
|
||||||
|
- **Policy Reminder at Start.** Meetings should begin with a brief antitrust
|
||||||
|
compliance reminder with reference to the Policy.
|
||||||
|
- **Minutes.** Meetings will be minuted by a designated participant, and
|
||||||
|
neutrally record attendees, roles, topics discussed, action items, and
|
||||||
|
outcomes. Draft minutes will be circulated to all participants.
|
||||||
|
- **Documentation and Transparency.** Steering Committee outputs are intended
|
||||||
|
for public release. Significant design decisions and discussion outcomes
|
||||||
|
should be documented publicly. If a topic cannot be safely disclosed
|
||||||
|
publicly, it likely does not belong in this forum.
|
||||||
|
- **Independence of Decision-Making.** All participants and their companies
|
||||||
|
retain complete independence in their own business decisions and competitive
|
||||||
|
strategies outside of the MCP SDK project. Nothing in this collaboration
|
||||||
|
restricts or influences how each company operates its commercial business.
|
||||||
|
|
||||||
|
### Information Exchange Guidelines
|
||||||
|
|
||||||
|
**Appropriate Topics.** Committee members are anticipated to remain within the
|
||||||
|
project’s technical scope. In general, discussions should focus on improving
|
||||||
|
the Go SDK for MCP in a transparent, collaborative, and non-exclusive manner.
|
||||||
|
The following topics are appropriate and expected:
|
||||||
|
|
||||||
|
- **Software Design and Architecture:** Implementation of MCP features in Go,
|
||||||
|
API design, code structure, testing frameworks, performance considerations,
|
||||||
|
compatibility issues, and security concerns.
|
||||||
|
- **Technical Contributions and Bug Fixes:** Review of code contributions,
|
||||||
|
debugging problems, and handling feature requests.
|
||||||
|
- **Documentation and Open-Source Logistics:** Discussions of project
|
||||||
|
documentation, changelogs, versioning strategy, and managing contributions.
|
||||||
|
- **Standards and Interoperability:** Ensuring SDK compliance with MCP or other
|
||||||
|
open technical standards. Any standardization effort should be open,
|
||||||
|
voluntary, and tailored to promote interoperability.
|
||||||
|
- **Public Information:** Any public information relevant to the Committee’s
|
||||||
|
technical work (e.g., published research, open-source code from outside
|
||||||
|
projects, publicly documented API specs).
|
||||||
|
|
||||||
|
**Inappropriate Topics.** To ensure compliance with antitrust law and maintain
|
||||||
|
the open character of the collaboration, the following subjects should not be
|
||||||
|
discussed in Committee meetings, side conversations, or related communications:
|
||||||
|
|
||||||
|
- **Pricing and Commercial Terms:** Do not discuss prices, pricing strategy,
|
||||||
|
discounting, or future pricing plans for Claude, Gemini, or any other AI
|
||||||
|
product or service provided by Committee members.
|
||||||
|
- **Sales or Output:** Avoid sharing sales volumes, revenue, customer counts,
|
||||||
|
market shares, production plans, or any business performance metrics.
|
||||||
|
- **Product Roadmaps (beyond SDK):** Do not disclose internal plans for AI
|
||||||
|
model development, feature rollouts, or future commercialization strategies.
|
||||||
|
- **Customers or Markets:** No discussions of which customers, industries, or
|
||||||
|
geographies the parties will pursue or avoid.
|
||||||
|
- **Customer or Supplier Details:** Do not share specifics of contracts,
|
||||||
|
negotiations, or relationships with commercial partners.
|
||||||
|
- **Non-SDK Proprietary Tech:** Keep discussions focused on the open SDK.
|
||||||
|
Sharing of information should be limited to what is needed to achieve the
|
||||||
|
Committee’s goals. Each party’s internal model architectures, fine-tuning
|
||||||
|
approaches, or training methods unrelated to the project should not be
|
||||||
|
disclosed.
|
||||||
|
- **HR or Labor Matters:** No discussions about wages, hiring plans, or
|
||||||
|
policies toward employees.
|
||||||
|
|
||||||
|
#### Enforcement and Support
|
||||||
|
|
||||||
|
- **Shared Responsibility.** All Committee participants share responsibility
|
||||||
|
for upholding the Policy. While legal counsel can provide support, day-to-day
|
||||||
|
compliance is a function of culture and practice.
|
||||||
|
- **Designated Legal Contacts.** Each participating entity should designate a
|
||||||
|
legal point of contact responsible for reviewing meeting materials (e.g.,
|
||||||
|
agendas, minutes) and fielding questions about compliance. These contacts
|
||||||
|
should be included in the Committee distribution list for all official
|
||||||
|
materials and should be consulted in advance of any meetings where sensitive
|
||||||
|
topics may arise.
|
||||||
|
- **Final Note.** The Policy is not meant to chill legitimate technical
|
||||||
|
collaboration. It is meant to ensure that the Committee can focus on its
|
||||||
|
mission without creating unnecessary legal risk or attracting regulator
|
||||||
|
scrutiny. Participants who follow the Policy and avoid Inappropriate Topics
|
||||||
|
will remain squarely within the procompetitive zone.
|
||||||
|
|
||||||
|
### Ongoing evaluation
|
||||||
|
|
||||||
|
On an ongoing basis, the administrators of the SDK will evaluate whether it is
|
||||||
|
keeping pace with changes to the MCP spec and meeting its goals of openness and
|
||||||
|
transparency. If it is not meeting these goals, either because it exceeds the
|
||||||
|
bandwidth of its current Approvers, or because the processes here are
|
||||||
|
inadequate, these processes will be re-evaluated by the Approvers. At this
|
||||||
|
time, the Approvers set may be expanded to include additional community
|
||||||
|
members, based on their history of strong contribution.
|
||||||
|
|
|
||||||
117
README.md
117
README.md
|
|
@ -1,32 +1,43 @@
|
||||||
<!-- Autogenerated by weave; DO NOT EDIT -->
|
<!-- Autogenerated by weave; DO NOT EDIT -->
|
||||||
|
# MCP Go SDK
|
||||||
|
|
||||||
# MCP SDK prototype
|
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol
|
||||||
|
module, once it exists. -->
|
||||||
|
|
||||||
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp)
|
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
|
||||||
|
|
||||||
# Contents
|
This repository contains an implementation of the official Go software
|
||||||
|
development kit (SDK) for the Model Context Protocol (MCP).
|
||||||
|
|
||||||
1. [Installation](#installation)
|
**WARNING**: The SDK is currently unstable and subject to breaking changes.
|
||||||
1. [Quickstart](#quickstart)
|
Please test it out and file bug reports or API proposals. The [TODO](#todo)
|
||||||
|
section below outlines outstanding release blockers. We aim to release a stable
|
||||||
|
version of the SDK in mid July, 2025.
|
||||||
|
|
||||||
|
1. [Package documentation](#package-documentation)
|
||||||
|
1. [Example](#example)
|
||||||
|
1. [TODO](#todo)
|
||||||
1. [Design](#design)
|
1. [Design](#design)
|
||||||
1. [Testing](#testing)
|
1. [Acknowledgements](#acknowledgements)
|
||||||
1. [Code of Conduct](#code-of-conduct)
|
|
||||||
1. [License](#license)
|
1. [License](#license)
|
||||||
|
|
||||||
The mcp package provides a software development kit (SDK) for writing clients
|
## Package documentation
|
||||||
and servers of the [model context
|
|
||||||
protocol](https://modelcontextprotocol.io/introduction). It is unstable, and
|
|
||||||
will change in breaking ways in the future. As of writing, it is a prototype to
|
|
||||||
explore the design space of client/server transport and binding.
|
|
||||||
|
|
||||||
# Installation
|
The SDK consists of two importable packages:
|
||||||
|
|
||||||
The mcp package is currently internal and cannot be imported using `go get`.
|
- The
|
||||||
|
[`github.com/modelcontextprotocol/go-sdk/mcp`](https://pkg.go.dev/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/jsonschema`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/jsonschema)
|
||||||
|
package provides an implementation of [JSON
|
||||||
|
Schema](https://json-schema.org/), used for MCP tool input and output schema.
|
||||||
|
|
||||||
# Quickstart
|
## Example
|
||||||
|
|
||||||
Here's an example that creates a client that talks to an MCP server running
|
In this example, an MCP client communicates with an MCP server running in a
|
||||||
as a sidecar process:
|
sidecar process:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
package main
|
||||||
|
|
@ -41,8 +52,10 @@ import (
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|
||||||
// Create a new client, with no features.
|
// Create a new client, with no features.
|
||||||
client := mcp.NewClient("mcp-client", "v1.0.0", nil)
|
client := mcp.NewClient("mcp-client", "v1.0.0", nil)
|
||||||
|
|
||||||
// Connect to a server over stdin/stdout
|
// Connect to a server over stdin/stdout
|
||||||
transport := mcp.NewCommandTransport(exec.Command("myserver"))
|
transport := mcp.NewCommandTransport(exec.Command("myserver"))
|
||||||
session, err := client.Connect(ctx, transport)
|
session, err := client.Connect(ctx, transport)
|
||||||
|
|
@ -50,31 +63,34 @@ func main() {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
defer session.Close()
|
defer session.Close()
|
||||||
|
|
||||||
// Call a tool on the server.
|
// Call a tool on the server.
|
||||||
params := &mcp.CallToolParams{
|
params := &mcp.CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "you"},
|
Arguments: map[string]any{"name": "you"},
|
||||||
}
|
}
|
||||||
if res, err := session.CallTool(ctx, params); err != nil {
|
res, err := session.CallTool(ctx, params)
|
||||||
log.Printf("CallTool failed: %v", err)
|
if err != nil {
|
||||||
} else {
|
log.Fatalf("CallTool failed: %v", err)
|
||||||
|
}
|
||||||
if res.IsError {
|
if res.IsError {
|
||||||
log.Print("tool failed")
|
log.Fatal("tool failed")
|
||||||
}
|
}
|
||||||
for _, c := range res.Content {
|
for _, c := range res.Content {
|
||||||
log.Print(c.Text)
|
log.Print(c.Text)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Here is an example of the corresponding server, connected over stdin/stdout:
|
Here's an example of the corresponding server component, which communicates
|
||||||
|
with its client over stdin/stdout:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"log"
|
||||||
|
|
||||||
"github.com/modelcontextprotocol/go-sdk/mcp"
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
||||||
)
|
)
|
||||||
|
|
@ -83,8 +99,8 @@ type HiParams struct {
|
||||||
Name string `json:"name"`
|
Name string `json:"name"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func SayHi(ctx context.Context, cc *mcp.ServerSession, params *mcp.CallToolParamsFor[HiParams]) (*mcp.CallToolResultFor[string], error) {
|
func SayHi(ctx context.Context, cc *mcp.ServerSession, params *mcp.CallToolParamsFor[HiParams]) (*mcp.CallToolResultFor[any], error) {
|
||||||
return &mcp.CallToolResultFor[string]{
|
return &mcp.CallToolResultFor[any]{
|
||||||
Content: []*mcp.Content{mcp.NewTextContent("Hi " + params.Name)},
|
Content: []*mcp.Content{mcp.NewTextContent("Hi " + params.Name)},
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
@ -94,35 +110,46 @@ func main() {
|
||||||
server := mcp.NewServer("greeter", "v1.0.0", nil)
|
server := mcp.NewServer("greeter", "v1.0.0", nil)
|
||||||
server.AddTools(mcp.NewServerTool("greet", "say hi", SayHi))
|
server.AddTools(mcp.NewServerTool("greet", "say hi", SayHi))
|
||||||
// Run the server over stdin/stdout, until the client disconnects
|
// Run the server over stdin/stdout, until the client disconnects
|
||||||
_ = server.Run(context.Background(), mcp.NewStdIOTransport())
|
if err := server.Run(context.Background(), mcp.NewStdIOTransport()); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# Design
|
The `examples/` directory contains more example clients and servers.
|
||||||
|
|
||||||
See [design.md](./design/design.md) for the SDK design. That document is
|
## TODO
|
||||||
canonical: given any divergence between the design doc and this prototype, the
|
|
||||||
doc reflects the latest design.
|
|
||||||
|
|
||||||
# Testing
|
The following TODOs block the release of this SDK:
|
||||||
|
|
||||||
To test your client or server using stdio transport, you can use an in-memory
|
- Better support for resumability in the Streamable HTTP transport: a
|
||||||
transport. See [example](server_example_test.go).
|
server-side event store and client-side retry configuration.
|
||||||
|
- OAuth support (or examples of implementing OAuth using middleware).
|
||||||
|
- Support for the changes in the
|
||||||
|
[2025-06-18](https://modelcontextprotocol.io/specification/2025-06-18/changelog)
|
||||||
|
version of the MCP spec.
|
||||||
|
- More examples and documentation.
|
||||||
|
|
||||||
To test your client or server using sse transport, you can use the [httptest](https://pkg.go.dev/net/http/httptest)
|
## Design
|
||||||
package. See [example](sse_example_test.go).
|
|
||||||
|
|
||||||
# Code of Conduct
|
The design doc for this SDK is at [design.md](./design/design.md), which was
|
||||||
|
initially reviewed at
|
||||||
|
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
|
||||||
|
|
||||||
This project follows the [Go Community Code of Conduct](https://go.dev/conduct).
|
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
|
||||||
If you encounter a conduct-related issue, please mail conduct@golang.org.
|
for details.
|
||||||
|
|
||||||
# License
|
## Acknowledgements
|
||||||
|
|
||||||
Unless otherwise noted, the Go source files are distributed under the BSD-style
|
Several existing Go MCP SDKs inspired the development and design of this
|
||||||
license found in the [LICENSE](../../LICENSE) file.
|
official SDK, notably [mcp-go](https://github.com/mark3labs/mcp-go), authored
|
||||||
|
by Ed Zynda. We are grateful to Ed as well as the other contributors to mcp-go,
|
||||||
|
and to authors and contributors of other SDKs such as
|
||||||
|
[mcp-golang](https://github.com/metoro-io/mcp-golang) and
|
||||||
|
[go-mcp](https://github.com/ThinkInAIXYZ/go-mcp). Thanks to their work, there
|
||||||
|
is a thriving ecosystem of Go MCP clients and servers.
|
||||||
|
|
||||||
Upon a potential move to the
|
## License
|
||||||
[modelcontextprotocol](https://github.com/modelcontextprotocol) organization,
|
|
||||||
the license will be updated to the MIT License, and the license header will
|
This project is licensed under the MIT License - see the [LICENSE](./LICENSE)
|
||||||
reflect the Go MCP SDK Authors.
|
file for details.
|
||||||
|
|
|
||||||
|
|
@ -1,57 +1,79 @@
|
||||||
# MCP SDK prototype
|
# MCP Go SDK
|
||||||
|
|
||||||
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp)
|
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol
|
||||||
|
module, once it exists. -->
|
||||||
|
|
||||||
# Contents
|
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
|
||||||
|
|
||||||
|
This repository contains an implementation of the official Go software
|
||||||
|
development kit (SDK) for the Model Context Protocol (MCP).
|
||||||
|
|
||||||
|
**WARNING**: The SDK is currently unstable and subject to breaking changes.
|
||||||
|
Please test it out and file bug reports or API proposals. The [TODO](#todo)
|
||||||
|
section below outlines outstanding release blockers. We aim to release a stable
|
||||||
|
version of the SDK in mid July, 2025.
|
||||||
|
|
||||||
%toc
|
%toc
|
||||||
|
|
||||||
The mcp package provides a software development kit (SDK) for writing clients
|
## Package documentation
|
||||||
and servers of the [model context
|
|
||||||
protocol](https://modelcontextprotocol.io/introduction). It is unstable, and
|
|
||||||
will change in breaking ways in the future. As of writing, it is a prototype to
|
|
||||||
explore the design space of client/server transport and binding.
|
|
||||||
|
|
||||||
# Installation
|
The SDK consists of two importable packages:
|
||||||
|
|
||||||
The mcp package is currently internal and cannot be imported using `go get`.
|
- The
|
||||||
|
[`github.com/modelcontextprotocol/go-sdk/mcp`](https://pkg.go.dev/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/jsonschema`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/jsonschema)
|
||||||
|
package provides an implementation of [JSON
|
||||||
|
Schema](https://json-schema.org/), used for MCP tool input and output schema.
|
||||||
|
|
||||||
# Quickstart
|
## Example
|
||||||
|
|
||||||
Here's an example that creates a client that talks to an MCP server running
|
In this example, an MCP client communicates with an MCP server running in a
|
||||||
as a sidecar process:
|
sidecar process:
|
||||||
|
|
||||||
%include client/client.go -
|
%include client/client.go -
|
||||||
|
|
||||||
Here is an example of the corresponding server, connected over stdin/stdout:
|
Here's an example of the corresponding server component, which communicates
|
||||||
|
with its client over stdin/stdout:
|
||||||
|
|
||||||
%include server/server.go -
|
%include server/server.go -
|
||||||
|
|
||||||
# Design
|
The `examples/` directory contains more example clients and servers.
|
||||||
|
|
||||||
See [design.md](./design/design.md) for the SDK design. That document is
|
## TODO
|
||||||
canonical: given any divergence between the design doc and this prototype, the
|
|
||||||
doc reflects the latest design.
|
|
||||||
|
|
||||||
# Testing
|
The following TODOs block the release of this SDK:
|
||||||
|
|
||||||
To test your client or server using stdio transport, you can use an in-memory
|
- Better support for resumability in the Streamable HTTP transport: a
|
||||||
transport. See [example](server_example_test.go).
|
server-side event store and client-side retry configuration.
|
||||||
|
- OAuth support (or examples of implementing OAuth using middleware).
|
||||||
|
- Support for the changes in the
|
||||||
|
[2025-06-18](https://modelcontextprotocol.io/specification/2025-06-18/changelog)
|
||||||
|
version of the MCP spec.
|
||||||
|
- More examples and documentation.
|
||||||
|
|
||||||
To test your client or server using sse transport, you can use the [httptest](https://pkg.go.dev/net/http/httptest)
|
## Design
|
||||||
package. See [example](sse_example_test.go).
|
|
||||||
|
|
||||||
# Code of Conduct
|
The design doc for this SDK is at [design.md](./design/design.md), which was
|
||||||
|
initially reviewed at
|
||||||
|
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
|
||||||
|
|
||||||
This project follows the [Go Community Code of Conduct](https://go.dev/conduct).
|
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
|
||||||
If you encounter a conduct-related issue, please mail conduct@golang.org.
|
for details.
|
||||||
|
|
||||||
# License
|
## Acknowledgements
|
||||||
|
|
||||||
Unless otherwise noted, the Go source files are distributed under the BSD-style
|
Several existing Go MCP SDKs inspired the development and design of this
|
||||||
license found in the [LICENSE](../../LICENSE) file.
|
official SDK, notably [mcp-go](https://github.com/mark3labs/mcp-go), authored
|
||||||
|
by Ed Zynda. We are grateful to Ed as well as the other contributors to mcp-go,
|
||||||
|
and to authors and contributors of other SDKs such as
|
||||||
|
[mcp-golang](https://github.com/metoro-io/mcp-golang) and
|
||||||
|
[go-mcp](https://github.com/ThinkInAIXYZ/go-mcp). Thanks to their work, there
|
||||||
|
is a thriving ecosystem of Go MCP clients and servers.
|
||||||
|
|
||||||
Upon a potential move to the
|
## License
|
||||||
[modelcontextprotocol](https://github.com/modelcontextprotocol) organization,
|
|
||||||
the license will be updated to the MIT License, and the license header will
|
This project is licensed under the MIT License - see the [LICENSE](./LICENSE)
|
||||||
reflect the Go MCP SDK Authors.
|
file for details.
|
||||||
|
|
|
||||||
|
|
@ -15,8 +15,10 @@ import (
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|
||||||
// Create a new client, with no features.
|
// Create a new client, with no features.
|
||||||
client := mcp.NewClient("mcp-client", "v1.0.0", nil)
|
client := mcp.NewClient("mcp-client", "v1.0.0", nil)
|
||||||
|
|
||||||
// Connect to a server over stdin/stdout
|
// Connect to a server over stdin/stdout
|
||||||
transport := mcp.NewCommandTransport(exec.Command("myserver"))
|
transport := mcp.NewCommandTransport(exec.Command("myserver"))
|
||||||
session, err := client.Connect(ctx, transport)
|
session, err := client.Connect(ctx, transport)
|
||||||
|
|
@ -24,21 +26,22 @@ func main() {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
defer session.Close()
|
defer session.Close()
|
||||||
|
|
||||||
// Call a tool on the server.
|
// Call a tool on the server.
|
||||||
params := &mcp.CallToolParams{
|
params := &mcp.CallToolParams{
|
||||||
Name: "greet",
|
Name: "greet",
|
||||||
Arguments: map[string]any{"name": "you"},
|
Arguments: map[string]any{"name": "you"},
|
||||||
}
|
}
|
||||||
if res, err := session.CallTool(ctx, params); err != nil {
|
res, err := session.CallTool(ctx, params)
|
||||||
log.Printf("CallTool failed: %v", err)
|
if err != nil {
|
||||||
} else {
|
log.Fatalf("CallTool failed: %v", err)
|
||||||
|
}
|
||||||
if res.IsError {
|
if res.IsError {
|
||||||
log.Print("tool failed")
|
log.Fatal("tool failed")
|
||||||
}
|
}
|
||||||
for _, c := range res.Content {
|
for _, c := range res.Content {
|
||||||
log.Print(c.Text)
|
log.Print(c.Text)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
//!-
|
//!-
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"log"
|
||||||
|
|
||||||
"github.com/modelcontextprotocol/go-sdk/mcp"
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
||||||
)
|
)
|
||||||
|
|
@ -26,7 +27,9 @@ func main() {
|
||||||
server := mcp.NewServer("greeter", "v1.0.0", nil)
|
server := mcp.NewServer("greeter", "v1.0.0", nil)
|
||||||
server.AddTools(mcp.NewServerTool("greet", "say hi", SayHi))
|
server.AddTools(mcp.NewServerTool("greet", "say hi", SayHi))
|
||||||
// Run the server over stdin/stdout, until the client disconnects
|
// Run the server over stdin/stdout, until the client disconnects
|
||||||
_ = server.Run(context.Background(), mcp.NewStdIOTransport())
|
if err := server.Run(context.Background(), mcp.NewStdIOTransport()); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// !-
|
// !-
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue