Add exec_in_pod tool for command execution in Kubernetes pods #128
+1,407
−951
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…r command execution
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new tool, exec_in_pod, which enables command execution in Kubernetes pods while supporting both string and array command formats along with optional shell and container parameters. The key changes include:
- Implementation of the exec_in_pod tool with input validation and output handling.
- New tests to verify both array and string command executions and error handling.
- Updates to response schemas and the main request handler to register the new tool.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/exec_in_pod.test.ts | New integration tests for the exec_in_pod tool functionality. |
| src/tools/exec_in_pod.ts | Implementation of the exec_in_pod tool using the Kubernetes Exec API. |
| src/models/response-schemas.ts | Added ExecInPodResponseSchema to support the new tool. |
| src/index.ts | Updated request handler to include exec_in_pod in the tool list. |
Flux159
reviewed
Apr 23, 2025
Flux159
approved these changes
Apr 25, 2025
Flux159
approved these changes
May 20, 2025
|
This one needs a rebase after the refactor |
|
@rr-paras-patel ping on this PR - should be an easy rebase for index right? Seems like it would be a useful feature for next release. |
Summary: Test Plan:
See Flux159#129 Summary: Test Plan:
…to improve usability.
…t, detailing new features such as scaling deployments, port forwarding, and Helm operations.
…d enhance clarity in instructions. Updated descriptions and structured steps for better user guidance in Kubernetes resource investigations.
…-level issues, improving guidance for Kubernetes resource investigations. Updated instructions for clarity and actionable insights.
…tency. Updated keyword search description and expanded resource type identification to include Ingress.
… and kubectl_explain tool for resource type identification. Enhanced clarity in troubleshooting steps for Kubernetes resources.
… to "all" to broaden the search scope for troubleshooting resources across all namespaces.
Co-authored-by: Copilot <[email protected]>
…g fixed delay and updating response schema handling for prompts list.
…delete, create, logs, generic, patch, and rollout functionalities in index.ts.
…nce type safety and clarity.
…x.ts to streamline the toolset.
…ubernetes resources, following the removal of kubectl_list functionality.
…uring consistency across documentation and functionality following the removal of kubectl_list.
…t, ensuring alignment with recent changes in functionality across all test files.
…metadata references for improved clarity and consistency.
…es, and namespaces, ensuring robustness and clarity in resource validation.
…error handling, and improve service creation and deletion logic. Added tests for NodePort and LoadBalancer services, and ensured consistent use of asResponseSchema for type safety.
…tempt, improving error handling for non-existent services, and ensuring test failure for unexpected responses.
…e, updating descriptions for clarity and consistency in diagnostic operations.
…or connecting to AWS EKS, Google GKE, and Azure AKS clusters, and specify the latest image tag for Docker commands.
Flux159
reviewed
Jun 23, 2025
Comment on lines
+234
to
+258
| ### Connect to Google GKE Clusters | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "kubernetes": { | ||
| "command": "docker", | ||
| "args": [ | ||
| "run", | ||
| "-i", | ||
| "--rm", | ||
| "-v", | ||
| "~/.kube:/home/appuser/.kube:ro", | ||
| "-v", | ||
| "~/.config/gcloud:/home/appuser/.config/gcloud:ro", | ||
| "-e", | ||
| "CLOUDSDK_CORE_PROJECT=my-gcp-project", | ||
| "-e", | ||
| "CLOUDSDK_COMPUTE_REGION=us-central1", | ||
| "flux159/mcp-server-kubernetes:latest" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
I have a note around GKE in #103 (comment) - specifically the auth plugin for kubeconfig needs to be named "gke-gcloud-auth-plugin" for the docker container to correctly authenticate. Think that this is still the case so should be in the readme
There was a problem hiding this comment.
@Flux159 can you please update GKE related instructions i only have capability to verify with EKS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a new tool to execute commands within Kubernetes pods, enhancing the functionality with a schema for input validation and response handling. The implementation supports both string and array command formats, along with an optional shell specification.
This pull request introduces a new feature for executing commands in Kubernetes pods, removes redundant functionality, and updates documentation to align with the changes. The most significant updates include the addition of the
exec_in_podtool, removal of thekubectl_listtool, and updates to prompts and documentation to reflect these changes.New Feature:
exec_in_podToolexec_in_pod, for executing commands in Kubernetes pods using the Kubernetes client-node Exec API. It supports both string and array command formats, optional container targeting, and customizable timeouts. (src/tools/exec_in_pod.ts, src/tools/exec_in_pod.tsR1-R203)exec_in_podtool insrc/index.ts, including its schema and request handler. (src/index.ts, [1] [2] [3]Removed Functionality:
kubectl_listToolkubectl_listtool and its associated schema, as its functionality overlaps withkubectl_get. (src/index.ts, [1] [2] [3]README.mdto remove references tokubectl_list. (README.md, [1] [2]Updates to Prompts
k8s-troubleshootprompt tok8s-diagnosefor better clarity and alignment with its purpose. Updated descriptions, error messages, and flow details accordingly. (src/prompts/index.ts, [1] [2]README.mdto reflect the prompt name change and its description. (README.md, README.mdL92-R100)Documentation Enhancements
CLAUDE.mdfile providing detailed development guidelines, architecture overview, and testing strategies for the MCP server. (CLAUDE.md, CLAUDE.mdR1-R90)Schema Updates
exec_in_podtool to handle its output. (src/models/response-schemas.ts, src/models/response-schemas.tsR163-R166)