Runbook Documentation

🚀 Runbook MCP サーバー運用マニュアル

この MCP サーバーは Runbook と統合されており、ドキュメントの一覧表示、閲覧、検索が可能です。

🚀 クイックスタート

この MCP サーバーは Runbook と統合されており、ドキュメントの一覧表示、閲覧、検索が可能です。

✨ 主な機能

この MCP サーバーは、Runbook との統合を通じて、ドキュメントの管理機能を提供します。具体的には、文章の取得、一覧表示、検索などの操作が可能です。

📦 インストール

要件

• Node.js >= v20.0.0

デスクトップアプリとの統合使用

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

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 ファイルを参照してください。