MCP Nautobot

🚀 MCP-Nautobot

MCP-Nautobot 是一個適用於 Nautobot 網絡自動化平臺的模型上下文協議（MCP）服務器。該項目允許 AI 助手與你的 Nautobot 實例進行交互，從而訪問網絡庫存數據。

⚠️ 重要提示

本項目與 Anthropic、Claude 或 Nautobot 沒有官方關聯。它是用於 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 網絡數據
   • 描述：從 Nautobot 訪問網絡庫存數據
   • 架構類型：MCP
   • 端點 URL：http://127.0.0.1:8000（或你的自定義主機/端口）
3. 保存並測試連接

現在你可以向 Claude 詢問有關網絡庫存的問題：

• “我們在美國西部地區有哪些站點？”
• “顯示芝加哥數據中心的所有設備。”
• “列出我們網絡中的所有思科交換機。”
• “亞特蘭大核心路由器的 IP 地址是什麼？”

開發者指南

測試

# 安裝開發依賴
uv pip install -e ".[dev]"

# 運行測試
pytest

# 運行帶覆蓋率的測試
pytest --cov=mcp_nautobot

代碼風格和 linting

本項目遵循 PEP 8 指南，並使用 Black 和 isort 進行格式化。

# 格式化代碼
black mcp_nautobot tests
isort mcp_nautobot tests

# 代碼 linting
flake8 mcp_nautobot tests
mypy mcp_nautobot

路線圖

• 設備配置檢索：訪問設備的運行配置。
• 拓撲可視化：生成網絡地圖和圖表。
• 多租戶支持：增強基於角色的訪問控制。
• 電路信息：有關廣域網電路和提供商的數據。
• 性能數據：集成歷史性能指標。

貢獻

歡迎貢獻代碼！請查看我們的 貢獻指南 以開始貢獻。

如果你遇到任何問題或有功能請求，請 提交一個 issue。

📄 許可證

本項目採用 MIT 許可證 - 詳情請參閱 LICENSE 文件。

致謝

• 本項目實現了 模型上下文協議。
• 為與 Nautobot 集成而構建。
• 與 Anthropic 或 Claude 沒有官方關聯。

故障排除

如果你遇到問題，請查看 故障排除指南 或在 GitHub 上提交一個 issue。