使用说明
项目简介
'mcp-rs-template' 是一个使用 Rust 语言开发的 MCP (Model Context Protocol) 服务器 CLI 模板。它旨在帮助开发者快速搭建 MCP 服务器,以便为 LLM (大型语言模型) 应用提供上下文数据、工具调用和 Prompt 管理等功能。
主要功能点
- 资源管理: 提供资源列表和读取功能,允许 LLM 访问外部数据。
- Prompt 模板管理: 提供 Prompt 模板列表和获取功能,支持定制化的 LLM 交互模式。
- 工具注册与执行: 支持注册和调用外部工具,扩展 LLM 的能力。
- JSON-RPC 通信: 使用 JSON-RPC 协议与 MCP 客户端通信。
- 能力声明: 声明服务器支持的 MCP 功能。
安装步骤
- 克隆仓库: 打开终端,执行命令 'git clone https://github.com/linux-china/mcp-rs-template'
- 修改项目信息: 编辑 'Cargo.toml' 文件,修改 '[package]' 部分的项目名称 ('name')、版本 ('version')、作者 ('authors') 等信息。同时,修改 'src/mcp/mod.rs' 文件中的 'SERVER_NAME' 和 'SERVER_VERSION' 常量。
- 修改服务器处理逻辑: 根据实际需求,修改以下文件中的代码,实现具体的资源、Prompt 和工具处理逻辑:
- 'src/mcp/prompts.rs': 处理 Prompt 相关的请求。
- 'src/mcp/resources.rs': 处理资源相关的请求。
- 'src/mcp/tools.rs': 处理工具相关的请求。
- 可选 - 修改 JSON 模板文件: 如果希望使用 JSON 文件管理 Prompts、Resources 和 Tools,可以修改 'src/mcp/templates' 目录下的 JSON 文件。
- 编译项目: 在项目根目录下,执行命令 'cargo build --release' 编译项目,生成可执行文件。
服务器配置
对于 MCP 客户端 (例如 Claude Desktop),需要在其配置文件中添加 MCP 服务器的配置信息。以下是一个示例配置,用于 Claude Desktop 的 'claude_desktop_config.json' 文件:
{ "mcpServers": { "current-time": { "command": "path/to/mcp-rs-template", // 将 "path/to/mcp-rs-template" 替换为编译后的 mcp-rs-template 可执行文件的实际路径 "args": [ "--mcp" // 启用 MCP 服务器模式,使服务器作为 MCP 服务器运行 ], "env": { "API_KEY": "xxxx" // (可选) 环境变量,例如 API 密钥,根据服务器具体需求配置 } } } }
请注意:
- 'command' 字段需要配置为编译后 'mcp-rs-template' 可执行文件的绝对路径。
- 'args' 字段中的 '--mcp' 参数是必需的,用于启动 MCP 服务器模式。
- 'env' 字段用于设置服务器运行所需的环境变量,根据服务器的具体功能可能需要配置,例如 API 密钥等。如果不需要环境变量,可以删除 'env' 字段。
基本使用方法
- 启动服务器: 在终端中,导航到项目根目录,并执行编译后生成的可执行文件 (例如 'target/release/mcp-rs-template'),并带上 '--mcp' 参数,例如:'./target/release/mcp-rs-template --mcp'。
- 配置 MCP 客户端: 根据 MCP 客户端 (如 Claude Desktop) 的文档,配置连接到 'mcp-rs-template' 服务器。通常需要提供服务器名称、启动命令和参数等信息,参考上面的服务器配置示例。
- 客户端与服务器交互: 配置完成后,MCP 客户端将能够通过 JSON-RPC 协议与 'mcp-rs-template' 服务器进行通信,并利用服务器提供的资源、Prompt 和工具功能。
信息
分类
开发者工具