使用说明

项目简介

architect-mcp-server 是一个 MCP (Model Context Protocol) 服务器的模板项目,旨在帮助开发者快速搭建能够为 LLM (大型语言模型) 应用提供上下文和工具能力的后端服务。它基于 MCP 协议标准,实现了工具注册、工具调用等核心功能,并提供了一个与 'llm' 命令行工具集成的示例工具 "architect",用于架构设计反馈。

主要功能点

  • MCP 服务器框架: 实现了 MCP 协议的核心功能,可以接收和处理来自 MCP 客户端的请求,并返回符合 MCP 协议的响应。
  • 工具注册与调用: 允许注册和管理各种工具,并通过标准化的方式供 LLM 客户端调用,扩展 LLM 的能力。
  • 示例工具 (architect): 集成了一个名为 "architect" 的示例工具,该工具通过调用 'llm' 命令行工具,为用户提供架构设计方面的反馈,并维护对话上下文。
  • 本地测试工具: 内置 'TestClient' 和 'MCP Inspector',方便开发者进行本地测试和调试,提高开发效率。
  • Cursor 集成: 提供了详细的步骤,指导用户如何在 Cursor 编辑器中配置和使用该 MCP 服务器,方便在实际 LLM 应用场景中进行测试。

安装步骤

  1. 安装 LLM CLI: 确保已安装 LLM CLI 工具,参考 README.md 中的 Prerequisites 部分进行安装。
  2. 安装项目依赖: 克隆仓库到本地后,在项目根目录下运行以下命令安装 Node.js 依赖:
    npm install
  3. 构建项目: 运行以下命令构建项目,生成可执行的服务器代码:
    npm run build

服务器配置

为了让 MCP 客户端(例如 Cursor)连接到此 MCP 服务器,您需要提供以下配置信息。以下是针对本地开发环境的配置示例,假设您已按照上述步骤构建了项目。

{
  "serverName": "Architect MCP Server",  // MCP 服务器的名称,可自定义
  "command": "npx",                   // 启动服务器的命令,这里使用 npx 运行 npm 包
  "args": [                           // 启动命令的参数
    "architect-test-mcp-tool"        //  指向 package.json 中 bin 字段定义的可执行文件,实际会运行 'dist/index.js'
  ]
}

配置说明:

  • 'serverName': 为您的 MCP 服务器指定一个易于识别的名称。
  • 'command': 指定用于启动服务器进程的命令。'npx' 是一个常用的 Node.js 工具,用于运行本地安装的 npm 包的可执行文件。
  • 'args': 一个字符串数组,包含了传递给 'command' 的参数。
    • '"architect-test-mcp-tool"': 这是在 'package.json' 中配置的二进制文件名称,'npm link' 或 'npm install -g' 后可以直接通过此命令运行服务器。'npx' 可以直接运行本地 'node_modules/.bin' 目录下的可执行文件,无需全局安装。

在 Cursor 中添加 MCP 服务器:

  1. 打开 Cursor 编辑器的设置 (Settings)。
  2. 导航到 "Features" 选项卡。
  3. 滚动到 "MCP Servers" 部分。
  4. 点击 "Add Server" 按钮。
  5. 选择 "Command" 类型。
  6. 输入上述 JSON 配置信息,例如:
    • Name: 'Architect MCP Server'
    • Command: 'npx architect-test-mcp-tool'
  7. 点击 "Confirm" 保存配置。
  8. 检查 Cursor 的 MCP Servers 部分,确认您的服务器已成功启动并显示为 "running" 状态。

基本使用方法

  1. 启动 MCP 服务器: 按照上述服务器配置,在 MCP 客户端(如 Cursor)中添加并启动该服务器。
  2. 调用工具: 在支持 MCP 协议的 LLM 应用或编辑器中,您应该能够发现并调用 "architect" 工具。
  3. 使用示例工具: 在 LLM 应用中,通过 "architect" 工具,您可以输入架构设计相关的提示 (prompt),工具会将提示发送到 'llm chat' CLI 进行处理,并返回架构设计反馈。工具会维护对话上下文,以便进行多轮交互。
  4. 测试和调试: 使用 'MCP Inspector' 工具可以可视化地测试和调试您的 MCP 服务器,查看工具列表、测试工具调用、检查请求和响应等。

信息

分类

开发者工具