internal/mcp: construct README with weave
Use the weave program from golang.org/x/example to weave together the README text with buildable programs. This ensures the code in the README compiles. Change-Id: Ib5e10c8f808cc6d1ed4addbee784607e910ba30b Reviewed-on: https://go-review.googlesource.com/c/tools/+/673796 Reviewed-by: Robert Findley <rfindley@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
This commit is contained in:
parent
ce5b6cd926
commit
715e9f1935
1 changed files with 196 additions and 10 deletions
35
README.md
35
README.md
|
|
@ -1,18 +1,28 @@
|
|||
<!-- Autogenerated by weave; DO NOT EDIT -->
|
||||
# MCP SDK prototype
|
||||
|
||||
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/mcp)
|
||||
|
||||
# Contents
|
||||
|
||||
1. [Installation](#installation)
|
||||
1. [Quickstart](#quickstart)
|
||||
1. [Design](#design)
|
||||
1. [Testing](#testing)
|
||||
1. [Code of Conduct](#code-of-conduct)
|
||||
1. [License](#license)
|
||||
|
||||
The mcp package provides a software development kit (SDK) for writing clients
|
||||
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
|
||||
# Installation
|
||||
|
||||
The mcp package is currently internal and cannot be imported using `go get`.
|
||||
|
||||
## Quickstart
|
||||
# Quickstart
|
||||
|
||||
Here's an example that creates a client that talks to an MCP server running
|
||||
as a sidecar process:
|
||||
|
|
@ -35,15 +45,20 @@ func main() {
|
|||
// Connect to a server over stdin/stdout
|
||||
transport := mcp.NewCommandTransport(exec.Command("myserver"))
|
||||
session, err := client.Connect(ctx, transport)
|
||||
if err != nil {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer session.Close()
|
||||
defer session.Close()
|
||||
// Call a tool on the server.
|
||||
if content, err := session.CallTool(ctx, "greet", map[string]any{"name": "you"}, nil); err != nil {
|
||||
if res, err := session.CallTool(ctx, "greet", map[string]any{"name": "you"}, nil); err != nil {
|
||||
log.Printf("CallTool failed: %v", err)
|
||||
} else {
|
||||
log.Printf("CallTool returns: %v", content)
|
||||
if res.IsError {
|
||||
log.Print("tool failed")
|
||||
}
|
||||
for _, c := range res.Content {
|
||||
log.Print(c.Text)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -78,13 +93,13 @@ func main() {
|
|||
}
|
||||
```
|
||||
|
||||
## Design
|
||||
# Design
|
||||
|
||||
See [design.md](./design/design.md) for the SDK design. That document is
|
||||
canonical: given any divergence between the design doc and this prototype, the
|
||||
doc reflects the latest design.
|
||||
|
||||
## Testing
|
||||
# Testing
|
||||
|
||||
To test your client or server using stdio transport, you can use an in-memory
|
||||
transport. See [example](server_example_test.go).
|
||||
|
|
@ -92,12 +107,12 @@ transport. See [example](server_example_test.go).
|
|||
To test your client or server using sse transport, you can use the [httptest](https://pkg.go.dev/net/http/httptest)
|
||||
package. See [example](sse_example_test.go).
|
||||
|
||||
## Code of Conduct
|
||||
# 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.
|
||||
|
||||
## License
|
||||
# License
|
||||
|
||||
Unless otherwise noted, the Go source files are distributed under the BSD-style
|
||||
license found in the [LICENSE](../../LICENSE) file.
|
||||
|
|
|
|||
Loading…
Reference in a new issue