使用说明
MCP服务器模板🚀
一个干净的建筑模板 模型上下文协议(MCP) 服务器。
什么是MCP?
模型上下文协议(MCP)是Anthropic开发的一个开放标准,它使像Claude这样的人工智能系统能够与各种数据源和工具无缝交互,促进安全的双向连接。
此模板为构建自己的MCP服务器提供了一个起点,该服务器可以与Claude Desktop、Cursor或任何其他MCP客户端一起使用。
模板功能
此模板包括:
- MCP SDK的基本服务器结构
- 带有注释占位符的示例工具定义
- 处理设置时出错
- 通过dotenv配置环境变量
先决条件🔧
在开始之前,请确保您已经:
- 您包装的任何服务的API密钥(如果适用)
- Node.js(v20或更高版本)
- 像Claude Desktop或Cursor这样的MCP客户端
安装⚡
- 克隆此模板存储库:
git clone https://github.com/yourusername/mcp-server-template.git
cd mcp-server-template
- 安装依赖项:
npm install
- 构建项目:
npm run build
定制指南🔧
要为您自己的MCP服务器自定义此模板,请执行以下操作:
- 更新
package.json包含您的服务器名称和详细信息 - 修改
src/index.ts致:- 定义API响应接口
- 添加您的实际工具及其模式
- 实现工具功能
- 更新格式化逻辑
要修改的关键文件
src/index.ts:主服务器实现package.json:包元数据和依赖关系.env:创建此文件以存储API密钥(请确保添加到.gignore)
运行服务器🖥️
您可以直接使用以下命令运行服务器:
npm run build
node build/index.js
与MCP客户端集成
配置Claude Desktop应用程序
对于macOS:
# Create the config file if it doesn't exist
touch "$HOME/Library/Application Support/Claude/claude_desktop_config.json"
# Open the config file in TextEdit
open -e "$HOME/Library/Application Support/Claude/claude_desktop_config.json"
对于Windows:
code %APPDATA%\Claude\claude_desktop_config.json
添加您的服务器配置:
{
"mcpServers": {
"your-server-name": {
"command": "node",
"args": ["/path/to/your/build/index.js"],
"env": {
"YOUR_API_KEY": "your-api-key-here"
}
}
}
}
配置光标
- 打开光标设置
- 导航到功能>MCP服务器
- 点击“+添加新MCP服务器”按钮
- 填写以下信息:
- 名称:输入服务器的昵称(例如“您的服务器名称”)
- 类型:选择“command”作为类型
- 命令:输入运行服务器的命令:
env YOUR_API_KEY=your-api-key node /path/to/your/build/index.js
模板结构说明
- 服务器安装程序:该模板创建了一个具有stdio传输的基本MCP服务器
- 工具定义:带有注释占位符的示例工具模式
- 错误处理:使用控制台日志记录的基本错误处理设置
- 请求处理:用于处理具有开关/案例结构的工具请求的模板
贡献
请随意将此模板用作您自己的MCP服务器的起点。如果你改进了模板,请考虑通过pull请求回馈!
致谢✨
- 模型上下文协议 对于MCP规范
- 克劳德桌面的拟人化
- Tavily MCP服务器 此模板基于