Netbox MCP Rw

🚀 NetBox MCP Server - 読み書きエディション

NetBox用の、完全な読み取りと書き込み機能を備えた最初のモデルコンテキストプロトコル（MCP）サーバーです。

既存の読み取り専用のNetBox MCP実装とは異なり、このサーバーは包括的なCRUD（作成、読み取り、更新、削除）操作を提供します。これにより、NetBoxのデータを照会するだけでなく、MCPをサポートする大規模言語モデル（LLM）を通じて直接データを変更することが可能です。

🚀 クイックスタート

NetBox MCP Server - 読み書きエディションは、NetBox用の最初の読み書き可能なMCPサーバーです。このサーバーを使用することで、NetBoxのデータを読み取り、変更することができます。

✨ 主な機能

このサーバーの特徴

• 初の読み書き可能なNetBox MCP：NetBoxからの読み取りと書き込みの両方をサポートする唯一のMCPサーバーです。
• 完全なCRUD操作：あらゆるNetBoxオブジェクトタイプの作成、読み取り、更新、削除が可能です。
• 一括操作：一度に複数のオブジェクトを効率的に処理できます。
• 包括的なカバレッジ：主要なNetBoxモデル（DCIM、IPAM、Circuits、Virtualizationなど）をすべてサポートします。
• 本番環境での使用に適しています：適切なエラーハンドリング、検証、セキュリティ対策が施されています。

読み取り操作

• 任意のNetBoxオブジェクトタイプを一覧表示し、フィルタリングできます。
• 特定のオブジェクトに関する詳細情報を取得できます。
• 変更履歴と監査トレイルにアクセスできます。
• 高度なフィルタリングと検索機能を備えています。

書き込み操作

• 新しいデバイス、IPアドレス、サイト、ラックなどを作成できます。
• 既存のオブジェクトのプロパティを更新できます。
• オブジェクトを削除できます（適切なセーフガード付き）。
• 一括での作成、更新、削除操作が可能です。

サポートされるオブジェクトタイプ

DCIM（デバイスとインフラストラクチャ）:

• デバイス、デバイスタイプ、デバイスロール、メーカー
• サイト、ロケーション、ラック、ラックロール
• ケーブル、インターフェース、電源ポート、コンソールポート
• プラットフォーム、リージョン、仮想シャーシ

IPAM（IPアドレス管理）:

• IPアドレス、プレフィックス、VLAN、VRF
• ASN、アグリゲート、サービス
• ロール、RIR、ルートターゲット

Circuits:

• 回線、回線タイプ、プロバイダー
• 回線終端、プロバイダーネットワーク

Virtualization:

• 仮想マシン、クラスター、クラスターグループ
• クラスタータイプ、VMインターフェース

その他多数...

📦 インストール

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

git clone https://github.com/alexkiwi1/netbox-mcp-rw.git
cd netbox-mcp-rw

2. 依存関係をインストールします：

# UVを使用する場合（推奨）
uv sync

# またはpipを使用する場合
pip install -e .

3. 環境変数を設定します：

export NETBOX_URL="https://your-netbox-instance.com/"
export NETBOX_TOKEN="your-api-token"

4. サーバーをテストします：

NETBOX_URL=https://netbox.example.com/ NETBOX_TOKEN=<your-token> uv run server.py

MCPクライアントの設定

Claude Desktop（Mac/Windows）

Claude Desktopの設定に追加します：

{
  "mcpServers": {
    "netbox-rw": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/netbox-mcp-rw",
        "run",
        "server.py"
      ],
      "env": {
        "NETBOX_URL": "https://your-netbox-instance.com/",
        "NETBOX_TOKEN": "your-api-token"
      }
    }
  }
}

その他のMCPクライアント

このサーバーは、MCP互換のクライアントとすべて動作します。クライアントの要件に基づいてコマンドと引数を調整してください。

💻 使用例

データの読み取り

"ニューヨークのデータセンター内のすべてのアクティブなデバイスを表示してください"
"10.0.1.0/24サブネット内の利用可能なIPアドレスを一覧表示してください"
"先週デバイスに対して行われた変更は何ですか？"

データの書き込み

"ニューヨークのデータセンター1のラックR42に 'web-01' という名前の新しいサーバーを作成してください"
"デバイス 'firewall-01' にIPアドレス192.168.1.100/24を追加してください"
"デバイス 'switch-01' のステータスをメンテナンスモードに更新してください"
"本社サイトに 'DMZ' という名前の新しいVLAN 100を作成してください"

一括操作

"web-01からweb-10までの名前を持つ10台の新しいサーバーを作成してください"
"すべてのCiscoデバイスのプラットフォームを 'ios' に設定するように更新してください"
"廃止されたサブネット内のすべてのIPアドレスを削除してください"

📚 ドキュメント

利用可能なツール

デバイス管理

• netbox_get_objects - 任意のオブジェクトタイプを一覧表示/フィルタリングします。
• netbox_get_object_by_id - 特定のオブジェクトの詳細を取得します。
• netbox_create_object - 新しいオブジェクトを作成します。
• netbox_update_object - 既存のオブジェクトを更新します。
• netbox_delete_object - オブジェクトを削除します。
• netbox_bulk_create_objects - 一括での作成操作を行います。
• netbox_bulk_update_objects - 一括での更新操作を行います。
• netbox_bulk_delete_objects - 一括での削除操作を行います。

監査と履歴

• netbox_get_changelogs - 変更履歴と監査トレイルにアクセスします。

セキュリティ機能

• APIトークンは環境変数に保存されます（ハードコードされることはありません）。
• SSL/TLS検証はデフォルトで有効になっています。
• 適切なエラーハンドリングと検証が行われます。
• NetBoxの組み込みの変更履歴を通じて監査トレイルが保存されます。

要件

• Python 3.13以上
• APIアクセスが可能なNetBoxインスタンス
• 適切な権限を持つ有効なNetBox APIトークン

コントリビュート

これは最初の読み書き可能なNetBox MCPサーバーです。一緒に改善しましょう：

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更を加えます。
4. テストを追加します。
5. プルリクエストを送信します。

ロードマップ

• [ ] Pydanticモデルを使用した入力検証を追加する
• [ ] パフォーマンス向上のためのキャッシュを実装する
• [ ] 非同期サポートを追加する
• [ ] 包括的なテストスイートを作成する
• [ ] カスタムフィールドとプラグインのサポートを追加する

📄 ライセンス

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

謝辞

優れたFastMCPフレームワークとNetBoxの包括的なREST APIを基に構築されています。

⚠️ 重要提示

このサーバーは書き込み機能を持っています。必ず開発環境で最初にテストし、APIトークンが適切な権限を持っていることを確認してください。一括操作は一度に多くのオブジェクトを変更する可能性があるため、注意して使用してください。