Skip to content

docs: Enhance README formatting and fix relative links #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2025
Merged

docs: Enhance README formatting and fix relative links #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0d8ff6
docs: Improve README formatting and internal links
cr2007 Jul 18, 2025
68c8a36
docs: Removes extra 'Warning' word in the beginning
cr2007 Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
15 changes: 8 additions & 7 deletions internal/readme/README.src.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading