docs: add GitHub discussions to README.md and CONTRIBUTING.md (#49)
Also, update a pkgsite link in the README.
This commit is contained in:
parent
ff0d746521
commit
0e2abbb107
1 changed files with 35 additions and 26 deletions
|
|
@ -1,9 +1,6 @@
|
|||
# MCP Go SDK
|
||||
|
||||
<!-- TODO: update pkgsite links here to point to the modelcontextprotocol
|
||||
module, once it exists. -->
|
||||
|
||||
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
|
||||
[](https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk)
|
||||
|
||||
This repository contains an unreleased implementation of the official Go
|
||||
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
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
## 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
|
||||
|
||||
Several existing Go MCP SDKs inspired the development and design of this
|
||||
|
|
|
|||
Loading…
Reference in a new issue