MCP 服务器模板

一个用于创建模型上下文协议（MCP）服务器的 TypeScript 模板。此模板为构建兼容 MCP 的服务器提供了坚实的基础，具备完整的工具支持、类型安全性和最佳实践。

特性

• 🚀 全面的 TypeScript 支持
• 🏗️ 基于容器的依赖注入
• 📦 服务导向架构，带 DataProcessor 接口
• 🛠️ 示例工具实现及测试
• 🧪 Vitest 测试框架
• 📝 类型定义
• 🔌 MCP SDK 集成

开发指南

开始开发

1. 安装依赖：

   npm install
   

2. 启动带有热重载的开发服务器：

   npm run dev
   

3. 构建项目：

   npm run build
   

4. 运行测试：

   npm test
   

5. 启动生产服务器：

   npm start
   

项目结构

src/
├── index.ts          # 入口点
├── interfaces/       # 接口定义
│   └── tool.ts      # DataProcessor 接口
└── tools/           # 工具实现
    └── example.ts   # 示例工具

创建工具

1. 按照 src/tools/example.ts 中的例子导出您的工具和处理程序：

   // 在 your-tool.ts 中
   export const YOUR_TOOLS = [
     {
       name: "your-tool-name",
       description: "Your tool description",
       parameters: {
         // 您的工具参数模式
       },
     },
   ];
   
   export const YOUR_HANDLERS = {
     "your-tool-name": async (request) => {
       // 您的工具处理程序实现
       return {
         toolResult: {
           content: [{ type: "text", text: "Result" }],
         },
       };
     },
   };
   

2. 在 src/index.ts 中注册您的工具：

   // 在 src/index.ts 中
   import { YOUR_TOOLS, YOUR_HANDLERS } from "./tools/your-tool.js";
   
   // 合并所有工具
   const ALL_TOOLS = [...EXAMPLE_TOOLS, ...YOUR_TOOLS];
   const ALL_HANDLERS = { ...EXAMPLE_HANDLERS, ...YOUR_HANDLERS };
   

服务器将自动：

• 列出您的工具为可用工具之一
• 处理输入验证
• 处理针对您工具的请求
• 根据 MCP 协议格式化响应

测试

该模板包含内置的 TestClient 用于本地测试以及 MCP Inspector 用于可视化调试。

使用 TestClient

TestClient 提供了一种简便的方式测试您的工具：

import { TestClient } from "./utils/TestClient";

describe("YourTool", () => {
  const client = new TestClient();

  it("should process data correctly", async () => {
    await client.assertToolCall(
      "your-tool-name",
      { input: "test" },
      (result) => {
        expect(result.toolResult.content).toBeDefined();
      }
    );
  });
});

使用 MCP Inspector

该模板包含 MCP Inspector 用于调试工具：

1. 启动 inspector：

   npx @modelcontextprotocol/inspector node dist/index.js
   

2. 在 http://localhost:5173 打开 inspector 的 UI

Inspector 提供了：

• 可视化界面用于测试工具
• 实时请求/响应监控
• 工具元数据检查
• 交互式测试环境

使用 Cursor 进行本地测试

要在 Cursor 中测试您的 MCP 服务器：

1. 构建并链接包：

   npm run build
   npm run link
   

2. 验证二进制文件是否正常工作：

   npx example-mcp-tool
   

3. 在 Cursor 中添加服务器：

   • 打开 Cursor 设置
   • 导航到功能选项卡
   • 滚动到底部的 MCP 服务器部分
   • 点击“添加服务器”
   • 选择“命令”类型
   • 输入一个名称（例如，“本地示例工具”）
   • 输入命令：npx example-mcp-tool
   • 点击确认

4. 在 Cursor 中检查 MCP 服务器部分，确保您的服务器显示为运行状态。

注意：如果更改了代码，请记得重新构建并重新链接：

npm run build
npm run link

当不再需要时，可以卸载包：

npm uninstall example-mcp-tool
rm -rf ~/.node_modules_bins/example-mcp-link

更新日志

v1.0.0

• 初始版本发布