Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

README.md

Kubernetes MCP Server Documentation

Welcome to the Kubernetes MCP Server documentation! This directory contains guides to help you set up and use the Kubernetes MCP Server with your Kubernetes cluster and Claude Code CLI.

Getting Started Guides

Choose the guide that matches your needs:

Guide Description Best For
Getting Started with Kubernetes Base setup: Create ServiceAccount, token, and kubeconfig Everyone - start here first
Using with Claude Code CLI Configure MCP server with Claude Code CLI Claude Code CLI users

Recommended Workflow

  1. Complete the base setup: Start with Getting Started with Kubernetes to create a ServiceAccount and kubeconfig file
  2. Configure Claude Code: Then follow the Claude Code CLI guide

Configuration

  • Configuration Reference - Complete reference for TOML configuration files, including all options, drop-in configuration, and dynamic reload

Toolset Guides

  • Metrics - Prometheus and Alertmanager tools (metrics toolset, via obs-mcp)
  • Tracing - Grafana Tempo and TraceQL (traces toolset, via obs-mcp)
  • OpenTelemetry Collector - Component discovery, schemas, and config validation (otelcol toolset, via obs-mcp)
  • OADP - Tools for OpenShift API for Data Protection (Velero backups, restores, schedules)
  • Kiali - Tools for Kiali ServiceMesh with Istio
  • KubeVirt - KubeVirt virtual machine management tools
  • Observability - Tools for Prometheus metrics and Alertmanager alerts

Feature Specifications

Living documentation for implemented and planned features:

Spec Description Status
Validation Pre-execution validation layer (resource existence, schema, RBAC) Implemented
Structured Tool Output Conventions for tools that emit structuredContent Implemented

Advanced Topics

  • MCP Logging - Structured logging to MCP clients with automatic K8s error categorization and secret redaction
  • OpenTelemetry Observability - Distributed tracing and metrics configuration
  • MCP Prompts - Custom workflow templates for AI assistants
  • Keycloak OIDC Setup - Developer guide for local Keycloak environment and testing with MCP Inspector

Reference

  • Main README - Project overview and general information