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
This commit is contained in:
Dale Seo
GitHub
parent
98653855ef
commit
e68b15e600
1 changed files with 830 additions and 29 deletions
|
|
@ -1,32 +1,41 @@
|
|||
<div align = "right">
|
||||
<a href="../../README.md">English</a>
|
||||
</div>
|
||||
|
||||
# RMCP
|
||||
[](https://crates.io/crates/rmcp)
|
||||
|
||||
[](https://docs.rs/rmcp/latest/rmcp)
|
||||
[](https://github.com/modelcontextprotocol/rust-sdk/actions/workflows/ci.yml)
|
||||
[](../../LICENSE)
|
||||
|
||||
一个基于 tokio 异步运行时的官方 Model Context Protocol SDK 实现。
|
||||
一个基于 tokio 异步运行时的官方 Rust Model Context Protocol SDK 实现。
|
||||
|
||||
本项目使用了以下开源库:
|
||||
本仓库包含以下 crate：
|
||||
|
||||
- [rmcp](crates/rmcp): 实现 RMCP 协议的核心库 (详见：[rmcp](crates/rmcp/README.md))
|
||||
- [rmcp-macros](crates/rmcp-macros): 一个用于生成 RMCP 工具实现的过程宏库。 (详见：[rmcp-macros](crates/rmcp-macros/README.md))
|
||||
- [rmcp](../../crates/rmcp)：实现 RMCP 协议的核心库 - 详见 [rmcp](../../crates/rmcp/README.md)
|
||||
- [rmcp-macros](../../crates/rmcp-macros)：用于生成 RMCP 工具实现的过程宏库 - 详见 [rmcp-macros](../../crates/rmcp-macros/README.md)
|
||||
|
||||
## 使用
|
||||
|
||||
### 导入
|
||||
|
||||
```toml
|
||||
rmcp = { version = "0.2.0", features = ["server"] }
|
||||
rmcp = { version = "0.16.0", features = ["server"] }
|
||||
## 或使用最新开发版本
|
||||
rmcp = { git = "https://github.com/modelcontextprotocol/rust-sdk", branch = "main" }
|
||||
```
|
||||
### 第三方依赖
|
||||
|
||||
### 第三方依赖库
|
||||
基本依赖:
|
||||
- [tokio required](https://github.com/tokio-rs/tokio)
|
||||
- [serde required](https://github.com/serde-rs/serde)
|
||||
基本依赖：
|
||||
- [tokio](https://github.com/tokio-rs/tokio)
|
||||
- [serde](https://github.com/serde-rs/serde)
|
||||
JSON Schema 生成 (version 2020-12)：
|
||||
- [schemars](https://github.com/GREsau/schemars)
|
||||
|
||||
### 构建客户端
|
||||
|
||||
<details>
|
||||
<summary>构建客户端</summary>
|
||||
<summary>启动客户端</summary>
|
||||
|
||||
```rust, ignore
|
||||
use rmcp::{ServiceExt, transport::{TokioChildProcess, ConfigureCommandExt}};
|
||||
|
|
@ -57,7 +66,7 @@ let transport = (stdin(), stdout());
|
|||
<details>
|
||||
<summary>构建服务</summary>
|
||||
|
||||
You can easily build a service by using [`ServerHandler`](crates/rmcp/src/handler/server.rs) or [`ClientHandler`](crates/rmcp/src/handler/client.rs).
|
||||
你可以通过 [`ServerHandler`](../../crates/rmcp/src/handler/server.rs) 或 [`ClientHandler`](../../crates/rmcp/src/handler/client.rs) 轻松构建服务。
|
||||
|
||||
```rust, ignore
|
||||
let service = common::counter::Counter::new();
|
||||
|
|
@ -68,7 +77,7 @@ let service = common::counter::Counter::new();
|
|||
<summary>启动服务端</summary>
|
||||
|
||||
```rust, ignore
|
||||
// this call will finish the initialization process
|
||||
// 此调用将完成初始化过程
|
||||
let server = service.serve(transport).await?;
|
||||
```
|
||||
</details>
|
||||
|
|
@ -76,13 +85,13 @@ let server = service.serve(transport).await?;
|
|||
<details>
|
||||
<summary>与服务端交互</summary>
|
||||
|
||||
Once the server is initialized, you can send requests or notifications:
|
||||
服务端初始化完成后，你可以发送请求或通知：
|
||||
|
||||
```rust, ignore
|
||||
// request
|
||||
// 请求
|
||||
let roots = server.list_roots().await?;
|
||||
|
||||
// or send notification
|
||||
// 或发送通知
|
||||
server.notify_cancelled(...).await?;
|
||||
```
|
||||
</details>
|
||||
|
|
@ -97,27 +106,54 @@ let quit_reason = server.cancel().await?;
|
|||
```
|
||||
</details>
|
||||
|
||||
### 示例
|
||||
查看 [examples](examples/README.md)
|
||||
|
||||
## 示例
|
||||
|
||||
查看 [examples](../../examples/README.md)。
|
||||
|
||||
## 功能文档
|
||||
|
||||
查看 [docs/FEATURES.md](../FEATURES.md) 了解核心 MCP 功能的详细文档：资源、提示词、采样、根目录、日志、补全、通知和订阅。
|
||||
|
||||
## OAuth 支持
|
||||
|
||||
查看 [oauth_support](docs/OAUTH_SUPPORT.md)
|
||||
查看 [OAuth 支持](../OAUTH_SUPPORT.md) 了解详情。
|
||||
|
||||
## 相关资源
|
||||
|
||||
- [MCP Specification](https://modelcontextprotocol.io/specification/2025-11-25)
|
||||
- [MCP 规范](https://modelcontextprotocol.io/specification/2025-11-25)
|
||||
- [Schema](https://github.com/modelcontextprotocol/specification/blob/main/schema/2025-11-25/schema.ts)
|
||||
|
||||
## 相关项目
|
||||
|
||||
### 扩展 `rmcp`
|
||||
|
||||
- [rmcp-actix-web](https://gitlab.com/lx-industries/rmcp-actix-web) - 基于 `actix_web` 的 `rmcp` 后端
|
||||
- [rmcp-openapi](https://gitlab.com/lx-industries/rmcp-openapi) - 将 OpenAPI 定义的端点转换为 MCP 工具
|
||||
|
||||
### 基于 `rmcp` 构建
|
||||
|
||||
- [goose](https://github.com/block/goose) - 一个超越代码建议的开源、可扩展 AI 智能体
|
||||
- [apollo-mcp-server](https://github.com/apollographql/apollo-mcp-server) - 通过 Apollo GraphOS 将 AI 智能体连接到 GraphQL API 的 MCP 服务
|
||||
- [rustfs-mcp](https://github.com/rustfs/rustfs/tree/main/crates/mcp) - 为 AI/LLM 集成提供 S3 兼容对象存储操作的高性能 MCP 服务
|
||||
- [containerd-mcp-server](https://github.com/jokemanfire/mcp-containerd) - 基于 containerd 实现的 MCP 服务
|
||||
- [rmcp-openapi-server](https://gitlab.com/lx-industries/rmcp-openapi/-/tree/main/crates/rmcp-openapi-server) - 将 OpenAPI 定义的端点暴露为 MCP 工具的高性能 MCP 服务
|
||||
- [nvim-mcp](https://github.com/linw1995/nvim-mcp) - 与 Neovim 交互的 MCP 服务
|
||||
- [terminator](https://github.com/mediar-ai/terminator) - AI 驱动的桌面自动化 MCP 服务，支持跨平台，成功率超过 95%
|
||||
- [stakpak-agent](https://github.com/stakpak/agent) - 安全加固的 DevOps 终端智能体，支持 MCP over mTLS、流式传输、密钥令牌化和异步任务管理
|
||||
- [video-transcriber-mcp-rs](https://github.com/nhatvu148/video-transcriber-mcp-rs) - 使用 whisper.cpp 从 1000+ 平台转录视频的高性能 MCP 服务
|
||||
- [NexusCore MCP](https://github.com/sjkim1127/Nexuscore_MCP) - 具有 Frida 集成和隐蔽脱壳功能的高级恶意软件分析与动态检测 MCP 服务
|
||||
- [spreadsheet-mcp](https://github.com/PSU3D0/spreadsheet-mcp) - 面向 LLM 智能体的高效 Token 使用的电子表格分析 MCP 服务，支持自动区域检测、重新计算、截图和编辑
|
||||
- [hyper-mcp](https://github.com/hyper-mcp-rs/hyper-mcp) - 通过 WebAssembly (WASM) 插件扩展功能的快速、安全的 MCP 服务
|
||||
- [rudof-mcp](https://github.com/rudof-project/rudof/tree/master/rudof_mcp) - RDF 验证和数据处理 MCP 服务，支持 ShEx/SHACL 验证、SPARQL 查询和格式转换。支持 stdio 和 Streamable HTTP 传输，具备完整的 MCP 功能（工具、提示词、资源、日志、补全、任务）
|
||||
|
||||
|
||||
## 开发
|
||||
|
||||
### 贡献指南
|
||||
|
||||
查看 [docs/CONTRIBUTE.MD](docs/CONTRIBUTE.MD)
|
||||
查看 [docs/CONTRIBUTE.MD](../CONTRIBUTE.MD) 获取贡献提示。
|
||||
|
||||
### 使用 Dev Container
|
||||
|
||||
如果你想使用 Dev Container，查看 [docs/DEVCONTAINER.md](docs/DEVCONTAINER.md) 获取开发指南。
|
||||
如果你想使用 Dev Container，查看 [docs/DEVCONTAINER.md](../DEVCONTAINER.md) 获取开发指南。
|
||||
|
|
|
|||
Loading…
Reference in a new issue