Skip to content

Commit 0e2abbb

Browse files
authored
docs: add GitHub discussions to README.md and CONTRIBUTING.md (#49)
Also, update a pkgsite link in the README.
1 parent ff0d746 commit 0e2abbb

File tree

3 files changed

+35
-26
lines changed

3 files changed

+35
-26
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,15 @@ This process is similar to the [Go proposal
6868
process](https://github.com/golang/proposal), but is necessarily lighter weight
6969
to accommodate the greater rate of change expected for the SDK.
7070

71+
### Design discussion
72+
73+
For open ended design discussion (anything that doesn't fall into the issue
74+
categories above), use [GitHub
75+
Discussions](https://github.com/modelcontextprotocol/go-sdk/discussions).
76+
Ideally, each discussion should be focused on one aspect of the design. For
77+
example: Tool Binding and Session APIs would be two separate discussions.
78+
When discussions reach a consensus, they should be promoted into proposals.
79+
7180
## Contributing code
7281

7382
The project uses GitHub pull requests (PRs) to review changes.

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
<!-- Autogenerated by weave; DO NOT EDIT -->
22
# MCP Go SDK
33

4-
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol
5-
module, once it exists. -->
6-
7-
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
4+
[![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
85

96
This repository contains an unreleased implementation of the official Go
107
software development kit (SDK) for the Model Context Protocol (MCP).
@@ -15,6 +12,18 @@ proposals, but don't use it in real projects. See the issue tracker for known
1512
issues and missing features. We aim to release a stable version of the SDK in
1613
August, 2025.
1714

15+
## Design
16+
17+
The design doc for this SDK is at [design.md](./design/design.md), which was
18+
initially reviewed at
19+
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
20+
21+
Further design discussion should occur in
22+
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
23+
proposals) or
24+
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
25+
open-ended discussion. See CONTRIBUTING.md for details.
26+
1827
## Package documentation
1928

2029
The SDK consists of two importable packages:
@@ -116,15 +125,6 @@ func main() {
116125

117126
The `examples/` directory contains more example clients and servers.
118127

119-
## Design
120-
121-
The design doc for this SDK is at [design.md](./design/design.md), which was
122-
initially reviewed at
123-
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
124-
125-
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
126-
for details.
127-
128128
## Acknowledgements
129129

130130
Several existing Go MCP SDKs inspired the development and design of this

internal/readme/README.src.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# MCP Go SDK
22

3-
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol
4-
module, once it exists. -->
5-
6-
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
3+
[![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
74

85
This repository contains an unreleased implementation of the official Go
96
software development kit (SDK) for the Model Context Protocol (MCP).
@@ -14,6 +11,18 @@ proposals, but don't use it in real projects. See the issue tracker for known
1411
issues and missing features. We aim to release a stable version of the SDK in
1512
August, 2025.
1613

14+
## Design
15+
16+
The design doc for this SDK is at [design.md](./design/design.md), which was
17+
initially reviewed at
18+
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
19+
20+
Further design discussion should occur in
21+
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
22+
proposals) or
23+
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
24+
open-ended discussion. See CONTRIBUTING.md for details.
25+
1726
## Package documentation
1827

1928
The SDK consists of two importable packages:
@@ -41,15 +50,6 @@ with its client over stdin/stdout:
4150

4251
The `examples/` directory contains more example clients and servers.
4352

44-
## Design
45-
46-
The design doc for this SDK is at [design.md](./design/design.md), which was
47-
initially reviewed at
48-
[modelcontextprotocol/discussions/364](https://github.com/orgs/modelcontextprotocol/discussions/364).
49-
50-
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
51-
for details.
52-
5353
## Acknowledgements
5454

5555
Several existing Go MCP SDKs inspired the development and design of this

0 commit comments

Comments
 (0)