Kubernetes Monitoring

🚀 k8s-mcp

A Python-based read-only Kubernetes cluster Model Context Protocol (MCP) server that provides a comprehensive API to retrieve cluster information and diagnose issues.

Example chat using Claude

🚀 Quick Start

Installation

Prerequisites

• Python 3.8+
• Access to a Kubernetes cluster (via kubeconfig or in-cluster configuration)
• Required Python packages (see dependencies in pyproject.toml)

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone git@github.com:vlttnv/k8s-mcp.git
cd k8s-mcp

# Install dependencies
uv venv
source .venv/bin/activate
uv sync

If you are using Claude, configure your desktop application settings. Open ~/Library/Application Support/Claude/claude_desktop_config.json in a text editor:

code ~/Library/Application\ Support/Claude/claude_desktop_config.json

{
    "mcpServers": {
        "k8s-mcp": {
            "command": "uv",
            "args": [
                "--directory",
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/k8s-mcp",
                "run",
                "server.py"
            ]
        }
    }
}

⚠️ Important Note

You may need to specify the full path to the uv executable in the command field if necessary. You can obtain it by running which uv (macOS/Linux) or where uv (Windows).

Configuration

The application automatically tries two methods to connect to your Kubernetes cluster:

1. Kubeconfig file: Use the local kubeconfig file (usually located at ~/.kube/config).
2. In-Cluster Configuration: If running inside a Kubernetes pod, use the service account token.

No additional configuration is required if your kubeconfig is set up correctly or you are running inside the cluster with appropriate RBAC permissions.

Usage Instructions

Installation Steps

1. Clone the repository and enter the directory.
2. Create and activate a virtual environment using the uv tool.
3. Synchronize dependencies and start the service.

Usage Examples

Basic Usage

# Basic command example
uv run server.py

📄 License

MIT License

✨ Contribution

Contributions are welcome! Please feel free to submit a Pull Request.