MCP 服务器

MCP Server Template

一个基于 TypeScript 的模板，用于开发模型上下文协议（Model Context Protocol）服务器，具有依赖注入和服务化架构等特性，方便创建和集成自定义数据处理工具。

Tools

example-tool

An example tool that processes input data

README

MCP 服务器模板

一个用于在 TypeScript 中创建模型上下文协议 (MCP) 服务器的模板。此模板为构建 MCP 兼容的服务器提供了坚实的基础，具有适当的工具、类型安全和最佳实践。

特性

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

快速开始

开发

安装依赖:
```
npm install
```
启动带有热重载的开发服务器:
```
npm run dev
```
构建项目:
```
npm run build
```
运行测试:
```
npm test
```
启动生产服务器:
```
npm start
```

项目结构

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

创建工具

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

// 在 your-tool.ts 中
export const YOUR_TOOLS = [
  {
    name: "your-tool-name",
    description: "您的工具描述",
    parameters: {
      // 您的工具参数 schema
    },
  },
];

export const YOUR_HANDLERS = {
  "your-tool-name": async (request) => {
    // 您的工具处理程序实现
    return {
      toolResult: {
        content: [{ type: "text", text: "Result" }],
      },
    };
  },
};

在 src/index.ts 中的 ALL_TOOLS 和 ALL_HANDLERS 常量中注册您的工具:

// 在 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 用于可视化调试您的工具:

启动 inspector:

npx @modelcontextprotocol/inspector node dist/index.js

在 http://localhost:5173 打开 inspector UI

inspector 提供:

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

使用 Cursor 进行本地测试

要使用 Cursor 在本地测试您的 MCP 服务器:

构建并链接包:
```
npm run build
npm run link
```
验证二进制文件是否有效:
```
npx example-mcp-tool
```
将服务器添加到 Cursor:
- 打开 Cursor 设置
- 导航到 Features 选项卡
- 向下滚动到 MCP Servers 部分
- 点击 "Add Server"
- 选择 "Command" 类型
- 给它一个名称 (例如, "Local Example Tool")
- 输入命令: npx example-mcp-tool
- 点击 Confirm
通过检查 MCP Servers 部分是否显示您的服务器正在运行，来验证服务器是否在 Cursor 中正确启动。