MCP Opsbeacon Server

🚀 MCP 作戦号令サーバー

このサーバーは、Opsbeacon 操作のための Model Context Protocol (MCP) の実装です。Claude を通じて Opsbeacon API とやり取りすることができ、コマンドの一覧表示や接続などの機能を提供します。

🚀 クイックスタート

この MCP 作戦号令サーバーを使用することで、Claude を介して Opsbeacon API とのやり取りが可能になります。以下に、サーバーのセットアップと使用方法を説明します。

✨ 主な機能

• 利用可能な Opsbeacon コマンドを一覧表示する
• 利用可能な Opsbeacon 接続を一覧表示する
• bearer token を使用した認証
• エラー処理とログ記録
• 構造化された JSON 応答を返す

📦 インストール

前提条件

• Python 3.10 以上
• Opsbeacon API へのアクセス権
• 有効な bearer token

インストール手順

1. リポジトリをクローンします：

git clone [repository-url]
cd mcp-opsbeacon-server

2. パッケージをインストールします：

pip install -e .

📚 ドキュメント

設定方法

Opsbeacon の設定を提供する方法は3つあります。

オプション1：Claude デスクトップと一緒に使用する場合

MCP サーバーを Claude と一緒に使用する場合は、Claude Desktop の設定ファイルに必要な設定を追加します：

{
  "mcpServers": {
    "opsbeacon": {
      "command": "python",
      "args": [
        "-m",
        "mcp_opsbeacon_server"
      ],
      "env": {
        "OPSBEACON_TOKEN": "your-bearer-token-here",
        "OPSBEACON_BASE_URL": "your-base-url-here"
      }
    }
  }
}

オプション2：環境変数を使用する場合

必要な環境変数を直接設定することができます：

export OPSBEACON_TOKEN="your-bearer-token-here"
export OPSBEACON_BASE_URL="your-base-url-here"

オプション3：.env ファイルを使用する場合（開発時に推奨）

プロジェクトのルートディレクトリに .env ファイルを作成します。提供されているテンプレートを使用できます：

cp .env.example .env

その後、.env ファイルを編集して実際の値を入力します：

OPSBEACON_TOKEN=your-bearer-token-here
OPSBEACON_BASE_URL=your-base-url-here  # オプション、デフォルトは https://api.console.opsbeacon.com

.env ファイルは、機密情報のコミットを防ぐために git で無視されます。

ベース URL の設定

OPSBEACON_BASE_URL の設定はオプションです。指定されていない場合、以下の URL がデフォルトで使用されます：

https://api.console.opsbeacon.com

このデフォルト値は、環境変数や .env ファイルなどの任意の設定方法で上書きすることができます。

設定の優先順位

これらのオプションを同時に使用することができます。複数のオプションが使用された場合、優先順位は以下の通りです：

1. 環境変数
2. .env ファイル
3. Claude 設定ファイル
4. デフォルトのベース URL

テスト方法

サーバーの機能をテストするには、必要な変数を設定し（開発時には .env ファイルの使用を推奨）、以下のコマンドを実行します：

python test_server.py

使用方法

利用可能なツール

1. list_commands

   • 利用可能なすべての Opsbeacon コマンドを一覧表示します
   • 追加のパラメータは必要ありません
   • コマンドの詳細情報を JSON 形式で返します

2. list_connections

   • 利用可能なすべての Opsbeacon 接続を一覧表示します
   • 追加のパラメータは必要ありません
   • 接続の詳細情報を JSON 形式で返します

Claude での使用例

Human: コマンドを一覧表示して。
Claude: 以下のコマンドを実行します：`list_commands`

結果：
利用可能なすべてのコマンドのリストが返されます。

エラー処理

• 有効な bearer token がない場合、保護されたエンドポイントにアクセスできません
• ベース URL が無効またはサーバーに接続できない場合、接続エラーが発生する可能性があります
• リクエストパラメータが無効な場合、検証エラーが返される可能性があります

開発方法

新しい機能を追加したり、既存のコードを変更したりするには、以下の手順に従ってください：

1. リポジトリをクローンし、依存関係をインストールします
2. 必要な機能を実装するためにコードを変更します
3. 機能が正常に動作することを確認するためにテストケースを追加します
4. 変更をコミットし、プルリクエストを作成します

完了したら、新しい機能や変更を反映するためにドキュメントを更新することをおすすめします。