使用说明
项目简介
MCP Server Starter 是一个使用 TypeScript 开发的模板项目,旨在帮助开发者快速搭建 模型上下文协议 (MCP) 服务器。MCP 服务器充当 AI 智能体(如 Claude、Cursor 等)和外部工具、数据源之间的桥梁,使得 AI 智能体可以通过标准化的方式调用各种功能和获取信息。
主要功能点
- 资源管理: 支持托管和管理各种数据资源,并提供数据访问能力 (本模板已启用,但需开发者自行实现具体资源管理逻辑)。
- 工具注册与执行: 允许注册和执行外部工具,扩展 AI 智能体的能力,例如本模板中包含了计算器和 REST API 示例工具。
- Prompt 模板: 支持定义和渲染 Prompt 模板,定制 LLM 交互模式 (本模板已启用,但需开发者自行实现具体 Prompt 模板)。
- 流式响应: 支持流式传输响应数据,适用于长时间运行的操作。
- 多种传输协议: 默认使用 Stdio (标准输入输出) 协议,方便本地开发和部署。
- 开发容器: 提供 Dev Containers 配置,一键启动可复现的开发环境。
- 安全实践: 提供输入验证、错误处理、资源管理和 API 安全的最佳实践示例。
安装步骤
-
克隆仓库
git clone https://github.com/TheSethRose/MCP-Server-Starter.git cd MCP-Server-Starter -
安装依赖
npm install -
构建项目
npm run build此命令会将 TypeScript 代码编译为 JavaScript,并生成可执行文件。
服务器配置
MCP 服务器需要配置到 MCP 客户端中才能使用。以下是 MCP 客户端 (如 Cursor, Claude 等) 配置 MCP 服务器时所需提供的 JSON 格式配置信息。你需要根据实际的项目路径调整 'command' 和 'args' 字段。
{ "serverName": "mcp-server-starter", // MCP 服务器名称,可自定义 "command": "node", // 启动 MCP 服务器的命令,这里使用 Node.js 运行 JavaScript "args": [ // 传递给启动命令的参数 "/path/to/your/MCP-Server-Starter/build/index.js" // 指向编译后的服务器入口文件 index.js 的绝对路径。请替换为你的实际路径! ] }
注意:
- 请将 '/path/to/your/MCP-Server-Starter' 替换为你本地仓库的实际绝对路径。
- 'serverName' 可以自定义,用于在 MCP 客户端中标识你的服务器。
- 'command' 和 'args' 指定了如何启动你的 MCP 服务器进程。对于本模板,我们使用 'node' 运行编译后的 'index.js' 文件。
基本使用方法
-
启动 MCP 服务器: 按照上述 安装步骤 完成安装和构建后,当你在 MCP 客户端中配置并连接你的 MCP 服务器后,服务器会在后台运行。
-
在 MCP 客户端中使用工具: 当 MCP 服务器成功连接到客户端后,你就可以在客户端中 (例如在 Claude 的聊天界面或 Cursor 的代码编辑器中) 指示 AI 智能体使用已注册的工具。
例如,本模板预置了两个示例工具:
- 'calculate': 用于执行基本的算术运算 (加、减、乘、除)。
- 'fetch_user': 用于从 JSONPlaceholder API 获取用户数据。
你可以尝试在支持 MCP 的客户端中,引导 AI 智能体使用这些工具,例如:
- 在 Claude 中,你可以提问类似 "请使用 calculate 工具计算 5 加 3 等于多少?" 或 "请使用 fetch_user 工具获取用户 ID 为 1 的用户信息。"
- 在 Cursor 中,你可以在代码编辑过程中,让 AI 助手使用这些工具来辅助编程或获取信息。
-
扩展工具: 你可以参考 'src/examples' 目录下的 'calculator.ts' 和 'rest-api.ts' 示例,开发更多自定义的工具,扩展 MCP 服务器的功能。
通过 MCP Server Starter 模板,你可以快速上手构建自己的 MCP 服务器,为各种 AI 应用提供强大的工具和数据支持。
信息
分类
开发者工具