Skip to content

Commit 1b80c25

Browse files
committed
Review:
* note on recommendation about use SA versus exciting (default) kubeconfig * adding a collapsible section * removed incorrect args Signed-off-by: Matthias Wessendorf <[email protected]>
1 parent 4ca578d commit 1b80c25

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ If you're using the native binaries you don't need to have Node or Python instal
5454

5555
- Access to a Kubernetes cluster.
5656

57+
<details>
58+
<summary><b>Claude Code</b></summary>
59+
60+
Follow the [dedicated Claude Code getting started guide](docs/GETTING_STARTED_CLAUDE_CODE.md) in our [user documentation](docs/).
61+
62+
For a secure production setup with dedicated ServiceAccount and read-only access, also review the [Kubernetes setup guide](docs/GETTING_STARTED_KUBERNETES.md).
63+
64+
</details>
65+
5766
### Claude Desktop
5867

5968
#### Using npx

docs/GETTING_STARTED_CLAUDE_CODE.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,10 @@ to fetch and display the relevant information from your cluster:
8888
8989
Common command-line flags you can add to the `args` array:
9090
91-
| Flag | Description | Example |
92-
|------|-------------|---------|
93-
| `--read-only` | Enable read-only mode (recommended) | Already included above |
94-
| `--kubeconfig <path>` | Path to kubeconfig file | Use `KUBECONFIG` env var instead |
95-
| `--context <name>` | Use specific context from kubeconfig | `"--context", "my-cluster"` |
96-
| `--namespace <ns>` | Default namespace for operations | `"--namespace", "production"` |
97-
98-
**Example with custom namespace:**
99-
100-
```bash
101-
claude mcp add-json kubernetes-mcp-server \
102-
'{"command":"npx","args":["-y","kubernetes-mcp-server@latest","--read-only","--namespace","production"],"env":{"KUBECONFIG":"'${HOME}'/.kube/mcp-viewer.kubeconfig"}}' \
103-
-s user
104-
```
91+
| Flag | Description |
92+
|------|-------------|
93+
| `--read-only` | Enable read-only mode (recommended) |
94+
| `--kubeconfig <path>` | Path to kubeconfig file (or use `KUBECONFIG` env var) |
10595
10696
## Next Steps
10797

docs/GETTING_STARTED_KUBERNETES.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
This guide walks you through the foundational setup for using the Kubernetes MCP Server with your Kubernetes cluster. You'll create a dedicated, read-only ServiceAccount and generate a secure kubeconfig file that can be used with various MCP clients.
44

5-
> **Note:** After completing this guide, continue with the [Claude Code CLI guide](GETTING_STARTED_CLAUDE_CODE.md). See the [docs README](README.md) for all available guides.
5+
> **Note:** This setup is **recommended for production use** but not strictly required. The MCP Server can use your existing kubeconfig file (e.g., `~/.kube/config`), but using a dedicated ServiceAccount with limited permissions follows the principle of least privilege and is more secure.
6+
7+
> **Next:** After completing this guide, continue with the [Claude Code CLI guide](GETTING_STARTED_CLAUDE_CODE.md). See the [docs README](README.md) for all available guides.
68
79
## What You'll Create
810

0 commit comments

Comments
 (0)