MCP 服务器模板

先决条件

LLM CLI 安装

该项目需要安装 LLM CLI。你可以使用 Homebrew 进行安装：

brew install llm

安装后，通过运行以下命令确保 llm 命令在你的 PATH 中可用：

llm --version

开始使用

开发

1. 安装依赖项：

   npm install
   

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

   npm run dev
   

3. 构建项目：

   npm run build
   

4. 运行测试：

   npm test
   

5. 启动生产服务器：

   npm start
   

架构工具

架构工具 (src/tools/architect.ts) 提供了一个与 LLM CLI 交互的接口，用于获取架构设计反馈。它维护会话上下文，并处理应用程序与 LLM CLI 之间的通信。

功能

• 在多次交互中保持会话上下文
• 通过 LLM CLI 处理命令执行
• 提供错误处理和日志记录
• 支持新会话和继续讨论

要求

• 必须安装 LLM CLI 并且在你的 PATH 中可用（参见先决条件部分）
• 应为 LLM CLI 正确配置环境变量

测试

该模板包括一个内置的 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. 启动检查器：

   npx @modelcontextprotocol/inspector node dist/index.js
   

2. 打开检查器 UI http://localhost:5173

检查器提供了：

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

使用 Cursor 进行本地测试

要使用 Cursor 本地测试你的 MCP 服务器：

1. 构建并链接包：

   npm run build
   npm run link
   

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

   npx architect-test-mcp-tool
   

3. 将服务器添加到 Cursor：

   • 打开 Cursor 设置
   • 导航到“功能”标签页
   • 滚动至 MCP 服务器部分
   • 点击“添加服务器”
   • 选择“命令”类型
   • 给它命名（例如，“本地示例工具”）
   • 输入命令：npx architect-test-mcp-tool
   • 点击确认

4. 通过检查 MCP 服务器部分显示你的服务器正在运行来验证服务器是否在 Cursor 中正确启动。

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

npm run build
npm run link

完成测试后，你可以取消链接包：

npm run unlink

这将移除在开发期间创建的全局符号链接。

故障排除

使用 MCP Inspector

MCP Inspector 是一个有助于调试和检查你的 MCP 服务器的工具。要使用它：

1. 首先，构建你的项目：

   npm run build
   

2. 运行检查器：

   npx @modelcontextprotocol/inspector node dist/index.js
   

检查器提供了一个网页界面，允许你：

• 查看所有可用工具及其模式
• 交互式测试工具调用
• 检查请求/响应负载
• 调试服务器与客户端之间的通信问题