MCP Server Template 🛠️

MCP 服务模板 🛠️

用于构建自定义 Model Context Protocol（MCP）服务的入门模板。此模板提供了创建自定义 MCP 所需的基本结构和配置，可与 Cursor 或 Claude Desktop 搭配使用。

功能

• 基于 TypeScript 的基本 MCP 服务配置
• 示例工具实现
• 开箱即用的项目结构
• 使用 @modelcontextprotocol/sdk 构建

项目结构

mcp-server-template/
├── index.ts        # Main server implementation
├── package.json    # Project dependencies
├── tsconfig.json   # TypeScript configuration
└── build/         # Compiled JavaScript output

开始使用

1. 克隆此模板：

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

2. 安装依赖：

pnpm install

3. 构建项目：

pnpm run build

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

与 Cursor 搭配使用

1. 前往 Cursor 设置 -> MCP -> 添加新的 MCP 服务
2. 配置 MCP：
   • 名称：[选择你自己的名称]
   • 类型：command
   • 命令：node ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js

与 Claude Desktop 搭配使用

将以下 MCP 配置添加到 Claude Desktop 配置中：

{
  "mcpServers": {
    "your-mcp-name": {
      "command": "node",
      "args": ["ABSOLUTE_PATH_TO_MCP_SERVER/build/index.js"]
    }
  }
}

开发

此模板在 index.ts 中包含示例工具实现。要创建自己的 MCP：

1. 修改 index.ts 中的服务配置：

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

2. 使用 server.tool() 方法定义自定义工具：

server.tool(
  "your-tool-name",
  "Your tool description",
  {
    // Define your tool's parameters using Zod schema
    parameter: z.string().describe("Parameter description"),
  },
  async ({ parameter }) => {
    // Implement your tool's logic here
    return {
      content: [
        {
          type: "text",
          text: "Your tool's response",
        },
      ],
    };
  }
);

3. 构建并测试实现：

npm run build

贡献

欢迎提交问题和功能改进请求！

许可证

MIT