🚀 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

✨ 主要特性

架构工具特性

• 维护跨多次交互的对话上下文
• 处理通过 LLM CLI 执行命令
• 提供错误处理和日志记录
• 支持新对话和继续讨论两种模式

检查器功能

• 维护对话上下文：确保工具在多次交互中保持一致的上下文。
• 处理 LLM 命令：通过 CLI 执行大语言模型相关操作。
• 错误处理和日志记录：提供详细的错误信息和日志以帮助调试。

📦 安装指南

依赖管理

使用 Node 包管理器（npm）进行依赖项安装和版本管理，确保项目顺利运行。

💻 使用示例

架构工具使用

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

测试工具使用

使用 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 检查器

该模板包含 MCP 检查器用于可视化调试工具：

1. 启动检查器：

npx @modelcontextprotocol/inspector node dist/index.js

2. 在浏览器中打开检查器界面：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. 在 Cursor 中检查 MCP 服务器部分，确保您的服务器显示为运行状态。

⚠️ 重要提示

如果对代码进行了更改，请记得重新构建并重新链接：

npm run build
npm run link

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

npm run unlink

此命令会删除开发期间创建的全局符号链接。

📚 详细文档

架构工具要求

• 必须安装并配置好 LLM CLI（参见先决条件部分）
• 环境变量应正确配置以支持 LLM CLI