Runbook Documentation

🚀 Runbook MCP Server Operation Manual

This MCP server integrates with Runbook, allowing you to list, read, and search documents.

🚀 Quick Start

This MCP server integrates seamlessly with Runbook, enabling users to efficiently list, read, and search through documents.

✨ Features

Tools

• get-article
  • Retrieve an article from the database by its ID.
  • Required Inputs:
    • articleUid (string): The ID of the article to retrieve. It always starts with ar_.
• list-articles
  • List the top 100 articles in a specified book ID.
  • Required Inputs:
    • bookUid (string): The book ID. It always starts with 'bk_'. You can use list-books to get the list of books.
  • Optional Inputs:
    • q (string): Search query. If provided, the results will be filtered based on the article names.
    • categoryUid (string): The category ID. It always starts with 'ca_'. You can use list-categories to get the list of categories.
    • orderBy (string): Sorting field (updatedAt, createdAt, 'name', or 'popularity'). Default: popularity.
• list-books
  • List the top 100 books in the organization.
  • Optional Inputs:
    • q (string): Search query. If provided, the results will be filtered based on the book names.
• list-categories
  • List the top 100 categories in a specified book ID.
  • Required Inputs:
    • bookUid (string): The book ID. It always starts with 'bk_'. You can use list-books to get the list of books.
• search-articles
  • Search for articles based on a query string.
  • Required Inputs:
    • keywords (string): Space-separated keywords to filter articles.
  • Optional Inputs:
    • scope (string): The ID of the book or workspace. You can use list-books to get the list of books.
    • limit (number): The number of articles to retrieve.
    • offset (number): The offset of the search results.
    • orderBy (string): Sorting field (updatedAt, createdAt, or 'score'). Default: score.

📦 Installation

Requirements

• Node.js >= v20.0.0

Integration with Desktop Applications

To integrate this server with a desktop application, add the following to the application's server configuration:

Configure Claude Desktop

Add the following to your 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"
      }
    }
  }
}

Configure Cursor

Add the MCP server using the following command:

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

📄 License

This MCP server is released under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.