Argocd MCP

🚀 Argo CD MCP 服務器

Argo CD MCP 服務器是一個用於與 Argo CD API 交互的 MCP 服務器，它能為開發者提供便捷的開發體驗，助力高效完成與 Argo CD 相關的開發任務。

✨ 主要特性

• 集成開發環境 (IDE) 友好型：支持自動補全和類型提示，讓開發者在編寫代碼時更加高效。
• 靜態類型檢查：使用 mypy 實現嚴格的代碼質量控制，提前發現類型相關的錯誤。
• 模塊化架構：清晰的代碼結構，便於維護和擴展，開發者可以輕鬆對項目進行功能添加和修改。
• 多語言支持：通過 Python 實現，兼容多種開發環境，方便不同技術棧的開發者使用。

📦 安裝指南

項目依賴管理

推薦使用 uv 包管理器進行開發：

uv init

或者使用 pip：

uv pip install --user -r requirements.txt

快速啟動調試服務器

uv run server.py

💻 使用示例

基礎用法

快速入門示例

1. 啟動調試服務器：

uv run server.py

2. 訪問 MCP Inspector 進行調試：

http://localhost:5173

3. 獲取幫助信息：

/help

4. 執行工具操作：

/tool/{tool_name}

示例用例

查詢用戶信息

uv run -m argocd.mcp.server.cli -- tool session.get_user_info

列出所有應用程序

uv run -m argocd.mcp.server.cli -- tool applications.list_applications

📚 詳細文檔

核心組件

• API 客戶端：實現與 Argo CD API 的交互通信。
• 數據模型：定義與 Argo CD 服務進行數據交換的結構體。
• 工具模塊：
  • 會話工具：用於獲取用戶信息。
  • 應用管理工具：處理應用程序的 CRUD 操作。
  • 設置工具：管理服務器配置參數。
  • 版本信息工具：提供 Argo CD 版本數據。

項目結構

代碼按照模塊化方式組織：

argocd-mcp/
├── api/              # API 客戶端和通信邏輯
│   ├── __init__.py
│   └── client.py     # Argo CD HTTP 客戶端實現
├── models/           # 數據模型定義
│   ├── __init__.py
│   └── applications.py # 應用程序數據結構
├── tools/            # MCP 工具實現
│   ├── __init__.py
│   ├── session.py    # 會話工具（用戶信息）
│   ├── applications.py # 應用管理工具
│   ├── settings.py   # 服務器設置工具
│   └── version.py    # 版本信息工具
├── utils/            # 工具函數
│   ├── __init__.py
├── server.py         # 主服務器入口點
├── pyproject.toml    # 項目配置和依賴管理
└── mypy.ini          # Mypy 類型檢查配置

開發指南

環境要求

• Python 3.12+
• MCP（包含 FastMCP 和開發工具）
• uv 包管理器（推薦）或 pip
• Argo CD API Token

類型檢查

項目使用 mypy 進行靜態類型檢查，以提升代碼質量和儘早發現與類型相關的錯誤：

# 安裝 mypy
uv pip install mypy

# 執行類型檢查
uv run -m mypy .

類型檢查配置同時存在於 pyproject.toml 和 mypy.ini 中。配置強制執行嚴格的類型規則，包括：

• 禁止未定義的類型
• 對返回 Any 類型發出警告
• 檢查函數定義的完整性
• 支持命名空間包
• 模塊特定配置

功能擴展

要添加新功能：

1. 在 tools 目錄中的適當模塊中添加新的工具。
2. 在 server.py 中註冊新的工具。
3. 遵循現有模式進行參數驗證和錯誤處理。
4. 更新 README.md 文檔。
5. 為新功能添加測試。

故障排除

遇到問題時：

1. 檢查服務器日誌（默認啟用信息日誌記錄）。
2. 注意到 正在處理 CallToolRequest 類型的請求 是 informational 日誌，不是錯誤。
3. 如果使用 mcp dev server.py，MCP Inspector 會自動在 http://localhost:5173 打開調試界面。
4. 使用服務器日誌進行 API 調用和響應的調試。
5. 對於自簽名證書問題：
   • 在 ~/.config/uv/ssl.json 中配置證書驗證策略為 INSECURE。

     uv config set --cert-validation INSECURE
     

文檔資料

• 官方文檔：Argo CD API 文檔
• 開發者指南：如何貢獻代碼
• 問題反饋：Issues 雖然列表

歡迎 Fork 和 Star 該項目，共同推動其發展！