Argo CD MCP Server

An implementation of Model Context Protocol (MCP) server for Argo CD, enabling AI assistants to interact with your Argo CD applications through natural language. This server allows for seamless integration with Visual Studio Code and other MCP clients through both stdio and Server-Sent Events (SSE) transport protocols.

<!-- // Generate using?: const config = JSON.stringify({ "name": "argocd-mcp", "command": "npx", "args": ["argocd-mcp@latest", "stdio"], "env": { "ARGOCD_BASE_URL": "<argocd_url>", "ARGOCD_API_TOKEN": "<argocd_token>" } }); const urlForWebsites = vscode:mcp/install?${encodeURIComponent(config)}; // Github markdown does not allow linking to vscode: directly, so you can use our redirect: const urlForGithub = https://insiders.vscode.dev/redirect?url=${encodeURIComponent(urlForWebsites)}; -->

<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code"> <img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">

This project is maintained by Akuity, the creators of Argo Project.

<img align="center" src="https://raw.githubusercontent.com/akuity/argocd-mcp/main/images/akuity.png" alt="akuity" width="50%" height="50%">

Akuity is the enterprise company for Argo and Kargo, and provides the essential platform for end-to-end GitOps for Kubernetes. With the Akuity Platform, enterprises can deploy with managed Argo CD, promote seamlessly with Kargo, and gain real-time visibility into their infrastructure using Akuity Monitoring. Akuity was founded by Argo creators Hong Wang, Jesse Suen, and Alexander Matyushentsev, with a mission to empower both Platform and Application teams with the best tools for GitOps at enterprise scale.

Features

• Transport Protocols: Supports both stdio and SSE transport modes for flexible integration with different clients
• Complete Argo CD API Integration: Provides comprehensive access to Argo CD resources and operations
• AI Assistant Ready: Pre-configured tools for AI assistants to interact with Argo CD in natural language

Installation

Prerequisites

• Node.js (v18 or higher recommended)
• pnpm package manager (for development)
• Argo CD instance with API access

Usage with Cursor

1. Follow the Cursor documentation for MCP support, and create a .cursor/mcp.json file in your project:

{
  "mcpServers": {
    "argocd-mcp": {
      "command": "npx",
      "args": [
        "argocd-mcp@latest",
        "stdio"
      ],
      "env": {
        "ARGOCD_BASE_URL": "<argocd_url>",
        "ARGOCD_API_TOKEN": "<argocd_token>"
      }
    }
  }
}

2. Start a conversation with Agent mode to use the MCP.

Usage with VSCode

1. Follow the Use MCP servers in VS Code documentation, and create a .vscode/mcp.json file in your project:

{
  "servers": {
    "argocd-mcp-stdio": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "argocd-mcp@latest",
        "stdio"
      ],
      "env": {
        "ARGOCD_BASE_URL": "<argocd_url>",
        "ARGOCD_API_TOKEN": "<argocd_token>"
      }
    }
  }
}

2. Start a conversation with an AI assistant in VS Code that supports MCP.

Usage with Claude Desktop

1. Follow the MCP in Claude Desktop documentation, and create a claude_desktop_config.json configuration file:

{
  "mcpServers": {
    "argocd-mcp": {
      "command": "npx",
      "args": [
        "argocd-mcp@latest",
        "stdio"
      ],
      "env": {
        "ARGOCD_BASE_URL": "<argocd_url>",
        "ARGOCD_API_TOKEN": "<argocd_token>"
      }
    }
  }
}

2. Configure Claude Desktop to use this configuration file in settings.

Available Tools

The server provides the following ArgoCD management tools:

Application Management

• list_applications: List and filter all applications
• get_application: Get detailed information about a specific application
• create_application: Create a new application
• update_application: Update an existing application
• delete_application: Delete an application
• sync_application: Trigger a sync operation on an application

Resource Management

• get_application_resource_tree: Get the resource tree for a specific application
• get_application_managed_resources: Get managed resources for a specific application
• get_application_workload_logs: Get logs for application workloads (Pods, Deployments, etc.)
• get_resource_events: Get events for resources managed by an application
• get_resource_actions: Get available actions for resources
• run_resource_action: Run an action on a resource

For Development

1. Clone the repository:

git clone https://github.com/akuity/argocd-mcp.git
cd argocd-mcp

2. Install project dependencies:

pnpm install

3. Start the development server with hot reloading enabled:

# For SSE mode with hot reloading
pnpm run dev

Once the server is running, you can utilize the MCP server within Visual Studio Code or other MCP client.

Upgrading ArgoCD Types

To update the TypeScript type definitions based on the latest Argo CD API specification:

1. Download the swagger.json file from the ArgoCD release page, for example here is the swagger.json link for ArgoCD v2.14.11.

2. Place the downloaded swagger.json file in the root directory of the argocd-mcp project.

3. Generate the TypeScript types from the Swagger definition by running the following command. This will create or overwrite the src/types/argocd.d.ts file:

   pnpm run generate-types
   

4. Update the src/types/argocd-types.ts file to export the required types from the newly generated src/types/argocd.d.ts. This step often requires manual review to ensure only necessary types are exposed.