Skip to content

Commit 5aabc33

Browse files
authored
all: minor cleanup and README improvements (#30)
Clean up some inaccurate comments, and update the README to strengthen warnings about the current status.
1 parent 204b594 commit 5aabc33

File tree

5 files changed

+18
-42
lines changed

5 files changed

+18
-42
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ module, once it exists. -->
66

77
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
88

9-
This repository contains an implementation of the official Go software
10-
development kit (SDK) for the Model Context Protocol (MCP).
9+
This repository contains an unreleased implementation of the official Go
10+
software development kit (SDK) for the Model Context Protocol (MCP).
1111

12-
**WARNING**: The SDK is currently unstable and subject to breaking changes.
13-
Please test it out and file bug reports or API proposals. The [TODO](#todo)
14-
section below outlines outstanding release blockers. We aim to release a stable
15-
version of the SDK in August, 2025.
12+
**WARNING**: The SDK should be considered unreleased, and is currently unstable
13+
and subject to breaking changes. Please test it out and file bug reports or API
14+
proposals, but don't use it in real projects. See the issue tracker for known
15+
issues and missing features. We aim to release a stable version of the SDK in
16+
August, 2025.
1617

1718
## Package documentation
1819

@@ -111,18 +112,6 @@ func main() {
111112

112113
The `examples/` directory contains more example clients and servers.
113114

114-
## TODO
115-
116-
The following TODOs block the release of this SDK:
117-
118-
- Better support for resumability in the Streamable HTTP transport: a
119-
server-side event store and client-side retry configuration.
120-
- OAuth support (or examples of implementing OAuth using middleware).
121-
- Support for the changes in the
122-
[2025-06-18](https://modelcontextprotocol.io/specification/2025-06-18/changelog)
123-
version of the MCP spec.
124-
- More examples and documentation.
125-
126115
## Design
127116

128117
The design doc for this SDK is at [design.md](./design/design.md), which was

examples/hello/main.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ func SayHi(ctx context.Context, ss *mcp.ServerSession, params *mcp.CallToolParam
3030
}, nil
3131
}
3232

33-
// TODO(jba): it should be OK for args to be a pointer, but this fails in
34-
// jsonschema. Needs investigation.
3533
func PromptHi(ctx context.Context, ss *mcp.ServerSession, params *mcp.GetPromptParams) (*mcp.GetPromptResult, error) {
3634
return &mcp.GetPromptResult{
3735
Description: "Code review prompt",

internal/readme/README.src.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ module, once it exists. -->
55

66
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
77

8-
This repository contains an implementation of the official Go software
9-
development kit (SDK) for the Model Context Protocol (MCP).
8+
This repository contains an unreleased implementation of the official Go
9+
software development kit (SDK) for the Model Context Protocol (MCP).
1010

11-
**WARNING**: The SDK is currently unstable and subject to breaking changes.
12-
Please test it out and file bug reports or API proposals. The [TODO](#todo)
13-
section below outlines outstanding release blockers. We aim to release a stable
14-
version of the SDK in August, 2025.
11+
**WARNING**: The SDK should be considered unreleased, and is currently unstable
12+
and subject to breaking changes. Please test it out and file bug reports or API
13+
proposals, but don't use it in real projects. See the issue tracker for known
14+
issues and missing features. We aim to release a stable version of the SDK in
15+
August, 2025.
1516

1617
## Package documentation
1718

@@ -40,18 +41,6 @@ with its client over stdin/stdout:
4041

4142
The `examples/` directory contains more example clients and servers.
4243

43-
## TODO
44-
45-
The following TODOs block the release of this SDK:
46-
47-
- Better support for resumability in the Streamable HTTP transport: a
48-
server-side event store and client-side retry configuration.
49-
- OAuth support (or examples of implementing OAuth using middleware).
50-
- Support for the changes in the
51-
[2025-06-18](https://modelcontextprotocol.io/specification/2025-06-18/changelog)
52-
version of the MCP spec.
53-
- More examples and documentation.
54-
5544
## Design
5645

5746
The design doc for this SDK is at [design.md](./design/design.md), which was

mcp/tool.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ type ToolHandlerFor[In, Out any] func(context.Context, *ServerSession, *CallTool
2626
// A rawToolHandler is like a ToolHandler, but takes the arguments as as json.RawMessage.
2727
type rawToolHandler = func(context.Context, *ServerSession, *CallToolParamsFor[json.RawMessage]) (*CallToolResult, error)
2828

29-
// A Tool is a tool definition that is bound to a tool handler.
29+
// A ServerTool is a tool definition that is bound to a tool handler.
3030
type ServerTool struct {
3131
Tool *Tool
3232
Handler ToolHandler
33-
// Set in NewServerTool or Server.AddToolsErr.
33+
// Set in NewServerTool or Server.addToolsErr.
3434
rawHandler rawToolHandler
35-
// Resolved tool schemas. Set in Server.AddToolsErr.
35+
// Resolved tool schemas. Set in Server.addToolsErr.
3636
inputResolved, outputResolved *jsonschema.Resolved
3737
}
3838

mcp/transport.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var ErrConnectionClosed = errors.New("connection closed")
2626
// and server.
2727
//
2828
// Transports should be used for at most one call to [Server.Connect] or
29-
// [Client.Start].
29+
// [Client.Connect].
3030
type Transport interface {
3131
// Connect returns the logical JSON-RPC connection..
3232
//

0 commit comments

Comments
 (0)