Skip to content

Commit e68b15e

Browse files
authored
docs: add prose documentation for core features to meet conformance (#702)
* docs: add prose documentation for core features to meet conformance * docs: remove static coverage badge and svg * docs: rewrite Chinese README to match current English README
1 parent 9865385 commit e68b15e

5 files changed

Lines changed: 830 additions & 29 deletions

File tree

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<div align = "right">
2-
<a href="docs/readme/README.zh-cn.md">简体中文(待更新)</a>
2+
<a href="docs/readme/README.zh-cn.md">简体中文</a>
33
</div>
44

55
# RMCP
66
[![Crates.io Version](https://img.shields.io/crates/v/rmcp)](https://crates.io/crates/rmcp)
7-
<!-- ![Release status](https://github.com/modelcontextprotocol/rust-sdk/actions/workflows/release.yml/badge.svg) -->
8-
<!-- [![docs.rs](todo)](todo) -->
9-
![Coverage](docs/coverage.svg)
7+
[![docs.rs](https://img.shields.io/docsrs/rmcp)](https://docs.rs/rmcp/latest/rmcp)
8+
[![CI](https://github.com/modelcontextprotocol/rust-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/modelcontextprotocol/rust-sdk/actions/workflows/ci.yml)
9+
[![License](https://img.shields.io/crates/l/rmcp)](LICENSE)
1010

1111
An official Rust Model Context Protocol SDK implementation with tokio async runtime.
1212

@@ -20,7 +20,7 @@ This repository contains the following crates:
2020
### Import the crate
2121

2222
```toml
23-
rmcp = { version = "0.8.0", features = ["server"] }
23+
rmcp = { version = "0.16.0", features = ["server"] }
2424
## or dev channel
2525
rmcp = { git = "https://github.com/modelcontextprotocol/rust-sdk", branch = "main" }
2626
```
@@ -111,6 +111,10 @@ let quit_reason = server.cancel().await?;
111111

112112
See [examples](examples/README.md).
113113

114+
## Feature Documentation
115+
116+
See [docs/FEATURES.md](docs/FEATURES.md) for detailed documentation on core MCP features: resources, prompts, sampling, roots, logging, completions, notifications, and subscriptions.
117+
114118
## OAuth Support
115119

116120
See [Oauth_support](docs/OAUTH_SUPPORT.md) for details.
@@ -129,6 +133,8 @@ See [Oauth_support](docs/OAUTH_SUPPORT.md) for details.
129133

130134
### Built with `rmcp`
131135

136+
- [goose](https://github.com/block/goose) - An open-source, extensible AI agent that goes beyond code suggestions
137+
- [apollo-mcp-server](https://github.com/apollographql/apollo-mcp-server) - MCP server that connects AI agents to GraphQL APIs via Apollo GraphOS
132138
- [rustfs-mcp](https://github.com/rustfs/rustfs/tree/main/crates/mcp) - High-performance MCP server providing S3-compatible object storage operations for AI/LLM integration
133139
- [containerd-mcp-server](https://github.com/jokemanfire/mcp-containerd) - A containerd-based MCP server implementation
134140
- [rmcp-openapi-server](https://gitlab.com/lx-industries/rmcp-openapi/-/tree/main/crates/rmcp-openapi-server) - High-performance MCP server that exposes OpenAPI definition endpoints as MCP tools

crates/rmcp/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
191191
}
192192
```
193193

194-
For more examples, see the [examples directory](https://github.com/anthropics/mcp-rust-sdk/tree/main/examples) in the repository.
194+
For more examples, see the [examples directory](https://github.com/modelcontextprotocol/rust-sdk/tree/main/examples) in the repository.
195+
196+
For detailed documentation on core MCP features (resources, prompts, sampling, roots, logging, completions, notifications, subscriptions), see [FEATURES.md](https://github.com/modelcontextprotocol/rust-sdk/blob/main/docs/FEATURES.md).
195197

196198
## Transport Options
197199

0 commit comments

Comments
 (0)