使用说明

项目简介

PlaybookMCP 是一个实现 Model Context Protocol (MCP) 标准的服务器端应用。它的核心目标是解决团队在使用不同AI编码工具（如 Cursor, Cline 等）时，无法方便地共享和协作管理AI自动化指令集（称为 Playbook）的问题。PlaybookMCP 通过从一个中心化的 Git 仓库（通常是 GitHub 仓库）加载 Playbook 和相关的知识库，并以 MCP 服务器的形式提供给支持 MCP 协议的 AI 客户端使用，从而实现 Playbook 的共享、版本控制和协作编辑。

主要功能点

集中式 Playbook 管理： 将团队的自动化 Playbook 和知识库存储在一个 Git 仓库中，方便版本控制和审计。
Playbook 共享服务： 作为 MCP 服务器，向团队所有成员使用的 AI 客户端提供标准化的 Playbook 访问接口。
知识库支持： Playbook 可以依赖于特定的知识文档，服务器会将这些知识一并提供给客户端，为 AI 执行任务提供必要的上下文。
工具暴露： 提供 MCP 工具，允许客户端：
- 查询所有可用的 Playbook 列表 ('playbookmcp_catalogs')。
- 获取指定 Playbook 的详细内容及依赖的知识 ('playbookmcp_execute')。
- 获取使用 Playbook 的引导性说明 ('playbookmcp_start')。
多种数据源支持： 支持从远程 Git 仓库或本地文件路径加载 Playbook 数据。

安装步骤

PlaybookMCP 是一个 Node.js 命令行工具，可以直接通过 'npx' 命令运行，无需预先全局安装。确保你的系统安装了 Node.js 和 Git。

服务器配置

PlaybookMCP 服务器需要在支持 MCP 的 AI 客户端中进行配置，以便客户端能够发现并连接到它。以下是典型的 MCP 客户端 JSON 配置示例，用于启动 PlaybookMCP：

{
  "mcpServers": {
    "playbookmcp": { // <-- 为你的服务器定义一个独有的名称
      "command": "npx", // <-- 启动服务器进程的命令
      "args": [ // <-- 传递给 command 的参数数组
        "-y", // npx 参数，自动同意安装 @latest 版本的 playbookmcp 包
        "playbookmcp@latest", // 指定使用最新版本的 playbookmcp 包运行
        "--playbook-repo", // PlaybookMCP 参数：指定存储 Playbook 的远程 Git 仓库 URL
        "<你的 Playbook 仓库地址>" // 将此占位符替换为你团队存放 Playbook 的 Git 仓库 URL (例如: [email protected]:yourorg/your-playbooks.git 或 https://github.com/yourorg/your-playbooks.git)
      ]
    }
    // 如果你想使用本地文件路径作为 Playbook 数据源，可以配置如下：
    /*
    "playbookmcp-local": { // <-- 为本地服务器定义一个独有的名称
      "command": "npx", // <-- 启动服务器进程的命令
      "args": [ // <-- 传递给 command 的参数数组
        "-y", // npx 参数，自动同意安装 @latest 版本的 playbookmcp 包
        "playbookmcp@latest", // 指定使用最新版本的 playbookmcp 包运行
        "--playbook-path", // PlaybookMCP 参数：指定存储 Playbook 的本地文件路径
        "<你的 Playbook 文件目录路径>" // 将此占位符替换为你本地存放 Playbook 的目录路径
      ]
    }
    */
  }
}

将上述配置添加到你的 AI 客户端（如 Cursor 等）的 MCP 服务器配置部分。客户端启动时会根据配置自动启动 PlaybookMCP 进程并与之建立连接。

基本使用方法

与 PlaybookMCP 服务器的交互主要通过其提供的 MCP 工具进行。具体的使用方式取决于你使用的 AI 客户端（可能是通过聊天界面、工具调用 UI 等）。一般来说，使用流程如下：

获取使用指南： 在客户端调用 'playbookmcp_start' 工具。服务器会返回一段文本，指导 AI 如何发现和使用 Playbook。
查看可用 Playbook： 调用 'playbookmcp_catalogs' 工具。服务器将返回当前 Playbook 仓库中所有 Playbook 的列表，包含它们的 ID 和描述。
获取特定 Playbook 内容： 根据 'playbookmcp_catalogs' 返回的 Playbook ID，调用 'playbookmcp_execute' 工具，并提供 Playbook ID 作为参数（例如，'playbookmcp_execute { "id": "your-playbook-id" }'）。服务器将返回该 Playbook 的详细内容及其所有依赖的知识库文档。
AI 执行任务： 你的 AI 客户端或 AI 模型可以使用 'playbookmcp_execute' 获取的 Playbook 内容和知识信息，作为执行特定自动化任务的详细指令和上下文。

整个过程通过 MCP 协议在客户端和 PlaybookMCP 服务器之间进行标准化通信。

关键词