Runbook MCP server

Runbook MCP サーバー

この MCP サーバーはRunbookと連携し、ドキュメントの一覧表示、読み取り、検索を可能にします。

コンポーネント

ツール

• get-article
  • データベースから ID を指定して記事を取得します。
  • 必須の入力：
    • articleUid (string)：取得する記事の ID です。必ず ar_ で始まります。
• list-articles
  • 指定した ID のブックにある上位 100 件の記事を一覧表示します。結果には記事本文全体は含まれず、200 文字に切り詰められます。完全な内容を取得するには、get-article を呼び出してください。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。`list-books` でブックの一覧を取得できます。
  • 任意の入力：
    • articleName (string)：指定すると、記事名で結果を絞り込みます。
    • categoryUid (string)：カテゴリの ID です。必ず 'ca_' で始まります。`list-categories` でカテゴリの一覧を取得できます。
    • orderBy (string)：並べ替えに使うフィールド（updatedAt、createdAt、'name'、または 'popularity'）です。
• create-article
  • 指定した ID のブックに新しい記事を作成します。記事本文は Markdown 形式です。記事はブックのルートフォルダーに作成されます。記事には ID でカテゴリを指定できます。カテゴリ ID は必ず 'ca_' で始まります。`list-books` でブックの一覧を、`list-categories` でカテゴリの一覧を取得できます。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。`list-books` でブックの一覧を取得できます。
    • name (string)：作成する記事の名前です。
  • 任意の入力：
    • bodyMarkdown (string)：Markdown 形式の記事本文です。指定しない場合、空の記事が作成されます。
    • categoryUids (array)：記事に割り当てるカテゴリの ID です。各 ID は 'ca_' で始まります。`list-categories` でカテゴリの一覧を取得できます。
• update-article
  • ID を指定して既存の記事を更新します。記事本文は Markdown 形式です。記事には ID でカテゴリを指定できます。カテゴリ ID は必ず 'ca_' で始まります。
  • 必須の入力：
    • articleUid (string)：更新する記事の ID です。必ず ar_ で始まります。`list-articles` で記事の一覧を取得できます。
  • 任意の入力：
    • name (string)：更新する記事の名前です。
    • bodyMarkdown (string)：Markdown 形式の記事本文です。指定しない場合、本文は更新されません。
    • categoryUids (array)：記事に割り当てるカテゴリの ID です。各 ID は 'ca_' で始まります。`list-categories` でカテゴリの一覧を取得できます。
• list-books
  • 組織内の上位 100 件のブックを一覧表示します。
  • 任意の入力：
    • bookName (string)：指定すると、ブック名で結果を絞り込みます。
• list-categories
  • 指定した ID のブックにある上位 100 件のカテゴリを一覧表示します。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。`list-books` でブックの一覧を取得できます。
• get-folder
  • 祖先と子（サブフォルダーと記事）を含む、ブック内のフォルダーを取得します。folderUid が指定されていない場合、ブックのルートフォルダーが取得されます。結果に含まれる記事の情報は名前と UID のみです。記事本文全体を取得するには、`get-article` を呼び出してください。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。`list-books` でブックの一覧を取得できます。
  • 任意の入力：
    • folderUid (string)：フォルダーの ID です。必ず 'fo_' で始まります。指定されていない場合、ブックのルートフォルダーが使用されます。
• search-articles
  • Runbook のキーワードを使って記事を検索します。結果には記事本文全体は含まれず、200 文字に切り詰められます。完全な内容を取得するには、`get-article` を呼び出してください。
  • 必須の入力：
    • keywords (string)：記事を絞り込むための、スペース区切りのキーワードです。複数のキーワードを指定した場合、それらすべてに一致する記事が返されます。キーワードには現在の言語を使用してください。
  • 任意の入力：
    • scope (string)：ブックまたはワークスペースの ID です。指定すると、それらで結果を絞り込みます。デフォルト：すべて。
    • limit (number)：取得する記事の件数です。
    • offset (number)：検索結果のオフセットです。
    • orderBy (string)：並べ替えに使うフィールド（updatedAt、createdAt、または 'score'）です。デフォルト：score。
• list-assigned-processes
  • 現在のユーザーに割り当てられていて、まだ処理されていない進行中のプロセス（ワークフローの実行状態）の一覧を取得します。最大 20 件が返され、各項目には実行状態の UID（'rs_' で始まります）、ステータス、作成日、および所属するブックが含まれます。返された book.uid と実行状態の uid を get-process で使用すると、プロセスの詳細を確認できます。
  • 入力なし。
• get-process
  • ブック UID で現在のプロセス情報を取得します。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。ブックの種類は 'workflow' である必要があります。
  • 任意の入力：
    • runStateUid (string)：実行状態の ID です。必ず 'rs_' で始まります。指定しない場合、最初の実行状態が使用されます。
• run-process
  • 新しいプロセスを開始するか、既存のプロセスを続行するためのツールです。実行状態 UID が指定されていない場合、新しいプロセスが作成されます。
  • 必須の入力：
    • bookUid (string)：ブックの ID です。必ず 'bk_' で始まります。ブックの種類は 'workflow' である必要があります。
    • articleUid (string)：記事の ID です。必ず 'ar_' で始まります。記事 UID は `get-process` および `run-process` の戻り値に含まれます。
  • 任意の入力：
    • runStateUid (string)：実行状態の ID です。必ず 'rs_' で始まります。指定しない場合、新しいプロセスが作成されます。
    • propertyValues (object)：プロセスに渡すプロパティ値です。キーは文字列、値は文字列または string[] のオブジェクトです。プロパティは記事本文内の `::::input` 要素に対応します。type="checkbox" の入力要素のみ、string[] 型を使用できます。

要件

• Node.js >= v20.0.0

デスクトップアプリでの使用

このサーバーをデスクトップアプリに統合するには、アプリのサーバー設定に以下を追加してください。

Claude Desktop の設定

推奨：デスクトップ拡張機能（.mcpb）としてインストール

最も簡単にセットアップするには、リリースページから .mcpb ファイルをダウンロードしてインストールしてください。Claude Desktop で MCP サーバーが自動的に設定されます。デスクトップ拡張機能の詳細については、Anthropic のドキュメントをご覧ください。

手動設定

または、以下を 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

Markdown 形式

記事を作成または更新する際、本文では以下の要素をサポートする Markdown 形式を使用します。

• 見出し：## H2、### H3、#### H4。# H1 は記事タイトル用に予約されているため、使用しないでください。
• 太字：**bold text**
• 斜体：_italic text_
• リスト：- item または 1. numbered item
• リンク：[text](url)
• コードブロック：

  ```
  code
  ```
  

• 表：

  | col1 | col2 |
  | --- | --- |
  | data | data |
  

• 引用：> quoted text
• コールアウト：

  :::callout info
  text
  :::
  

  :::callout warning
  text
  :::
  

• 図：

  ```mermaid
  graph TD;
  ```
  

ライセンス

この MCP サーバーは MIT ライセンスのもとでライセンスされています。つまり、MIT ライセンスの利用規約に従う限り、このソフトウェアを自由に使用、変更、配布できます。詳細については、プロジェクトリポジトリの LICENSE ファイルをご覧ください。