Argocd MCP

🚀 Argo CD MCP Server

An MCP server for interacting with the Argo CD API.

🚀 Quick Start

Basic Usage Example

1. Start the debug server:

uv run server.py

2. Access the MCP Inspector for debugging:

http://localhost:5173

3. Get help information:

/help

4. Execute tool operations:

/tool/{tool_name}

✨ Features

• IDE-Friendly: Supports autocompletion and type hints.
• Static Type Checking: Implements strict code quality control using mypy.
• Modular Architecture: Clear code structure for easy maintenance and expansion.
• Multi-Language Support: Implemented in Python, compatible with various development environments.

📦 Installation

Project Dependency Management

It is recommended to use the uv package manager for development:

uv init

Alternatively, use pip:

uv pip install --user -r requirements.txt

Start the Debug Server

uv run server.py

🔧 Technical Details

Core Components

• API Client: Implements communication with the Argo CD API.
• Data Model: Defines the data structures for data exchange with the Argo CD service.
• Tool Modules:
  • Session Tool: Used to obtain user information.
  • Application Management Tool: Handles CRUD operations for applications.
  • Settings Tool: Manages server configuration parameters.
  • Version Information Tool: Provides Argo CD version data.

Project Structure

The code is organized in a modular way:

argocd-mcp/
├── api/              # API client and communication logic
│   ├── __init__.py
│   └── client.py     # Argo CD HTTP client implementation
├── models/           # Data model definitions
│   ├── __init__.py
│   └── applications.py # Application data structure
├── tools/            # MCP tool implementation
│   ├── __init__.py
│   ├── session.py    # Session tool (user information)
│   ├── applications.py # Application management tool
│   ├── settings.py   # Server settings tool
│   └── version.py    # Version information tool
├── utils/            # Utility functions
│   ├── __init__.py
├── server.py         # Main server entry point
├── pyproject.toml    # Project configuration and dependency management
└── mypy.ini          # Mypy type checking configuration

💻 Usage Examples

Basic Usage

Query User Information

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

List All Applications

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

📚 Documentation

Development Guide

Environment Requirements

• Python 3.12+
• MCP (including FastMCP and development tools)
• uv package manager (recommended) or pip
• Argo CD API Token

Type Checking

The project uses mypy for static type checking to improve code quality and detect type-related errors early:

# Install mypy
uv pip install mypy

# Perform type checking
uv run -m mypy .

The type checking configuration exists in both pyproject.toml and mypy.ini. The configuration enforces strict type rules, including:

• Prohibiting undefined types
• Warning about returning the Any type
• Checking the completeness of function definitions
• Supporting namespace packages
• Module-specific configuration

Feature Expansion

To add new features:

1. Add new tools in the appropriate module in the tools directory.
2. Register the new tools in server.py.
3. Follow the existing pattern for parameter validation and error handling.
4. Update the README.md documentation.
5. Add tests for the new features.

Troubleshooting

When encountering issues:

1. Check the server logs (info logging is enabled by default).
2. Note that the log message Processing a request of type CallToolRequest is an informational log, not an error.
3. If using mcp dev server.py, the MCP Inspector will automatically open the debugging interface at http://localhost:5173.
4. Use the server logs to debug API calls and responses.
5. For self-signed certificate issues:
   • Configure the certificate validation policy to INSECURE in ~/.config/uv/ssl.json.

     uv config set --cert-validation INSECURE
     

Documentation Resources

• Official Documentation: Argo CD API Documentation
• Developer Guide: How to Contribute
• Issue Reporting: Issue List

Welcome to fork and star this project to contribute to its development!