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 该项目，共同推动其发展！