docs: add Claude Code configuration and troubleshooting guide #285
+25
−0
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
- Add Claude Code section with tested JSON configuration command - Include troubleshooting guidance for stdio transport connection issues - Explain that health check failures are normal but don't affect functionality - Document proper environment variable handling for KUBECONFIG - Provide user-level scope installation for cross-project availability Resolves common 'Failed to connect' issues by using JSON format instead of command-line args Signed-off-by: Rafael Sathler <[email protected]>
rafilkmp3
force-pushed
the
docs/claude-code-configuration
branch
from
b7ce0f5 to
0794da5
Compare
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.
Summary
This PR adds comprehensive Claude Code configuration documentation to help users easily set up the kubernetes-mcp-server with Claude Code CLI.
Changes Made
Key Configuration
The documented command that works reliably:
claude mcp add-json kubectl '{"command":"npx","args":["-y","kubernetes-mcp-server@latest"],"env":{"KUBECONFIG":"${HOME}/.kube/config"}}' -s userProblem Solved
Many users experience "Failed to connect" issues when trying to add this MCP server to Claude Code. This documentation provides:
Testing
The configuration has been tested and verified to work with Claude Code, providing reliable kubectl functionality across all projects.
Documentation Placement
The new Claude Code section is positioned after the Goose CLI section, maintaining consistency with other tool integrations in the README.
This change makes it significantly easier for Claude Code users to integrate kubernetes-mcp-server into their workflow with a single, tested command.