Skip to content

Commit 84a568b

Browse files
authored
readme: update README for v0.6.0 (#506)
Also significantly lessen our warnings, and note that this is a release candidate, rewrite Acknowledgements to be Acknowledgements / Alternatives, since other MCP SDKs continue to be actively developed.
1 parent 8b6391b commit 84a568b

File tree

4 files changed

+56
-62
lines changed

4 files changed

+56
-62
lines changed

README.md

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
<!-- Autogenerated by weave; DO NOT EDIT -->
2-
# MCP Go SDK v0.5.0
2+
# MCP Go SDK v0.6.0
33

44
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/modelcontextprotocol/go-sdk)
55

66
***BREAKING CHANGES***
77

8-
This version contains breaking changes.
8+
This version contains minor breaking changes.
99
See the [release notes](
10-
https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.5.0) for details.
10+
https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.6.0) for details.
1111

1212
[![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
1313

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

17-
> [!WARNING]
18-
> The SDK is not yet at v1.0.0 and may still be subject to incompatible API
19-
> changes. We aim to tag v1.0.0 in September, 2025. See
20-
> https://github.com/modelcontextprotocol/go-sdk/issues/328 for details.
17+
> [!IMPORTANT]
18+
> The SDK is in release-candidate state, and is going to be tagged v1.0.0
19+
> soon (see https://github.com/modelcontextprotocol/go-sdk/issues/328).
20+
> We do not anticipate significant API changes or instability. Please use it
21+
> and [file issues](https://github.com/modelcontextprotocol/go-sdk/issues/new/choose).
2122
22-
## Package documentation
23+
## Package / Feature documentation
2324

2425
The SDK consists of several importable packages:
2526

@@ -33,11 +34,13 @@ The SDK consists of several importable packages:
3334
- The
3435
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
3536
package provides some primitives for supporting oauth.
36-
3737
- The
3838
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
3939
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
4040

41+
The SDK endeavors to implement the full MCP spec. The [`docs/`](/docs/) directory
42+
contains feature documentation, mapping the MCP spec to the packages above.
43+
4144
## Getting started
4245

4346
To get started creating an MCP server, create an `mcp.Server` instance, add
@@ -78,9 +81,9 @@ func main() {
7881
}
7982
```
8083

81-
To communicate with that server, we can similarly create an `mcp.Client` and
82-
connect it to the corresponding server, by running the server command and
83-
communicating over its stdin/stdout:
84+
To communicate with that server, create an `mcp.Client` and connect it to the
85+
corresponding server, by running the server command and communicating over its
86+
stdin/stdout:
8487

8588
```go
8689
package main
@@ -128,24 +131,18 @@ func main() {
128131
The [`examples/`](/examples/) directory contains more example clients and
129132
servers.
130133

131-
## Design
132-
133-
The design doc for this SDK is at [design.md](./design/design.md), which was
134-
initially reviewed at
135-
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
134+
## Contributing
136135

137-
Further design discussion should occur in
138-
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
139-
proposals) or
140-
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
141-
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
136+
We welcome contributions to the SDK! Please see See
137+
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
142138

143-
## Acknowledgements
139+
## Acknowledgements / Alternatives
144140

145-
Several existing Go MCP SDKs inspired the development and design of this
146-
official SDK, notably [mcp-go](https://github.com/mark3labs/mcp-go), authored
147-
by Ed Zynda. We are grateful to Ed as well as the other contributors to mcp-go,
148-
and to authors and contributors of other SDKs such as
141+
Several third party Go MCP SDKs inspired the development and design of this
142+
official SDK, and continue to be viable alternatives, notably
143+
[mcp-go](https://github.com/mark3labs/mcp-go), originally authored by Ed Zynda.
144+
We are grateful to Ed as well as the other contributors to mcp-go, and to
145+
authors and contributors of other SDKs such as
149146
[mcp-golang](https://github.com/metoro-io/mcp-golang) and
150147
[go-mcp](https://github.com/ThinkInAIXYZ/go-mcp). Thanks to their work, there
151148
is a thriving ecosystem of Go MCP clients and servers.

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!-- Autogenerated by weave; DO NOT EDIT -->
2-
These docs are a work-in-progress.
3-
42
# Features
53

64
These docs mirror the [official MCP spec](https://modelcontextprotocol.io/specification/2025-06-18).
5+
Use the index below to learn how the SDK implements a particular aspect of the
6+
protocol.
77

88
## Base Protocol
99

internal/docs/README.src.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
These docs are a work-in-progress.
2-
31
# Features
42

53
These docs mirror the [official MCP spec](https://modelcontextprotocol.io/specification/2025-06-18).
4+
Use the index below to learn how the SDK implements a particular aspect of the
5+
protocol.
66

77
## Base Protocol
88

internal/readme/README.src.md

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
# MCP Go SDK v0.5.0
1+
# MCP Go SDK v0.6.0
22

33
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/modelcontextprotocol/go-sdk)
44

55
***BREAKING CHANGES***
66

7-
This version contains breaking changes.
7+
This version contains minor breaking changes.
88
See the [release notes](
9-
https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.5.0) for details.
9+
https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.6.0) for details.
1010

1111
[![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
1212

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

16-
> [!WARNING]
17-
> The SDK is not yet at v1.0.0 and may still be subject to incompatible API
18-
> changes. We aim to tag v1.0.0 in September, 2025. See
19-
> https://github.com/modelcontextprotocol/go-sdk/issues/328 for details.
16+
> [!IMPORTANT]
17+
> The SDK is in release-candidate state, and is going to be tagged v1.0.0
18+
> soon (see https://github.com/modelcontextprotocol/go-sdk/issues/328).
19+
> We do not anticipate significant API changes or instability. Please use it
20+
> and [file issues](https://github.com/modelcontextprotocol/go-sdk/issues/new/choose).
2021
21-
## Package documentation
22+
## Package / Feature documentation
2223

2324
The SDK consists of several importable packages:
2425

@@ -32,11 +33,13 @@ The SDK consists of several importable packages:
3233
- The
3334
[`github.com/modelcontextprotocol/go-sdk/auth`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/auth)
3435
package provides some primitives for supporting oauth.
35-
3636
- The
3737
[`github.com/modelcontextprotocol/go-sdk/oauthex`](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk/oauthex)
3838
package provides extensions to the OAuth protocol, such as ProtectedResourceMetadata.
3939

40+
The SDK endeavors to implement the full MCP spec. The [`docs/`](/docs/) directory
41+
contains feature documentation, mapping the MCP spec to the packages above.
42+
4043
## Getting started
4144

4245
To get started creating an MCP server, create an `mcp.Server` instance, add
@@ -46,33 +49,27 @@ stdin/stdout:
4649

4750
%include server/server.go -
4851

49-
To communicate with that server, we can similarly create an `mcp.Client` and
50-
connect it to the corresponding server, by running the server command and
51-
communicating over its stdin/stdout:
52+
To communicate with that server, create an `mcp.Client` and connect it to the
53+
corresponding server, by running the server command and communicating over its
54+
stdin/stdout:
5255

5356
%include client/client.go -
5457

5558
The [`examples/`](/examples/) directory contains more example clients and
5659
servers.
5760

58-
## Design
59-
60-
The design doc for this SDK is at [design.md](./design/design.md), which was
61-
initially reviewed at
62-
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
61+
## Contributing
6362

64-
Further design discussion should occur in
65-
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
66-
proposals) or
67-
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
68-
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
63+
We welcome contributions to the SDK! Please see See
64+
[CONTRIBUTING.md](/CONTRIBUTING.md) for details of how to contribute.
6965

70-
## Acknowledgements
66+
## Acknowledgements / Alternatives
7167

72-
Several existing Go MCP SDKs inspired the development and design of this
73-
official SDK, notably [mcp-go](https://github.com/mark3labs/mcp-go), authored
74-
by Ed Zynda. We are grateful to Ed as well as the other contributors to mcp-go,
75-
and to authors and contributors of other SDKs such as
68+
Several third party Go MCP SDKs inspired the development and design of this
69+
official SDK, and continue to be viable alternatives, notably
70+
[mcp-go](https://github.com/mark3labs/mcp-go), originally authored by Ed Zynda.
71+
We are grateful to Ed as well as the other contributors to mcp-go, and to
72+
authors and contributors of other SDKs such as
7673
[mcp-golang](https://github.com/metoro-io/mcp-golang) and
7774
[go-mcp](https://github.com/ThinkInAIXYZ/go-mcp). Thanks to their work, there
7875
is a thriving ecosystem of Go MCP clients and servers.

0 commit comments

Comments
 (0)