mcp-server-kubernetes 0.3.0 → 0.3.2

package/README.md

@@ -1,4 +1,15 @@
-# mcp-server-kubernetes
+# MCP Server Kubernetes
+
+[![CI](https://github.com/Flux159/mcp-server-kubernetes/actions/workflows/ci.yml/badge.svg)](https://github.com/yourusername/mcp-server-kubernetes/actions/workflows/ci.yml)
+[![Language](https://img.shields.io/github/languages/top/Flux159/mcp-server-kubernetes)](https://github.com/yourusername/mcp-server-kubernetes)
+[![Bun](https://img.shields.io/badge/runtime-bun-orange)](https://bun.sh)
+[![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=flat&logo=kubernetes&logoColor=white)](https://kubernetes.io/)
+[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=flat&logo=docker&logoColor=white)](https://www.docker.com/)
+[![Stars](https://img.shields.io/github/stars/Flux159/mcp-server-kubernetes)](https://github.com/Flux159/mcp-server-kubernetes/stargazers)
+[![Issues](https://img.shields.io/github/issues/Flux159/mcp-server-kubernetes)](https://github.com/Flux159/mcp-server-kubernetes/issues)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Flux159/mcp-server-kubernetes/pulls)
+[![Last Commit](https://img.shields.io/github/last-commit/Flux159/mcp-server-kubernetes)](https://github.com/Flux159/mcp-server-kubernetes/commits/main)
+[![smithery badge](https://smithery.ai/badge/mcp-server-kubernetes)](https://smithery.ai/protocol/mcp-server-kubernetes)
 
 MCP Server that can connect to a Kubernetes cluster and manage it.
 
@@ -30,6 +41,28 @@ You can verify your connection by asking Claude to list your pods or create a te
 
 If you have errors open up a standard terminal and run `kubectl get pods` to see if you can connect to your cluster without credentials issues.
 
+## Usage with mcp-chat
+
+[mcp-chat](https://github.com/Flux159/mcp-chat) is a CLI chat client for MCP servers. You can use it to interact with the Kubernetes server.
+
+```shell
+npx mcp-chat --server "npx mcp-server-kubernetes"
+```
+
+Alternatively, pass it your existing Claude Desktop configuration file from above (Linux should pass the correct path to config):
+
+Mac:
+
+```shell
+npx mcp-chat --config "~/Library/Application Support/Claude/claude_desktop_config.json"
+```
+
+Windows:
+
+```shell
+npx mcp-chat --config "%APPDATA%\Claude\claude_desktop_config.json"
+```
+
 ## Features
 
 - [x] Connect to a Kubernetes cluster
@@ -50,6 +83,7 @@ If you have errors open up a standard terminal and run `kubectl get pods` to see
   - Support for version specification
   - Support for custom repositories
 - [x] kubectl explain and kubectl api-resources support
+- [x] Get Kubernetes events from the cluster
 - [ ] Port forward to a pod
 - [ ] Choose namespace for next commands (memory)
 
@@ -88,34 +122,60 @@ npx @modelcontextprotocol/inspector node build/index.js
 # Follow further instructions on terminal for Inspector link
 ```
 
+5. Local testing with [mcp-chat](https://github.com/Flux159/mcp-chat)
+
+```bash
+npm run chat
+```
+
 ### Project Structure
 
 ```
 ├── src/
 │   ├── index.ts              # Main server implementation
 │   ├── types.ts              # Type re-exports
-│   ├── config/              # Configuration files
+│   ├── config/               # Configuration files
 │   │   ├── container-templates.ts  # Container configurations
-│   │   ├── server-config.ts       # Server settings
+│   │   ├── server-config.ts        # Server settings
 │   │   ├── deployment-config.ts    # Deployment schemas
-│   │   └── ...
-│   ├── models/              # Data models and schemas
-│   │   ├── response-schemas.ts    # API response schemas
-│   │   ├── resource-models.ts     # Resource models
-│   │   └── tool-models.ts         # Tool schemas
-│   ├── utils/               # Utility classes
-│   │   └── kubernetes-manager.ts  # K8s management
-│   ├── resources/           # Resource handlers
-│   │   └── handlers.ts      # Resource implementation
-│   └── tools/              # Tool implementations
-│       ├── list_pods.ts
-│       ├── list_services.ts
-│       ├── list_deployments.ts
-│       └── ...
-├── tests/                  # Test files
-│   └── unit.test.ts        # Unit tests
-│   └── helm.test.ts        # Helm tests
-└── ...
+│   │   ├── namespace-config.ts     # Namespace schemas
+│   │   └── cleanup-config.ts       # Resource cleanup configuration
+│   ├── models/               # Data models and schemas
+│   │   ├── response-schemas.ts     # API response schemas
+│   │   ├── resource-models.ts      # Resource models
+│   │   ├── tool-models.ts          # Tool schemas
+│   │   ├── helm-models.ts          # Helm operation schemas
+│   │   └── kubectl-models.ts       # Kubectl operation schemas
+│   ├── utils/                # Utility classes
+│   │   └── kubernetes-manager.ts   # K8s management
+│   ├── resources/            # Resource handlers
+│   │   └── handlers.ts       # Resource implementation
+│   └── tools/                # Tool implementations
+│       ├── list_pods.ts      # Pod listing operations
+│       ├── list_services.ts  # Service listing operations
+│       ├── list_deployments.ts # Deployment listing operations
+│       ├── list_nodes.ts     # Node listing operations
+│       ├── create_pod.ts     # Pod creation operations
+│       ├── delete_pod.ts     # Pod deletion operations
+│       ├── describe_pod.ts   # Pod description operations
+│       ├── get_logs.ts       # Container logs operations
+│       ├── get_events.ts     # Kubernetes events operations
+│       ├── helm-operations.ts # Helm chart operations
+│       └── kubectl-operations.ts # Kubectl utility operations
+├── tests/                    # Test files
+│   ├── unit.test.ts          # Unit tests for basic operations
+│   ├── helm.test.ts          # Helm-specific tests
+│   └── kubectl.test.ts       # Kubectl-specific tests
+├── .github/                  # GitHub configuration
+│   └── workflows/            # CI/CD workflows
+│       ├── ci.yml            # Continuous integration
+│       └── cd.yml            # Continuous deployment
+├── Dockerfile                # Docker container definition
+├── LICENSE                   # MIT license
+├── README.md                 # Project documentation
+├── package.json              # NPM package configuration
+├── tsconfig.json             # TypeScript configuration
+└── vitest.config.ts          # Test configuration
 ```
 
 ### Contributing

package/dist/index.js

@@ -11,6 +11,7 @@ import { createPod, createPodSchema } from "./tools/create_pod.js";
 import { deletePod, deletePodSchema } from "./tools/delete_pod.js";
 import { describePod, describePodSchema } from "./tools/describe_pod.js";
 import { getLogs, getLogsSchema } from "./tools/get_logs.js";
+import { getEvents, getEventsSchema } from "./tools/get_events.js";
 import { getResourceHandlers } from "./resources/handlers.js";
 import { ListResourcesRequestSchema, ReadResourceRequestSchema, ListToolsRequestSchema, CallToolRequestSchema, ErrorCode, McpError, } from "@modelcontextprotocol/sdk/types.js";
 import { KubernetesManager } from "./types.js";
@@ -27,22 +28,23 @@ const server = new Server({
 server.setRequestHandler(ListToolsRequestSchema, async () => {
     return {
         tools: [
-            listPodsSchema,
-            listDeploymentsSchema,
-            listServicesSchema,
-            listNamespacesSchema,
-            createPodSchema,
+            cleanupSchema,
             createDeploymentSchema,
+            createPodSchema,
             deletePodSchema,
             describePodSchema,
-            cleanupSchema,
-            listNodesSchema,
+            explainResourceSchema,
+            getEventsSchema,
             getLogsSchema,
             installHelmChartSchema,
-            upgradeHelmChartSchema,
-            uninstallHelmChartSchema,
-            explainResourceSchema,
             listApiResourcesSchema,
+            listDeploymentsSchema,
+            listNamespacesSchema,
+            listNodesSchema,
+            listPodsSchema,
+            listServicesSchema,
+            uninstallHelmChartSchema,
+            upgradeHelmChartSchema,
         ],
     };
 });
@@ -50,27 +52,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
     try {
         const { name, arguments: input = {} } = request.params;
         switch (name) {
-            case "list_pods": {
-                return await listPods(k8sManager, input);
-            }
-            case "list_deployments": {
-                return await listDeployments(k8sManager, input);
-            }
-            case "list_services": {
-                return await listServices(k8sManager, input);
-            }
-            case "list_namespaces": {
-                const { body } = await k8sManager.getCoreApi().listNamespace();
-                const namespaces = body.items.map((ns) => ({
-                    name: ns.metadata?.name || "",
-                    status: ns.status?.phase || "",
-                    createdAt: ns.metadata?.creationTimestamp,
-                }));
+            case "cleanup": {
+                await k8sManager.cleanup();
                 return {
                     content: [
                         {
                             type: "text",
-                            text: JSON.stringify({ namespaces }, null, 2),
+                            text: JSON.stringify({
+                                success: true,
+                            }, null, 2),
                         },
                     ],
                 };
@@ -84,15 +74,36 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
             case "describe_pod": {
                 return await describePod(k8sManager, input);
             }
-            case "cleanup": {
-                await k8sManager.cleanup();
+            case "explain_resource": {
+                return await explainResource(input);
+            }
+            case "get_events": {
+                return await getEvents(k8sManager, input);
+            }
+            case "get_logs": {
+                return await getLogs(k8sManager, input);
+            }
+            case "install_helm_chart": {
+                return await installHelmChart(input);
+            }
+            case "list_api_resources": {
+                return await listApiResources(input);
+            }
+            case "list_deployments": {
+                return await listDeployments(k8sManager, input);
+            }
+            case "list_namespaces": {
+                const { body } = await k8sManager.getCoreApi().listNamespace();
+                const namespaces = body.items.map((ns) => ({
+                    name: ns.metadata?.name || "",
+                    status: ns.status?.phase || "",
+                    createdAt: ns.metadata?.creationTimestamp,
+                }));
                 return {
                     content: [
                         {
                             type: "text",
-                            text: JSON.stringify({
-                                success: true,
-                            }, null, 2),
+                            text: JSON.stringify({ namespaces }, null, 2),
                         },
                     ],
                 };
@@ -100,23 +111,17 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
             case "list_nodes": {
                 return await listNodes(k8sManager);
             }
-            case "get_logs": {
-                return await getLogs(k8sManager, input);
-            }
-            case "install_helm_chart": {
-                return await installHelmChart(input);
+            case "list_pods": {
+                return await listPods(k8sManager, input);
             }
-            case "upgrade_helm_chart": {
-                return await upgradeHelmChart(input);
+            case "list_services": {
+                return await listServices(k8sManager, input);
             }
             case "uninstall_helm_chart": {
                 return await uninstallHelmChart(input);
             }
-            case "explain_resource": {
-                return await explainResource(input);
-            }
-            case "list_api_resources": {
-                return await listApiResources(input);
+            case "upgrade_helm_chart": {
+                return await upgradeHelmChart(input);
             }
             default:
                 throw new McpError(ErrorCode.InvalidRequest, `Unknown tool: ${name}`);

package/dist/models/response-schemas.d.ts

@@ -219,3 +219,25 @@ export declare const GetLogsResponseSchema: z.ZodObject<{
         text: string;
     }[];
 }>;
+export declare const GetEventsResponseSchema: z.ZodObject<{
+    content: z.ZodArray<z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "text";
+        text: string;
+    }, {
+        type: "text";
+        text: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+}, {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+}>;

package/dist/models/response-schemas.js

@@ -34,3 +34,6 @@ export const ListNodesResponseSchema = z.object({
 export const GetLogsResponseSchema = z.object({
     content: z.array(ToolResponseContent),
 });
+export const GetEventsResponseSchema = z.object({
+    content: z.array(ToolResponseContent),
+});

package/dist/tools/get_events.d.ts

@@ -0,0 +1,28 @@
+import { KubernetesManager } from "../types.js";
+export declare const getEventsSchema: {
+    name: string;
+    description: string;
+    inputSchema: {
+        type: string;
+        properties: {
+            namespace: {
+                type: string;
+                description: string;
+            };
+            fieldSelector: {
+                type: string;
+                description: string;
+            };
+        };
+        required: never[];
+    };
+};
+export declare function getEvents(k8sManager: KubernetesManager, params: {
+    namespace?: string;
+    fieldSelector?: string;
+}): Promise<{
+    content: {
+        type: string;
+        text: string;
+    }[];
+}>;

package/dist/tools/get_events.js

@@ -0,0 +1,66 @@
+export const getEventsSchema = {
+    name: "get_events",
+    description: "Get Kubernetes events from the cluster",
+    inputSchema: {
+        type: "object",
+        properties: {
+            namespace: {
+                type: "string",
+                description: "Namespace to get events from. If not specified, gets events from all namespaces",
+            },
+            fieldSelector: {
+                type: "string",
+                description: "Field selector to filter events",
+            },
+        },
+        required: [],
+    },
+};
+export async function getEvents(k8sManager, params) {
+    const { namespace, fieldSelector } = params;
+    const api = k8sManager.getCoreApi();
+    let events;
+    if (namespace) {
+        const { body } = await api.listNamespacedEvent(namespace, undefined, // pretty
+        undefined, // allowWatchBookmarks
+        undefined, // _continue
+        undefined, // fieldSelector
+        fieldSelector // fieldSelector
+        );
+        events = body;
+    }
+    else {
+        const { body } = await api.listEventForAllNamespaces(undefined, // allowWatchBookmarks
+        undefined, // _continue
+        fieldSelector, // fieldSelector
+        undefined, // labelSelector
+        undefined, // limit
+        undefined, // pretty
+        undefined, // resourceVersion
+        undefined, // resourceVersionMatch
+        undefined // timeoutSeconds
+        );
+        events = body;
+    }
+    const formattedEvents = events.items.map((event) => ({
+        type: event.type || "",
+        reason: event.reason || "",
+        message: event.message || "",
+        involvedObject: {
+            kind: event.involvedObject.kind || "",
+            name: event.involvedObject.name || "",
+            namespace: event.involvedObject.namespace || "",
+        },
+        firstTimestamp: event.firstTimestamp || "",
+        lastTimestamp: event.lastTimestamp || "",
+        count: event.count || 0,
+    }));
+    return {
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify({ events: formattedEvents }, null, 2),
+            },
+        ],
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-server-kubernetes",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "MCP server for interacting with Kubernetes clusters via kubectl",
   "license": "MIT",
   "type": "module",
@@ -21,7 +21,8 @@
     "start": "node dist/index.js",
     "test": "vitest run",
     "prepublishOnly": "npm run build",
-    "dockerbuild": "docker buildx build -t flux159/mcp-server-kubernetes --platform linux/amd64,linux/arm64 --push ."
+    "dockerbuild": "docker buildx build -t flux159/mcp-server-kubernetes --platform linux/amd64,linux/arm64 --push .",
+    "chat": "npx mcp-chat --server \"./dist/index.js\""
   },
   "keywords": [
     "mcp",