MCP Redfish Go

🚀 Redfish MCP Server (Go)

高性能なMCP（Model Context Protocol）サーバーのGo言語による実装で、Redfish対応のインフラストラクチャとのやり取りを可能にします。このサーバーは、AIエージェントやアプリケーションにRedfish APIエンドポイントへの自然言語アクセスを提供し、データセンターインフラストラクチャのインテリジェントな管理と監視を可能にします。

🚀 クイックスタート

# リポジトリをクローンする
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# サーバーをビルドする
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# 環境を設定する
export REDFISH_HOSTS='[{"address": "192.168.1.100", "username": "admin", "password": "secret"}]'

# サーバーを起動する
./bin/redfish-mcp

✨ 主な機能

• 🚀 高性能：コンパイル済みのバイナリと低メモリ使用量を持つネイティブGo実装
• 🔍 Redfish API統合：Redfish v1.x API仕様を完全にサポート
• 🤖 MCP互換：MCPクライアントとAIアシスタントとのシームレスな統合
• 🔐 セキュアな認証：Basic認証とセッションベースの認証をサポート
• 🌐 複数のトランスポート：stdio、SSE、streamable-httpトランスポートオプション
• 🔄 並行操作：Goroutineベースの並行ディスカバリとリクエスト
• 📊 構造化データアクセス：ヘッダー付きのJSONベースのリソースデータ取得
• 🛠️ 拡張可能なアーキテクチャ：カスタマイズが容易なモジュール型設計

📦 インストール

前提条件

• Go 1.21以降
• Redfish対応のインフラストラクチャへのアクセス

ソースからのビルド

# リポジトリをクローンする
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# Goモジュールを初期化する
go mod tidy

# 自分のプラットフォーム用にビルドする
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# または、複数のプラットフォーム用にビルドする
make go-build-all

事前ビルド済みバイナリ

Releasesページから最新のリリースバイナリをダウンロードできます。

• Linux (amd64)
• macOS (amd64)
• Windows (amd64)

💻 使用例

基本的な使用法

# サーバーをビルドする
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# 設定を行う
export REDFISH_HOSTS='[{"address": "192.168.1.100", "username": "admin", "password": "secret"}]'

# stdioトランスポート（デフォルト）で実行する
./bin/redfish-mcp

# または、設定ファイルを使用する
./bin/redfish-mcp --config redfish-config.json

高度な使用法

stdioトランスポート（デフォルト）

MCPクライアントとの直接統合のための標準入出力通信です。

export MCP_TRANSPORT="stdio"
./bin/redfish-mcp

SSEトランスポート（Server-Sent Events）

リモートクライアント向けのHTTPを介したネットワークベースの通信です。

export MCP_TRANSPORT="sse"
./bin/redfish-mcp
# サーバーは http://localhost:8000/sse で利用可能になります

streamable-httpトランスポート

特定のMCP実装向けの代替HTTPベースのトランスポートです。

export MCP_TRANSPORT="streamable-http"
./bin/redfish-mcp

📚 ドキュメント

MCPツール

このサーバーは、Redfishインフラストラクチャとやり取りするための2つの主要なMCPツールを提供します。

list_servers

アクセス可能なすべての構成済みRedfishサーバーをリストします。 使用例:

List all available Redfish servers

応答:

{
  "servers": ["192.168.1.100", "192.168.1.101"]
}

get_resource_data

特定のRedfishリソースエンドポイントからデータを取得します。 パラメータ:

• url: RedfishリソースのURL（例: https://192.168.1.100/redfish/v1/Systems/1） 使用例:

Get the system information from https://192.168.1.100/redfish/v1/Systems/1

応答:

{
  "headers": {
    "content-type": ["application/json"],
    "etag": ["\"12345\""]
  },
  "data": {
    "@odata.id": "/redfish/v1/Systems/1",
    "Name": "System1",
    "Manufacturer": "Example Corp"
  }
}

設定

サーバーは、環境変数またはJSONファイルを通じた設定をサポートしています。設定は起動時に検証され、適切なセットアップが確保されます。

設定方法

1. JSONファイル（複雑な設定に推奨）:

   ./bin/redfish-mcp --config config.json
   

2. 環境変数（デフォルト）:

   export REDFISH_HOSTS='[{"address": "192.168.1.100"}]'
   ./bin/redfish-mcp
   

JSON設定ファイル

完全な設定を持つconfig.jsonファイルを作成します。

{
  "redfish": {
    "hosts": [
      {
        "address": "192.168.1.100",
        "port": 443,
        "username": "admin",
        "password": "secret123",
        "auth_method": "session",
        "tls_server_ca_cert": "/path/to/ca-cert.pem"
      }
    ],
    "port": 443,
    "auth_method": "session",
    "username": "default_user",
    "password": "default_pass",
    "tls_server_ca_cert": "",
    "insecure_skip_verify": false,
    "discovery_enabled": false,
    "discovery_interval": 30
  },
  "mcp": {
    "transport": "stdio",
    "log_level": "INFO"
  }
}

SSL証明書のないサーバーへのアクセス

自己署名または無効なSSL証明書を持つRedfishサーバーでの開発またはテストのために、証明書の検証をスキップすることができます。 環境変数:

export REDFISH_INSECURE_SKIP_VERIFY=true

JSON設定:

{
  "redfish": {
    "insecure_skip_verify": true
  }
}

⚠️ 重要提示

insecure_skip_verifyは開発または信頼できる環境でのみ使用してください。このオプションはSSL証明書の検証を無効にし、接続を中間者攻撃に対して脆弱にします。

環境変数

*JSON設定ファイルを使用しない場合に必須です。

ホスト設定

REDFISH_HOSTSまたはJSONファイル内の各ホストは、以下を指定できます。

• address（必須）: IPまたはホスト名
• port（オプション）: ポート番号
• username（オプション）: ホスト固有のユーザー名
• password（オプション）: ホスト固有のパスワード
• auth_method（オプション）: basicまたはsession
• tls_server_ca_cert（オプション）: カスタムCA証明書のパス

検証

サーバーは起動時に設定を検証し、無効な場合は詳細なエラーメッセージとともに終了します。

MCPクライアントとの統合

Claude Desktop

claude_desktop_config.jsonにサーバーを追加します。

{
  "mcpServers": {
    "redfish": {
      "command": "/path/to/bin/redfish-mcp",
      "env": {
        "REDFISH_HOSTS": "[{\"address\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"secret123\"}]",
        "MCP_TRANSPORT": "stdio"
      }
    }
  }
}

VS Code with GitHub Copilot

VS Codeの設定または.vscode/mcp.jsonで構成します。

{
  "mcp": {
    "servers": {
      "redfish": {
        "command": "/path/to/bin/redfish-mcp",
        "env": {
          "REDFISH_HOSTS": "[{\"address\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"secret123\"}]",
          "MCP_TRANSPORT": "stdio"
        }
      }
    }
  }
}

MCP Inspector

MCP Inspectorでサーバーをテストします。

npx @modelcontextprotocol/inspector /path/to/bin/redfish-mcp

詳細については、VS Codeドキュメントを参照してください。

テスト

単体テスト

Goのテストスイートを実行します。

# すべてのテストを実行する
go test ./...

# レース検出を有効にして実行する
go test -race ./...

# カバレッジを有効にして実行する
go test -cover ./...

# Makefileを使用する
make go-test

MCP Inspector

MCP Inspectorでサーバーを対話的にテストします。

# ビルドしてテストする
go build -o bin/redfish-mcp ./cmd/redfish-mcp
npx @modelcontextprotocol/inspector ./bin/redfish-mcp

統合テスト

サーバーは、実際のRedfishハードウェアまたはエミュレーターに対してテストすることができます。REDFISH_HOSTS設定がアクセス可能なエンドポイントを指していることを確認してください。

開発

前提条件

• Go 1.21以降
• Git

セットアップ

# リポジトリをクローンする
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# 依存関係をインストールする
go mod tidy

# ビルドする
go build ./cmd/redfish-mcp

開発ワークフロー

# コードを整形する
go fmt ./...

# コードを静的解析する
go vet ./...

# テストを実行する
go test ./...

# 開発用にビルドする
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# サーバーを実行する
./bin/redfish-mcp

プロジェクト構造

.
├── cmd/redfish-mcp/          # メインアプリケーション
│   └── main.go              # エントリーポイント
├── pkg/                     # Goパッケージ
│   ├── config/              # 設定管理
│   │   ├── config.go        # 設定構造体と検証
│   │   ├── env.go           # 環境解析
│   │   └── config_test.go   # 単体テスト
│   ├── redfish/             # Redfishクライアントとディスカバリ
│   │   ├── client.go        # リトライロジック付きのHTTPクライアント
│   │   ├── discovery.go     # SSDPディスカバリ
│   │   └── types.go         # 型定義
│   ├── mcp/                 # MCPサーバーの実装
│   │   └── server.go        # MCPサーバーのセットアップとツール
│   └── common/              # 共有ユーティリティ
│       └── hosts.go         # ホスト管理
├── .github/workflows/       # CI/CDワークフロー
│   └── release.yml          # リリース自動化
├── Makefile                 # ビルドと開発タスク
└── README.md               # このファイル

コード品質

• 整形: go fmtで一貫した整形を行います。
• 静的解析: go vetで静的解析を行います。
• テスト: go testで包括的な単体テストを行います。
• モジュール: Goモジュールで依存関係の管理を行います。

コントリビュート

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. テストを含めて変更を行います。
4. go test ./...とgo vet ./...を実行します。
5. プルリクエストを送信します。

📄 ライセンス

このプロジェクトはApache License 2.0の下でライセンスされています。詳細については、LICENSEファイルを参照してください。

コントリビュート

コントリビューションは歓迎されます！プルリクエストを送信してください。

謝辞

• Model Context Protocol プロトコル仕様の提供
• DMTF Redfish API標準の提供
• Goコミュニティによる優れたツールとライブラリの提供