modelcontextprotocol/go-sdk
Watch
1
0
Fork
You've already forked go-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs: Enhance README formatting and fix relative links (#146)

Browse source 
This PR improves the formatting and internal link structure of both the
main `README.md` and the source file at `internal/readme/README.src.md`.
Changes include:

### 🛠 Changes Made

* Replaced plain-text warning with a GitHub-style admonition block (`>
[!WARNING]`) for improved visibility and consistency with other docs.

Example:

> [!WARNING]
> The SDK should be considered unreleased, and is currently unstable
> and subject to breaking changes. Please test it out and file bug
reports or API
> 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.

* Updated markdown links to use cleaner relative paths:
* Changed `CONTRIBUTING.md` reference to
`[CONTRIBUTING.md](/CONTRIBUTING.md)`
  * Updated `examples/` reference to `[examples/](/examples/)`
* Ensured that all updates were mirrored in both the generated and
source README files.

### 📌 Why It Matters

These changes improve the readability and usability of the
documentation, especially when viewed on GitHub. The updated formatting
helps call attention to important warnings, and fixing relative paths
ensures that links work reliably across platforms and contexts.
This commit is contained in:
CSK 2025-07-18 16:43:47 +04:00 • committed by GitHub
commit d437c81cbe
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -12,11 +12,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details.
This repository contains an unreleased implementation of the official Go
software development kit (SDK) for the Model Context Protocol (MCP).
**WARNING**: The SDK should be considered unreleased, and is currently unstable
and subject to breaking changes. Please test it out and file bug reports or API
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.
> [!WARNING]
> The SDK should be considered unreleased, and is currently unstable
> and subject to breaking changes. Please test it out and file bug reports or API
> 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
@ -28,7 +29,7 @@ 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.
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
## Package documentation
@ -130,7 +131,7 @@ func main() {
}
```
The `examples/` directory contains more example clients and servers.
The [`examples/`](/examples/) directory contains more example clients and servers.
## Acknowledgements

15
internal/readme/README.src.md
View file

@ -11,11 +11,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details.
This repository contains an unreleased implementation of the official Go
software development kit (SDK) for the Model Context Protocol (MCP).
**WARNING**: The SDK should be considered unreleased, and is currently unstable
and subject to breaking changes. Please test it out and file bug reports or API
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.
> [!WARNING]
> The SDK should be considered unreleased, and is currently unstable
> and subject to breaking changes. Please test it out and file bug reports or API
> 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
@ -27,7 +28,7 @@ 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.
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
## Package documentation
@ -58,7 +59,7 @@ with its client over stdin/stdout:
%include server/server.go -
The `examples/` directory contains more example clients and servers.
The [`examples/`](/examples/) directory contains more example clients and servers.
## Acknowledgements