Architect MCP Server 使用说明

项目简介

Architect MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于提供 架构设计 领域的专业知识和工具。它通过集成专门的 AI агенты 和丰富的架构资源,为用户提供架构设计、分析和评估能力。该服务器旨在与支持 MCP 协议的客户端(如 LLM 应用)配合使用,以标准化的方式提供架构领域的上下文信息和功能。

主要功能点

  • 专业架构 агенты: 内置多种专业领域的架构 агенты,例如软件架构、云架构、AI 架构等,能够提供领域相关的专业知识。
  • 架构设计工具: 提供用于生成、评估和分析软件架构的工具,帮助用户快速进行架构设计和优化。
  • 丰富的架构资源: 包含设计模板、最佳实践、模式目录和案例研究等资源,为架构设计提供参考和灵感。
  • MCP 协议支持: 完全兼容 Model Context Protocol,可以通过标准的 JSON-RPC 协议与 MCP 客户端进行通信。
  • Stdio 传输协议: 使用 Stdio 作为默认的传输协议,易于集成和部署。

安装步骤

  1. 安装 Node.js 依赖: 在仓库根目录下运行以下命令安装项目依赖:
    npm install
  2. 配置 OpenAI API Key:
    • 复制 '.env.example' 文件并重命名为 '.env':
      cp .env.example .env
    • 编辑 '.env' 文件,将你的 OpenAI API Key 填入 'OPENAI_API_KEY' 变量:
      OPENAI_API_KEY=你的OpenAI API密钥

服务器配置 (MCP 客户端配置)

要将 Architect MCP Server 集成到 MCP 客户端,您需要配置服务器连接信息。以下是一个典型的 JSON 格式配置示例,您可以将其添加到您的 MCP 客户端配置中:

{
  "serverName": "architect-server",  // MCP 服务器的名称,您可以自定义
  "command": "node",                 // 启动服务器的命令,这里使用 Node.js
  "args": [                         // 传递给启动命令的参数
    "src/server.ts"             //  指向服务器入口文件 (假设直接运行 TypeScript 代码)
  ],
  "transport": "stdio"              //  指定使用 Stdio 传输协议
}

配置参数说明:

  • 'serverName': 为您的 MCP 服务器指定一个易于识别的名称。
  • 'command': 运行 MCP 服务器的可执行命令。通常为 Node.js ('node')。
  • 'args': 一个字符串数组,包含传递给 'command' 的参数。
    • '"src/server.ts"': 指向 Architect MCP Server 的入口文件路径。请注意,此配置假设您直接运行 TypeScript 代码。如果您的项目需要先构建,请根据实际构建输出调整此路径。例如,如果构建输出到 'dist/server.js',则应修改为 '["dist/server.js"]'。
  • 'transport': 指定 MCP 客户端与服务器通信的传输协议。这里设置为 'stdio',表示使用标准输入/输出进行通信。

基本使用方法

  1. 启动服务器: 打开终端,导航到 Architect MCP Server 仓库根目录,运行以下命令启动服务器:
    node src/server.ts
    您应该在终端看到 'Architect MCP Server running on stdio' 的提示信息,表明服务器已成功启动。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,根据上述 “服务器配置” 提供的 JSON 配置信息,添加 Architect MCP Server 的连接配置。
  3. 与服务器交互: 使用您的 MCP 客户端,您可以向 Architect MCP Server 发送 MCP 请求,例如:
    • 列出可用工具: 请求服务器返回所有注册的架构设计工具。
    • 调用工具: 调用特定的工具,例如 'generate_architecture' (生成架构设计), 'analyze_architecture' (分析架构), 'evaluate_architecture' (评估架构),并传递相应的参数以执行架构相关的任务。
    • 获取 Prompt: 请求服务器返回预定义的 Prompt 模板,用于指导 LLM 进行架构设计相关的对话。

通过 MCP 客户端,您可以利用 Architect MCP Server 提供的架构设计能力,集成到您的 LLM 应用中,实现智能化的架构设计和分析功能。

信息

分类

AI与计算