architect-mcp-server

🚀 MCP 服务器模板

MCP 服务器模板为开发提供了便捷的环境，借助 LLM CLI 可获取架构设计反馈，同时具备多种测试工具和调试手段，能有效提升开发效率。

🚀 快速开始

先决条件

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（参见先决条件部分）
  • 环境变量应正确配置以支持 LLM CLI

测试工具

该模板包含一个内置的 TestClient 用于本地测试以及 MCP 检查器用于可视化调试。

📦 安装指南

安装依赖

npm install

💻 使用示例

架构师工具使用示例

架构师工具提供了与 LLM CLI 交互的接口，可获取架构设计反馈。

使用 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 检查器进行可视化调试

1. 启动检查器：

npx @modelcontextprotocol/inspector node dist/index.js

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

使用 Cursor 进行本地测试

1. 构建并链接包：

npm run build
npm run link

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

npx architect-test-mcp-tool

3. 在 Cursor 中添加服务器：

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

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

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

npm run build
npm run link

完成测试后，可以使用以下命令解链：

npm run unlink

🔧 技术细节

架构师工具

架构师工具维护对话上下文并处理应用程序与 LLM CLI 之间的通信。它通过维护对话上下文，使得在多次交互中能够保持连贯的对话，同时处理通过 LLM CLI 执行的命令，提供错误处理和日志记录功能，支持新对话和继续讨论。

测试工具

• TestClient：提供了一种简单的方式测试工具，通过断言工具调用的结果来验证工具的正确性。
• MCP 检查器：提供可视化界面用于测试工具，实时监控请求/响应，检查工具元数据，并提供交互式测试环境。

📚 详细文档

故障排除

使用 MCP 检查器

MCP 检查器是一个有用的工具，用于调试和检查您的 MCP 服务器。使用方法如下：

1. 首先构建项目：

npm run build

2. 运行检查器：

npx @modelcontextprotocol/inspector node dist/index.js

检查器提供以下功能：

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