Skip to content

Commit 7317fc0

Browse files
committed
doc(readme): MVP
1 parent 5be9852 commit 7317fc0

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,51 @@
33
<p align="center">
44
<a href="https://github.com/manusa/kubernetes-mcp-server/blob/main/LICENSE">
55
<img alt="GitHub License" src="https://img.shields.io/github/license/manusa/kubernetes-mcp-server" /></a>
6+
<a href="https://www.npmjs.com/package/kubernetes-mcp-server">
7+
<img alt="npm" src="https://img.shields.io/npm/v/kubernetes-mcp-server" /></a>
8+
<a href="https://github.com/manusa/kubernetes-mcp-server/releases/latest">
9+
<img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/manusa/kubernetes-mcp-server?sort=semver" /></a>
610
<a href="https://github.com/manusa/kubernetes-mcp-server/actions/workflows/build.yaml">
711
<img src="https://github.com/manusa/kubernetes-mcp-server/actions/workflows/build.yaml/badge.svg" alt="Build status badge" /></a>
812
</p>
913

1014

1115
<p align="center">
12-
<a href="#features">Features</a>
16+
<a href="#features">✨ Features</a> |
17+
<a href="#getting-started">🚀 Getting Started</a>
1318
</p>
1419

1520
## ✨ Features <a id="features" />
1621

17-
## Notes
22+
A powerful and flexible Kubernetes MCP server implementation with support for OpenShift.
1823

19-
Available MCP server implementation libraries:
24+
- **✅ Configuration**: View and manage the Kubernetes `.kube/config`.
25+
- View
26+
- **✅ Generic Kubernetes Resources**: Perform operations on any Kubernetes resource.
27+
- Any CRUD operation (Create or Update, Get, List, Delete)
28+
- **✅ Pods**: Perform Pod-specific operations.
29+
- List in all namespaces or in a specific namespace
30+
- Get
31+
- Delete
32+
- Show logs
33+
- Run
2034

21-
- https://github.com/mark3labs/mcp-go
22-
- https://github.com/metoro-io/mcp-golang
23-
- https://github.com/llmcontext/gomcp
35+
## 🚀 Getting Started <a id="getting-started" />
2436

37+
### Claude Desktop
2538

26-
## MCP Resources
39+
#### Using npx
40+
41+
If you have npm installed, this is the fastest way to get started with `kubernetes-mcp-server`.
42+
43+
Open your `claude_desktop_config.json` and add the mcp server to the list of `mcpServers`:
44+
``` json
45+
{
46+
"mcpServers": {
47+
"kubernetes-mcp": {
48+
"command": "npx",
49+
"args": ["-y", "kubernetes-mcp-server@latest"]
50+
}
51+
}
52+
```
2753

28-
- https://github.com/MCP-Mirror/MCP-Mirror

0 commit comments

Comments
 (0)