MCP K8s Eye

1## mcp-k8s-eye
2 
3mcp-k8s-eye is a tool that can manage kubernetes cluster and analyze workload status.
4 
5## Features
6 
7### Core Kubernetes Operations
8- [x] Connect to a Kubernetes cluster
9- [x] **Generic Kubernetes Resources** management capabilities
10  - Support all navtie resources: Pod, Deployment, Service, StatefulSet, Ingress...
11  - Support CustomResourceDefinition resources
12  - Operations include: list, get, create, update, delete
13- [x] Pod management capabilities (exec, logs)
14- [x] Deployment management capabilities (scale)
15- [x] Describe Kubernetes resources
16- [ ] Explain Kubernetes resources
17 
18 
19### Diagnostics
20- [x] Pod diagnostics (analyze pod status, container status, pod resource utilization)
21- [x] Service diagnostics (analyze service selector configuration, not ready endpoints, events)
22- [x] Deployment diagnostics (analyze available replicas)
23- [x] StatefulSet diagnostics (analyze statefulset service if exists, pvc if exists, available replicas)
24- [x] CronJob diagnostics (analyze cronjob schedule, starting deadline, last schedule time)
25- [x] Ingress diagnostics (analyze ingress class configuration, related services, tls secrets)
26- [x] NetworkPolicy diagnostics (analyze networkpolicy configuration, affected pods)
27- [x] ValidatingWebhook diagnostics (analyze webhook configuration, referenced services and pods)
28- [x] MutatingWebhook diagnostics (analyze webhook configuration, referenced services and pods)
29- [x] Node diagnostics (analyze node conditions)
30- [ ] Cluster diagnostics and troubleshooting 
31 
32### Monitoring
33- [x] Pod, Deployment, ReplicaSet, StatefulSet, DaemonSet workload resource usage (cpu, memory)
34- [ ] Node capacity, utilization (cpu, memory)
35- [ ] Cluster capacity, utilization (cpu, memory)
36 
37### Advanced Features
38- [x] Multiple transport protocols support (Stdio, SSE)
39- [x] Support multiple AI Clients
40 
41 
42## Tools Usage
43 
44### Resource Operation Tools
45- `resource_get`: Get detailed resource information about a specific resource in a namespace
46- `resource_list`: List detailed resource information about all resources in a namespace 
47- `resource_create_or_update`: Create or update a resource in a namespace
48- `resource_delete`: Delete a resource in a namespace
49- `resource_describe`: Describe a resource detailed information in a namespace
50- `deployment_scale`: Scale a deployment in a namespace
51- `pod_exec`: Execute a command in a pod in a namespace`
52- `pod_logs`: Get logs from a pod in a namespace
53 
54###  Diagnostics Tools
55- `pod_analyze`: Diagnose all pods in a namespace
56- `deployment_analyze`: Diagnose all deployments in a namespace
57- `statefulset_analyze`: Diagnose all statefulsets in a namespace
58- `service_analyze`: Diagnose all services in a namespace
59- `cronjob_analyze`: Diagnose all cronjobs in a namespace
60- `ingress_analyze`: Diagnose all ingresses in a namespace
61- `networkpolicy_analyze`: Diagnose all networkpolicies in a namespace
62- `validatingwebhook_analyze`: Diagnose all validatingwebhooks
63- `mutatingwebhook_analyze`: Diagnose all mutatingwebhooks
64- `node_analyze`: Diagnose all nodes in cluster
65 
66### Monitoring Tools
67- `workload_resource_usage`: Get pod/deployment/replicaset/statefulset resource usage in a namepace (cpu, memory)
68 
69 
70## Requirements
71- Go 1.23 or higher
72- kubectl configured
73 
74## Installation
75```
76# clone the repository
77git clone https://github.com/wenhuwang/mcp-k8s-eye.git
78cd mcp-k8s-eye
79 
80# build the binary
81go build -o mcp-k8s-eye
82```
83 
84## Usage
85### Stdio mode
86```
87{
88  "mcpServers": {
89    "k8s eye": {
90      "command": "YOUR mcp-k8s-eye PATH",
91      "env": {
92        "HOME": "USER HOME DIR"
93      },
94    }
95  }
96}
97```
98`env.HOME` is used to set the HOME directory for kubeconfig file.
99 
100### SSE mode
1011. start your mcp sse server
1022. config your mcp server
103 
104```
105{
106  "mcpServers": {
107    "k8s eye": {
108      "url": "http://localhost:8080/sse",
109      "env": {}
110    }
111  }
112}
113```
114 
115### cursor tools
116![cursor tools](./images/mcp-server-tools.png)