项目简介:

Runbook MCP 服务器是一个实现了 Model Context Protocol (MCP) 的后端应用。它充当 LLM 客户端与 Runbook 文档库之间的桥梁，允许 LLM 以标准化的方式访问 Runbook 中的文档、手册和分类信息。通过此服务器，LLM 可以理解并利用 Runbook 作为上下文，从而提升问答和任务执行能力。

主要功能点:

• 获取文章: 通过文章的唯一标识符 (ID) 检索 Runbook 中的完整文章内容。
• 列出文章: 列出指定手册下的文章列表，可以根据文章名称或分类进行过滤，并支持多种排序方式（如更新时间、创建时间、名称、流行度）。
• 列出手册: 列出 Runbook 组织中的所有手册（Books），支持按手册名称进行搜索。
• 列出分类: 列出指定手册下的所有分类（Categories）。
• 搜索文章: 根据关键词在 Runbook 中进行全文搜索，查找相关的文章内容。

安装步骤:

1. 确保您的系统已经安装了 Node.js (版本建议 >= 20.0.0)。
2. 打开终端或命令行界面。
3. 使用 npm 或 yarn 全局安装 Runbook MCP 服务器软件包：

   npm install -g @runbook-docs/mcp-server
   # 或者使用 yarn
   yarn global add @runbook-docs/mcp-server
   

   安装完成后，您就可以通过命令行启动此服务器。

服务器配置 (在 MCP 客户端中设置):

Runbook MCP 服务器需要连接到您的 Runbook 实例并使用您的 API Token 进行认证。这些配置信息通常是在您使用的支持 MCP 协议的 LLM 客户端应用程序的设置界面中完成的。客户端会负责启动并连接到 MCP 服务器。

您需要向客户端提供以下信息：

1. Runbook 基础 URL: 您的 Runbook 实例的网址，格式通常为 'https://<您的子域名>.runbook.jp'。
2. Runbook API Token: 用于认证和访问 Runbook API 的密钥。

客户端通常会要求您指定一个命令来启动 MCP 服务器。常用的启动命令格式如下：

• 使用 npx (无需全局安装):

  npx -y @runbook-docs/mcp-server --base-url <您的Runbook基础URL> --api-token <您的API Token>
  

  其中 '-y' 是 npx 参数，用于自动确认安装。
• 使用全局安装命令:

  runbook-mcp-server --base-url <您的Runbook基础URL> --api-token <您的API Token>
  

某些客户端或配置方式也支持使用环境变量来提供配置：

• 设置环境变量 'RUNBOOK_BASE_URL' 为您的 Runbook 基础 URL。
• 设置环境变量 'RUNBOOK_API_TOKEN' 为您的 API Token。

请查阅您使用的 MCP 客户端的具体文档，了解如何在其中添加和配置外部 MCP 服务器。

基本使用方法:

配置并在您的 LLM 客户端中启用 Runbook MCP 服务器后，LLM 将能够感知到这个数据源及其提供的功能（工具）。您无需直接与服务器命令行交互。

您可以直接在 LLM 客户端中用自然语言提问关于 Runbook 文档的问题，例如：

• "我的 Runbook 里有哪些手册？" (LLM 可能会调用 'list-books' 工具)
• "搜索关于 [特定主题] 的文章" (LLM 可能会调用 'search-articles' 工具)
• "在手册 [手册名称/ID] 中查找关于 [特定内容] 的文章" (LLM 可能会结合 'list-books', 'list-articles', 'search-articles' 等工具)
• "获取 ID 为 ar_xxxx 的文章内容" (LLM 可能会调用 'get-article' 工具)

LLM 会根据您的提问，自动识别并调用最适合的服务器工具来获取信息，并将结果融入其回复中。