项目简介

“MCP AI Agent 指南服务器”是一个基于Model Context Protocol (MCP) 构建的后端应用,旨在为大型语言模型(LLM)客户端提供结构化的上下文信息和功能。它集成了多种专业工具和模板,帮助AI代理在分层提示、代码卫生分析、架构可视化、内存上下文优化和敏捷项目规划等方面遵循最佳实践。通过JSON-RPC协议与客户端通信,实现资源的托管与访问、工具的注册与执行以及Prompt模板的定义与渲染,为LLM应用提供安全、可扩展的上下文服务框架。

主要功能点

  • 分层提示构建器: 创建具有清晰层级结构的Prompt,支持自定义上下文、目标、需求和输出格式,以指导LLM生成更精确、相关的响应。
  • 代码规范分析器: 自动分析代码库,识别过时模式、潜在问题、安全漏洞和代码异味(code smells),并提供具体的改进建议。
  • 安全加固Prompt生成器: 专门用于生成安全分析和漏洞评估的Prompt,支持多种安全焦点(如漏洞分析、威胁建模)和合规标准(如OWASP Top 10)。
  • Mermaid图表生成器: 根据简洁的文本描述自动生成流程图、序列图、类图、状态图、甘特图和饼图等专业图表,简化系统设计和文档工作。
  • 内存上下文优化器: 优化Prompt缓存和上下文窗口使用,通过智能分割和策略性缓存,提高AI代理的运行效率和降低成本。
  • 冲刺时间线计算器: 帮助敏捷团队规划开发冲刺周期,估算任务所需时间,分析团队速度,并识别潜在的项目风险。
  • 模型兼容性检查器: 根据任务描述、具体功能要求(如长上下文、多模态)和预算限制,推荐最适合的AI模型。
  • 指南验证器: 评估AI代理的开发实践是否符合既定的最佳实践和质量指南,并提供合规性评分和改进建议。

安装步骤

该MCP服务器可以通过多种方式进行安装和运行:

  1. 使用 NPX (推荐) 直接在命令行中运行,无需全局安装:

    npx mcp-ai-agent-guidelines
  2. 全局 NPM 安装 通过 npm 全局安装后,可以在任何位置直接运行:

    npm install -g mcp-ai-agent-guidelines
    mcp-ai-agent-guidelines
  3. 从源代码安装 首先克隆项目的GitHub仓库,然后安装依赖并启动服务器:

    git clone https://github.com/Anselmoo/mcp-ai-agent-guidelines.git
    cd mcp-ai-agent-guidelines
    npm ci          # 安装所有项目依赖
    npm run build   # 编译TypeScript代码
    npm start       # 启动MCP服务器
  4. 使用 Docker 如果您的系统安装了Docker,可以直接拉取并运行官方Docker镜像:

    docker run -p 3000:3000 ghcr.io/anselmoo/mcp-ai-agent-guidelines:latest

    请注意,'ghcr.io/anselmoo/mcp-ai-agent-guidelines:latest' 是推荐的Docker镜像地址。

服务器配置

MCP客户端(例如VS Code的MCP扩展)需要配置此服务器的启动命令。以下是常见的JSON配置示例,您可以将其添加到您的MCP客户端设置中(例如VS Code的 'settings.json' 文件):

{
    "mcp": {
        "servers": {
            "ai-agent-guidelines": {
                "command": "npx",
                "args": ["-y", "mcp-ai-agent-guidelines"]
            }
        }
    }
}
  • '"ai-agent-guidelines"': 这是您在MCP客户端中为此服务器指定的唯一名称。
  • '"command"': 启动MCP服务器的命令,这里指定为 '"npx"'。
  • '"args"': 传递给启动命令的参数列表,'-y' 用于自动确认安装,'mcp-ai-agent-guidelines' 是要运行的包名。

如果您选择使用Docker运行服务器,配置示例如下:

{
    "mcp": {
        "servers": {
            "ai-agent-guidelines-docker": {
                "command": "docker",
                "args": [
                    "run",
                    "--rm",
                    "-i",
                    "ghcr.io/anselmoo/mcp-ai-agent-guidelines:latest"
                ]
            }
        }
    }
}
  • '"command"': 启动Docker的命令,这里指定为 '"docker"'。
  • '"args"': 传递给Docker的参数列表,'run --rm -i' 用于运行一次性交互式容器,'ghcr.io/anselmoo/mcp-ai-agent-guidelines:latest' 是Docker镜像地址。

基本使用方法

配置好MCP服务器后,您可以通过MCP客户端(例如VS Code内置的聊天客户端)与服务器进行交互。

  1. 打开聊天客户端: 在VS Code中,打开您的聊天客户端(例如,通常可以在侧边栏找到)。
  2. 访问服务器工具: 在聊天窗口中,您通常可以通过服务器名称(例如 'ai-agent-guidelines')来查找并调用其提供的工具。
  3. 直接运行工具: 您可以直接输入工具名称和参数来调用它们。
    • 分层Prompt构建器: 输入 'hierarchical-prompt-builder',然后提供 'context'(上下文)、'goal'(目标)和 'requirements'(需求)。
    • 代码规范分析器: 输入 'code-hygiene-analyzer',并粘贴代码内容('codeContent')或指定文件,以及编程语言('language')。
    • Mermaid图表生成器: 输入 'mermaid-diagram-generator',并描述您想要绘制的系统或流程('description'),然后选择图表类型('diagramType')。
  4. 自然语言调用: 您也可以使用自然语言向LLM客户端提问,它会根据您的意图建议并调用合适的服务器工具。
    • 例如:“使用 'hierarchical-prompt-builder' 为 'src/index.ts' 创建一个重构计划,输出格式为 Markdown。”
    • 例如:“用 'code-hygiene-analyzer' 分析这个 Python 文件,突出显示安全问题。”
    • 例如:“用 'mermaid-diagram-generator' 为我们的产品发布流程生成一个流程图。”

信息

分类

开发者工具