Kdebug (Kubernetes)

🚀 KDebug - Kubernetes Debugging MCP Server

KDebug is a Kubernetes debugging tool that allows you to interact with your Kubernetes cluster through Claude AI. It uses the Model Control Protocol (MCP) to enable Claude to execute Kubernetes commands.

🚀 Quick Start

✨ Features

This tool enables you to:

• Inspect Kubernetes resources (pods, services, deployments, etc.)
• View pod logs
• Check node status
• Monitor events
• And much more, all through a conversational AI.

📦 Installation

Prerequisites

• Go 1.18+ (if building from source)
• Configured access to a Kubernetes cluster (~/.kube/config)
• A Claude client with MCP support

Option 1: Download Pre-built Binary

1. Visit the GitHub releases page:

https://github.com/soub4i/kdebug-mcp/releases

2. Download the latest version for your operating system (macOS, Linux, Windows).
3. Make the binary executable:

chmod +x kdebug-mcp

4. Move the binary to a location in your PATH:

mv kdebug-mcp /usr/local/bin/kdebug-mcp
# or 
mv kdebug-mcp ~/bin/kdebug-mcp  # if you've added ~/bin to your PATH environment variable

Option 2: Build from Source

1. Clone the repository:

git clone https://github.com/soub4i/kdebug-mcp.git
cd kdebug-mcp

2. Build the binary:

go build -o bin/server ./cmd/server/main.go

Configuration

Configure Claude to Use KDebug

Create or edit the Claude MCP configuration file located at:

• macOS: ~/Library/Application Support/com.anthropic.claude/config.json
• Linux: ~/.config/com.anthropic.claude/config.json
• Windows: %APPDATA%\com.anthropic.claude\config.json

Add the following configuration:

{
    "mcpServers": {
        "kdebug": {
            "command": "/path/to/kdebug-mcp/bin/server"
        }
    }
}

Replace /path/to/kdebug-mcp/bin/server with the actual path to your KDebug binary.

Kubernetes Context

KDebug uses your current Kubernetes context from ~/.kube/config. Ensure your Kubernetes configuration is set up correctly.

To switch contexts, use:

kubectl config use-context <context-name>

💻 Usage Examples

Basic Usage

1. Start Claude and ensure it's connected to your KDebug MCP server.
2. Ask questions about your Kubernetes resources in your conversation with Claude.

Example prompts:

• "What's wrong with my cluster? Context: minikube. Namespace: default"
• "List all nodes."
• "Show the list of pods."

Troubleshooting

Unable to Connect to the Kubernetes Cluster

Check the following:

1. Ensure the ~/.kube/config file exists and is configured correctly.
2. Use the kubectl config view --output=yaml command to verify that the context is set to the correct environment.
3. If using Minikube, run minikube status to check its status.

Unable to Start the KDebug Service

1. Ensure the KDebug executable is built correctly.
2. Run the KDebug service in the terminal and check the output for more information:

./bin/server

📄 License

⚠️ Important Note

Avoid exposing the KDebug service in a production environment unless it's protected by appropriate security measures.

Ensure the ~/.kube/config file is readable only by you and the root user to prevent unauthorized access.

KDebug provides a powerful tool to simplify the Kubernetes debugging process. By harnessing the power of Claude AI, it makes cluster management more efficient and convenient.