MCP Server Template

🚀 MCP 服务器模板 🛠️

本项目是一个用于构建您自己的模型上下文协议（MCP）服务器的起始模板。它提供了创建自定义 MCP 所需的基本结构和设置，这些 MCP 可用于与 Cursor 或 Claude Desktop 协同工作，助力开发者快速搭建相关服务器。

✨ 主要特性

• 采用 TypeScript 进行基本 MCP 服务器设置。
• 包含样本工具实现，方便开发者参考。
• 拥有立即可用的项目结构，节省开发时间。
• 基于 @modelcontextprotocol/sdk 构建。

📦 安装指南

克隆此模板

git clone [your-repo-url] my-mcp-server
cd my-mcp-server

安装依赖

pnpm install

构建项目

pnpm run build

这将生成/build/index.js文件，即您编译好的 MCP 服务器脚本。

🚀 快速开始

完成上述安装步骤后，您就可以使用该 MCP 服务器模板了。以下是与不同工具结合使用的具体步骤。

与 Cursor 一起使用

1. 转到 Cursor 设置 -> MCP -> 添加新的 MCP 服务器。
2. 配置您的 MCP：
   • 名称：[自定义名称]
   • 类型：命令
   • 命令：node 绝对路径到MCP服务器/build/index.js

与 Claude Desktop 一起使用

在您的 Claude Desktop 配置中添加以下 MCP 配置：

{
  "mcpServers": {
    "your-mcp-name": {
      "command": "node",
      "args": ["绝对路径到MCP服务器/build/index.js"]
    }
  }
}

💻 使用示例

基础用法

该模板包括index.ts中的样本工具实现。要创建自己的 MCP，可按以下步骤操作：

修改服务器配置

const server = new McpServer({
  name: "your-mcp-name",
  version: "0.0.1",
});

定义自定义工具

server.tool(
  "your-tool-name",
  "您的工具描述",
  {
    // 使用Zod模式定义您的工具参数
    parameter: z.string().describe("参数描述"),
  },
  async ({ parameter }) => {
    // 实现您的工具逻辑
    return {
      content: [
        {
          type: "text",
          text: "您的工具响应",
        },
      ],
    };
  }
);

构建并测试实现

npm run build

📚 详细文档

项目结构

mcp-server-template/
├── index.ts        # 主服务器实现文件
├── package.json    # 项目依赖
├── tsconfig.json   # TypeScript配置
└── build/         # 编译后的JavaScript输出

📄 许可证

本项目采用 MIT 许可证。

贡献

随时提交问题和改进请求！