Runbook Documentation

🚀 Runbook MCP 服務器運行手冊

此 MCP 服務器與 Runbook 集成，可實現文檔的列出、閱讀和搜索功能，為用戶提供便捷的文檔管理體驗。

🚀 快速開始

此 MCP 服務器與 Runbook 集成，允許列出、閱讀和搜索文檔。使用前請確保滿足以下要求：

• Node.js >= v20.0.0

✨ 主要特性

• 集成 Runbook，可對文檔進行列出、閱讀和搜索操作。
• 提供多種工具，滿足不同的文檔查詢需求。

📦 安裝指南

要將此服務器與桌面應用程序集成，請在應用程序的服務器配置中添加以下內容：

配置 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

📚 詳細文檔

組件

工具

• 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。

📄 許可證

此 MCP 服務器根據 MIT 許可證發佈。這意味著您可以自由使用、修改和分發軟件，但需遵守 MIT 許可證的條款和條件。有關詳細信息，請參閱項目存儲庫中的 LICENSE 文件。