docs: add GitHub discussions to README.md and CONTRIBUTING.md (#49)

Also, update a pkgsite link in the README.
This commit is contained in:
Robert Findley 2025-06-26 09:37:21 -04:00 • committed by GitHub
commit 0e2abbb107
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 35 additions and 26 deletions

View file

@ -68,6 +68,15 @@ This process is similar to the [Go proposal
process](https://github.com/golang/proposal), but is necessarily lighter weight process](https://github.com/golang/proposal), but is necessarily lighter weight
to accommodate the greater rate of change expected for the SDK. to accommodate the greater rate of change expected for the SDK.
### Design discussion
For open ended design discussion (anything that doesn't fall into the issue
categories above), use [GitHub
Discussions](https://github.com/modelcontextprotocol/go-sdk/discussions).
Ideally, each discussion should be focused on one aspect of the design. For
example: Tool Binding and Session APIs would be two separate discussions.
When discussions reach a consensus, they should be promoted into proposals.
## Contributing code ## Contributing code
The project uses GitHub pull requests (PRs) to review changes. The project uses GitHub pull requests (PRs) to review changes.

View file

@ -1,10 +1,7 @@
<!-- Autogenerated by weave; DO NOT EDIT --> <!-- Autogenerated by weave; DO NOT EDIT -->
# MCP Go SDK # MCP Go SDK
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol [![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
module, once it exists. -->
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
This repository contains an unreleased implementation of the official Go This repository contains an unreleased implementation of the official Go
software development kit (SDK) for the Model Context Protocol (MCP). 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
issues and missing features. We aim to release a stable version of the SDK in issues and missing features. We aim to release a stable version of the SDK in
August, 2025. August, 2025.
## Design
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).
Further design discussion should occur in
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
proposals) or
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
open-ended discussion. See CONTRIBUTING.md for details.
## Package documentation ## Package documentation
The SDK consists of two importable packages: The SDK consists of two importable packages:
@ -116,15 +125,6 @@ func main() {
The `examples/` directory contains more example clients and servers. The `examples/` directory contains more example clients and servers.
## Design
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).
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
for details.
## Acknowledgements ## Acknowledgements
Several existing Go MCP SDKs inspired the development and design of this Several existing Go MCP SDKs inspired the development and design of this

View file

@ -1,9 +1,6 @@
# MCP Go SDK # MCP Go SDK
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol [![PkgGoDev](https://pkg.go.dev/badge/github.com/modelcontextprotocol/go-sdk)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
module, once it exists. -->
[![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools)](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
This repository contains an unreleased implementation of the official Go This repository contains an unreleased implementation of the official Go
software development kit (SDK) for the Model Context Protocol (MCP). 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
issues and missing features. We aim to release a stable version of the SDK in issues and missing features. We aim to release a stable version of the SDK in
August, 2025. August, 2025.
## Design
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).
Further design discussion should occur in
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
proposals) or
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
open-ended discussion. See CONTRIBUTING.md for details.
## Package documentation ## Package documentation
The SDK consists of two importable packages: The SDK consists of two importable packages:
@ -41,15 +50,6 @@ with its client over stdin/stdout:
The `examples/` directory contains more example clients and servers. The `examples/` directory contains more example clients and servers.
## Design
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).
Further design discussion should occur in GitHub issues. See CONTRIBUTING.md
for details.
## Acknowledgements ## Acknowledgements
Several existing Go MCP SDKs inspired the development and design of this Several existing Go MCP SDKs inspired the development and design of this