关键词

架构分析ADR管理AI开发助手代码安全部署就绪

项目简介

MCP ADR 架构分析服务器是一个基于Model Context Protocol (MCP) 构建的后端服务，旨在将深度架构分析能力无缝集成到AI助手中。它能够提供即时的、可操作的架构洞察，而不是简单的LLM提示，从而实现智能代码生成、决策跟踪和开发工作流自动化。主要功能包括AI驱动的架构分析、技术栈检测、ADR（架构决策记录）管理、安全与合规检测以及TDD（测试驱动开发）集成等。

主要功能点

  • AI驱动分析：通过集成OpenRouter.ai，提供即时架构洞察。
  • 技术栈检测：识别项目的技术栈和架构模式。
  • ADR管理：生成、建议和维护架构决策记录。
  • 安全与合规：自动检测并屏蔽敏感内容。
  • 工作流自动化：生成待办事项，跟踪部署，并验证规则。
  • TDD集成：支持两阶段测试驱动开发，包括ADR链接和验证。
  • Mock代码检测：区分Mock代码和生产代码。
  • 部署准备度：零容忍测试验证，部署历史跟踪，硬性阻止不安全部署。
  • 项目健康评分：协调任务完成、部署准备度、架构合规、安全态势和代码质量等指标。

安装步骤

  1. Node.js 要求: 确保您的系统安装了 Node.js 18.0.0 或更高版本。
  2. 通过 npm 安装 (推荐):
    • 全局安装 (推荐用于大多数MCP客户端): 
      npm install -g mcp-adr-analysis-server
    • 本地安装 (如果需要在特定项目中使用): 
      npm install mcp-adr-analysis-server
  3. RHEL 系统特殊安装 (RHEL 9/10 推荐):
    • 如果您在 RHEL 9/10 系统上遇到 npm PATH 或权限问题，请使用专用安装脚本: 
      curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/main/scripts/install-rhel.sh | bash
  4. 从源代码安装: 
    git clone https://github.com/tosin2013/mcp-adr-analysis-server.git
cd mcp-adr-analysis-server
npm install
npm run build
# 启动服务器 (通常通过MCP客户端配置启动，不直接手动运行)
# npm start

服务器配置 (供MCP客户端使用)

MCP服务器需要配置 AI 执行参数才能返回实际分析结果。请确保在您的MCP客户端（如Claude Desktop, Cline, Cursor等）的配置文件中添加以下JSON配置。服务器名称可自定义，以下示例中使用 "adr-analysis"。

{
  "mcpServers": {
    "adr-analysis": {
      "command": "mcp-adr-analysis-server",
      "env": {
        "PROJECT_PATH": "/path/to/your/project",                  // 必填：要分析的项目根目录路径
        "OPENROUTER_API_KEY": "your_openrouter_api_key_here",    // 必填：您的 OpenRouter.ai API Key，访问 https://openrouter.ai/keys 获取
        "EXECUTION_MODE": "full",                                // 必填：设置为 "full" 以启用AI驱动的结果返回
        "AI_MODEL": "anthropic/claude-3-sonnet",                 // 可选：指定AI模型，如 "openai/gpt-4o"，默认为 "anthropic/claude-3-sonnet"
        "ADR_DIRECTORY": "docs/adrs",                            // 可选：ADR文件存放目录，默认为 "docs/adrs"
        "LOG_LEVEL": "ERROR",                                    // 可选：日志级别 (DEBUG, INFO, WARN, ERROR)，默认为 "INFO"
        "AI_TEMPERATURE": "0.1",                                 // 可选：AI响应一致性（0-1，默认0.1）
        "AI_MAX_TOKENS": "4000"                                  // 可选：AI响应长度限制（默认4000）
      }
    }
  }
}

配置完成后，重启您的MCP客户端即可。

基本使用方法

一旦MCP服务器在您的AI助手中配置并启动，您可以通过与AI助手的对话来调用其功能：

  • 分析项目架构:

    "Analyze this React project's architecture and suggest ADRs for any implicit decisions" （分析这个React项目的架构，并为所有隐式决策提供ADR建议）

  • 从PRD生成ADR和待办事项:

    "Generate ADRs from the PRD.md file and create a todo.md with implementation tasks" （从 PRD.md 文件生成 ADRs，并创建一个包含实施任务的 todo.md）

  • 检查代码安全:

    "Check this codebase for security issues and provide masking recommendations" （检查这个代码库中的安全问题，并提供屏蔽建议）

服务器将返回实际的分析结果，而不是需要您提交到其他地方的提示。

信息

分类

开发者工具

访问项目