Runbook Documentation

🚀 Runbook MCP 服务器运行手册

此 MCP 服务器与 Runbook 集成，可用于列出、阅读和搜索文档，为用户提供便捷的文档管理与查询服务。

🚀 快速开始

本 MCP 服务器与 Runbook 集成，允许用户对文档进行列出、阅读和搜索等操作。使用前请确保满足以下要求，同时了解各组件的使用方法和集成配置方式。

✨ 主要特性

• 与 Runbook 集成，实现文档的多种操作。
• 提供多个工具组件，可根据不同需求获取文章、书籍、类别等信息。
• 支持与桌面应用集成，方便在不同环境下使用。

📦 安装指南

要求

• Node.js >= v20.0.0

💻 使用示例

工具使用

get-article

根据其 ID 从数据库中获取文章。
必填输入：
  - `articleUid`（字符串）：要检索的文章 ID。它始终以 `ar_` 开头。

list-articles

列出指定书籍 ID 中的前 100 篇文章。
必填输入：
  - `bookUid`（字符串）：书籍 ID。它始终以 'bk_' 开头。您可以使用 `list-books` 获取书籍列表。
可选输入：
  - `q`（字符串）：搜索查询。如果提供，结果将根据文章名称进行过滤。
  - `categoryUid`（字符串）：类别 ID。它始终以 'ca_' 开头。您可以使用 `list-categories` 获取类别的列表。
  - `orderBy`（字符串）：排序字段（updatedAt、createdAt、'name' 或 'popularity'）。默认值： popularity。

list-books

列出组织中的前 100 本书籍。
可选输入：
  - `q`（字符串）：搜索查询。如果提供，结果将根据书名进行过滤。

list-categories

在指定书籍 ID 中列出前 100 个类别。
必填输入：
  - `bookUid`（字符串）：书籍 ID。它始终以 'bk_' 开头。您可以使用 `list-books` 获取书籍列表。

search-articles

根据查询字符串搜索文章。
必填输入：
  - `keywords`（字符串）：空格分隔的关键词，用于过滤文章。
可选输入：
  - `scope`（字符串）：书籍或工作区的 ID。您可以使用 `list-books` 获取书籍列表。
  - `limit`（数字）：要检索的文章数量。
  - `offset`（数字）：搜索结果的偏移量。
  - `orderBy`（字符串）：排序字段（updatedAt、createdAt 或 'score'）。默认值： score。

与桌面应用集成使用

配置 Claude Desktop

在您的 claude_desktop_config.json 中添加以下内容：

{
  "mcpServers": {
    "runbook": {
      "command": "npx",
      "args": [
        "-y",
        "@runbook-docs/mcp-server"
      ],
      "env": {
        "RUNBOOK_BASE_URL": "https://<YOUR_SUBDOMAIN>.runbook.jp",
        "RUNBOOK_API_TOKEN": "your-api-token"
      }
    }
  }
}

配置 Cursor

使用以下命令添加 MCP 服务器。

npx -y @runbook-docs/mcp-server --api-token=your-api-tokan --base-url=https://yourdomain.runbook.jp

📄 许可证

此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关详细信息，请参阅项目存储库中的 LICENSE 文件。