MCP Nautobot

🚀 MCP-Nautobot

Nautobotネットワーク自動化プラットフォーム用のModel Context Protocol (MCP)サーバーです。このプロジェクトにより、AIアシスタントがNautobotインスタンスとやり取りし、ネットワークインベントリデータにアクセスできるようになります。

免責事項: このプロジェクトは、Anthropic、Claude、またはNautobotと公式に関連付けられていません。Nautobot統合のためのModel Context Protocolの独立した実装です。

🚀 クイックスタート

このセクションでは、MCP-Nautobotを迅速にセットアップし、使用するための基本的な手順を説明します。

✨ 主な機能

• 非同期API：最新の非同期Pythonで構築されています。
• MCP互換：Claudeやその他のMCP互換のAIアシスタントと連携します。
• Nautobot統合：直接ネットワークインベントリデータをクエリできます。
• サイト情報：詳細なサイトの場所データを取得できます。
• デバイス詳細：デバイスの仕様や設定にアクセスできます。
• ネットワークトポロジ：ネットワークの接続と関係を視覚化できます。
• ロールベースのアクセス：ユーザーロールによってデータアクセスを制御できます。
• 柔軟な設定：データの表示をカスタマイズできます。

📦 インストール

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

# 仮想環境を作成してアクティブ化する
# uvがインストールされていない場合は、https://github.com/astral-sh/uv の手順に従ってください
uv venv
source .venv/bin/activate  # Windowsの場合: .venv\Scripts\activate

# 依存関係をインストールする
uv pip install -e .  # pyproject.tomlを使用した編集可能なインストールにはpip 21.3+が必要です

📚 ドキュメント

設定

サンプルの環境ファイルをコピーし、自分の設定で更新します。

cp .env.example .env
# 好きなエディタで.envを編集する

環境変数

⚠️ 重要提示

.envファイルをバージョン管理にコミットしないでください。これには機密性の高いAPIトークンが含まれています。

詳細な設定オプションについては、docs/CONFIGURATION.mdを参照してください。

使用方法

サーバーの起動

# MCPサーバーを起動する
python -m mcp_nautobot.server

# または提供されているCLIを使用する
mcp-nautobot-server

サーバーはデフォルトでhttp://127.0.0.1:8000で起動します。

Claude Desktopとの統合

1. Claude Desktopを開き、設定 > ツール > カスタムツールの設定に移動します。
2. 次の詳細で新しいツールを追加します。
   • 名前：Nautobot Network Data
   • 説明：Nautobotからネットワークインベントリデータにアクセスします。
   • スキーマタイプ：MCP
   • エンドポイントURL：http://127.0.0.1:8000 (またはカスタムのホスト/ポート)
3. 接続を保存してテストします。

これで、Claudeにネットワークインベントリに関する質問をすることができます。

• "米国西部地域にあるサイトはどれですか？"
• "シカゴのデータセンター内のすべてのデバイスを表示してください。"
• "ネットワーク内のすべてのCiscoスイッチをリストアップしてください。"
• "アトランタのコアルーターのIPアドレスは何ですか？"

開発者ガイド

テスト

# 開発用の依存関係をインストールする
uv pip install -e ".[dev]"

# テストを実行する
pytest

# カバレッジ付きでテストを実行する
pytest --cov=mcp_nautobot

コードスタイルとリント

このプロジェクトはPEP 8ガイドラインに従い、Blackとisortを使用してフォーマットします。

# コードをフォーマットする
black mcp_nautobot tests
isort mcp_nautobot tests

# コードをリントする
flake8 mcp_nautobot tests
mypy mcp_nautobot

ロードマップ

• デバイス設定の取得：実行中のデバイス設定にアクセスできるようにする。
• トポロジの視覚化：ネットワークマップやダイアグラムを生成する。
• マルチテナントサポート：強化されたロールベースのアクセス制御。
• 回線情報：WAN回線とプロバイダーに関するデータ。
• パフォーマンスデータ：過去のパフォーマンスメトリクスの統合。

コントリビュート

コントリビューションは大歓迎です！始めるには、Contributing Guideをご確認ください。

問題が発生した場合や機能要求がある場合は、issueを作成してください。

トラブルシューティング

問題が発生した場合は、トラブルシューティングガイドを確認するか、GitHubでissueを作成してください。

📄 ライセンス

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

謝辞

• このプロジェクトはModel Context Protocolを実装しています。
• Nautobotとの統合のために構築されています。
• AnthropicやClaudeと公式に関連付けられていません。