项目简介

AI Prompt Guide MCP是一个基于Model Context Protocol (MCP) 构建的后端服务器，专为AI代理编排设计。它通过管理结构化的Markdown知识图谱，实现智能上下文注入，帮助AI代理无需手动拼接提示词，即可获取完成任务所需的精确规范、工作流程和关联文档。服务器提供丰富的工具集，支持文档、章节和任务的创建、浏览、编辑和管理，并维护操作审计追踪。

主要功能点

双任务系统: 包含协调器工具（用于顺序项目编排，任务完成后自动归档）和子代理工具（用于文档间的即时任务管理，任务持久保存）。
任务驱动上下文加载: 根据任务类型自动注入关联文档、工作流程和后续任务。
统一引用系统: 根据配置的深度加载所需章节，支持循环检测和命名空间感知寻址。
工作流库: 提供项目级方法论和任务特定操作手册。
渐进式工具套件: 支持批量创建、浏览、编辑和移动文档、章节和任务。
持久审计追踪: 捕获会话间的完成说明和后续步骤。
Prompt 模板管理: 通过 'get_workflow' 和 'get_guide' 工具提供结构化的工作流协议和最佳实践指南。

安装步骤

前提条件:
- Node.js 18 或更高版本
- pnpm 10.x (该项目使用 pnpm workspaces 和 lockfiles)

克隆仓库:

git clone https://github.com/Blakeem/AI-Prompt-Guide-MCP.git
cd AI-Prompt-Guide-MCP

安装依赖并构建:
```
pnpm install
pnpm build
```
这会将 TypeScript 源码编译到 'dist/' 目录，并生成可执行文件 'ai-prompt-guide-mcp'。

服务器配置

MCP客户端需要通过JSON配置来连接MCP服务器。以下是配置AI Prompt Guide MCP服务器的关键信息及参数说明：

{
  "mcpServers": {
    "ai-prompt-guide-mcp": {
      "command": "npx",
      "args": ["-y", "ai-prompt-guide-mcp"],
      "env": {
        "DOCS_BASE_PATH": "./.ai-prompt-guide",
        "WORKFLOWS_BASE_PATH": "./.ai-prompt-guide/workflows",
        "GUIDES_BASE_PATH": "./.ai-prompt-guide/guides",
        "REFERENCE_EXTRACTION_DEPTH": "3",
        "LOG_LEVEL": "info"
      }
    }
  }
}

'ai-prompt-guide-mcp': 服务器的唯一名称。
'command': 启动服务器的命令，通常是 'npx' 或直接执行编译后的二进制文件。
'args': 传递给 'command' 的参数。'-y' 允许 'npx' 自动安装包，'ai-prompt-guide-mcp' 是服务器的可执行文件。
'env': 环境变量，用于配置服务器行为：
- 'DOCS_BASE_PATH': 必填，文档的根目录，例如 './.ai-prompt-guide'。
- 'WORKFLOWS_BASE_PATH': 可选，工作流协议的目录，默认为插件内置的工作流。
- 'GUIDES_BASE_PATH': 可选，文档指南的目录，默认为插件内置的指南。
- 'REFERENCE_EXTRACTION_DEPTH': 可选，递归引用提取的深度（1-5），默认为 '3'。
- 'LOG_LEVEL': 可选，日志级别（'debug', 'info', 'warn', 'error'），默认为 'info'。
注意: 对于每个项目，您可以在项目根目录创建 '.mcp-config.json' 文件来覆盖上述环境变量配置。

基本使用方法

启动服务器: 在本地克隆的仓库目录中，执行以下命令来启动服务器：

pnpm start
# 或者直接通过 npx 运行已发布的包
# npx -y ai-prompt-guide-mcp

连接MCP客户端: 使用您偏好的MCP客户端（例如，Codex或Claude Code插件），根据上述“服务器配置”信息进行设置，以建立与AI Prompt Guide MCP服务器的连接。
通过工具与服务器交互: 一旦连接，您就可以通过客户端提供的工具接口与服务器交互。例如：
- 创建文档: 调用 'create_document' 工具，提供 'namespace'、'title' 和 'overview'。
- 浏览文档: 调用 'browse_documents' 工具，指定 'path' 来查看文件夹或文档结构。
- 搜索文档: 调用 'search_documents' 工具，提供 'query' 来进行全文或正则表达式搜索。
- 管理任务: 使用 'coordinator_task' 或 'subagent_task' 工具来创建、编辑、列出或完成任务。
- 获取工作流/指南: 调用 'get_workflow' 或 'get_guide' 工具，指定工作流或指南的名称来获取其内容。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息