使用说明(Markdown格式)
-
项目简介
- mcpkit 是一个针对 MCP(Model Context Protocol)实现的 Rust 服务器端框架,旨在以标准化方式向 LLM 客户端提供资源、工具和提示等上下文信息,并支持可扩展的传输、路由和会话管理。
-
主要功能点
- 统一的 #[mcp_server] 宏用于在服务器实现中注册工具、资源和提示
- 运行时自适应传输支持:标准输入、WebSocket、HTTP/SSE、Unix 域套接字等
- typestate 构建器(ServerBuilder)确保在编译期正确注册工具、资源、提示等能力
- 面向 MCP 2025-11-25 协议的实现,包含工具调用、资源读取、提示渲染、任务、采样等能力
- 路由与中间件(Tower 风格中间件、可组合的路由器)以模块化方式组织
- 会话管理、能力协商、健康检查等运维友好特性
- 提供测试工具与示例,覆盖服务端行为、健康状态和路由逻辑
-
安装步骤
- 需先安装 Rust 1.85+ 的运行环境
- 在项目的 Cargo.toml 中添加依赖(示例版本基于仓库文档):
- mcpkit = "0.5"
- 运行 cargo build 构建项目
-
服务器配置(MCP 客户端需要的配置信息) 说明:MCP 客户端需要配置的其实是服务器端启动信息,以便建立与 MCP 服务器的连接。以下为可选的服务器可用配置示例信息字段,JSON 格式,字段含义注释见下方注释。 配置示例(JSON): { "server_name": "calculator", "command": "./target/debug/calculator_server", "args": ["--port","12000"] } 说明:
- server_name 表示 MCP 服务器在协议中的名称,用于标识和路由;
- command 指定运行服务器的可执行文件路径(如服务器程序二进制);
- args 为启动服务器的命令行参数,按需要传入端口、配置项等。 备注:该配置仅用于描述服务器启动信息,MCP 客户端在实际使用中并不需要直接依赖该配置代码;客户端通常通过传输通道与服务器交互。
-
基本使用方法
- 通过 #[mcp_server] 宏在实现中注册工具、资源、提示,构建 Server,通过 transport 接入网络或标准输入输出,与 MCP 客户端进行交互
- 运行示例通常包含:实现服务器、使用 ServerBuilder 注册所需能力、选择传输层并启动服务
- 通过服务器提供的路由,客户端可以请求工具列表、调用工具、获取资源、获取提示等
-
其他说明
- 该仓库提供多种传输适配和中间件能力,便于在不同运行时环境(Tokio、smol 等)中使用
- 提供健康检查、指标、路由和测试工具,方便集成与运维
关键词: 上下文服务, 资源管理, 工具执行, 提示渲染, 传输中间件, 任务与采样, 会话管理
信息
分类
AI与计算