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
   

Architect 工具

Architect 工具 (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. 启动 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 architect-test-mcp-tool
   

3. 将服务器添加到 Cursor：

   • 打开 Cursor 设置
   • 导航到 Features 选项卡
   • 向下滚动到 MCP Servers 部分
   • 点击 "Add Server"
   • 选择 "Command" 类型
   • 给它一个名称（例如，“Local Example Tool”）
   • 输入命令：npx architect-test-mcp-tool
   • 点击 Confirm

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

注意：如果您更改了代码，请记住重新构建和重新链接：

npm run build
npm run link

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

npm run unlink

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

故障排除

使用 MCP Inspector

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

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

   npm run build
   

2. 运行 inspector:

   npx @modelcontextprotocol/inspector node dist/index.js
   

Inspector 提供了一个 Web 界面，允许您：

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