Skip to content

Commit d8e0f8f

Browse files
committed
made readme fancier
1 parent 9e1bbb5 commit d8e0f8f

File tree

2 files changed

+50
-30
lines changed

2 files changed

+50
-30
lines changed

README.md

Lines changed: 50 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,36 @@
1-
# MCP K8S Go
1+
<h1 align="center">
2+
<img src="docs/images/logo.png" width="180"/>
3+
<br/>
4+
MCP K8S Go
5+
</h1>
6+
7+
<h4 align="center">MCP server connecting to Kubernetes and a library to build more servers for any custom resources</h4>
8+
9+
<p align="center">
10+
<a href="#features">Features</a> ⚙
11+
<a href="#browse-with-inspector">Browse With Inspector</a> ⚙
12+
<a href="#use-with-claude">Use With Claude</a> ⚙
13+
<a href="#contributing">Contributing</a>
14+
</p>
15+
16+
[![MCP Package](https://mcp-get.com/api/badge/%40strowk%2Fmcp-k8s)](https://mcp-get.com/packages/%40strowk%2Fmcp-k8s)
17+
[![MCP Package Installs](https://mcp-get.com/api/badge/%40strowk%2Fmcp-k8s?style=installs)](https://mcp-get.com/packages/%40strowk%2Fmcp-k8s)
18+
[![MCP Package Views](https://mcp-get.com/api/badge/%40strowk%2Fmcp-k8s?style=views)](https://mcp-get.com/packages/%40strowk%2Fmcp-k8s)
219
[![smithery badge](https://smithery.ai/badge/@strowk/mcp-k8s)](https://smithery.ai/protocol/@strowk/mcp-k8s)
320

4-
This project is intended as a both MCP server connecting to Kubernetes and a library to build more servers for any custom resources in Kubernetes.
21+
## Features
522

6-
Currently available:
7-
- resource: K8S contexts as read from kubeconfig configurations
8-
- tool: list-k8s-contexts
9-
- tool: list-k8s-namespaces in a given context
10-
- tool: list-k8s-pods in a given context and namespace
11-
- tool: list-k8s-events in a given context and namespace
12-
- tool: list-k8s-services in a given context and namespace
13-
- tool: get-k8s-pod-logs in a given context and namespace
14-
- prompt: list-k8s-namespaces in a given context
15-
- prompt: list-k8s-pods in current context and with given namespace
23+
- 🗂️ resource: K8S contexts as read from kubeconfig configurations
24+
- 🤖 tool: list-k8s-contexts
25+
- 🤖 tool: list-k8s-namespaces in a given context
26+
- 🤖 tool: list-k8s-pods in a given context and namespace
27+
- 🤖 tool: list-k8s-events in a given context and namespace
28+
- 🤖 tool: list-k8s-services in a given context and namespace
29+
- 🤖 tool: get-k8s-pod-logs in a given context and namespace
30+
- 💬 prompt: list-k8s-namespaces in a given context
31+
- 💬 prompt: list-k8s-pods in current context and with given namespace
1632

17-
## Example usage with Inspector
33+
## Browse With Inspector
1834

1935
To use latest published version with Inspector you can run this:
2036

@@ -28,28 +44,39 @@ npx @modelcontextprotocol/inspector npx @strowk/mcp-k8s
2844
tools/inspector/run.sh
2945
```
3046

31-
## Example usage with Claude Desktop
47+
## Use With Claude
3248

33-
To use this MCP server with Claude Desktop you would firstly need to install it.
49+
<details><summary><b>
50+
Demo Usage
51+
</b></summary>
52+
53+
Following chat with Claude Desktop demonstrates how it looks when selected particular context as a resource and then asked to check pod logs for errors in kube-system namespace:
54+
55+
![Claude Desktop](docs/images/claude-desktop-logs.png)
3456

57+
</details>
58+
59+
60+
To use this MCP server with Claude Desktop you would firstly need to install it.
3561
You have several options for installation:
3662

37-
1. Using Smithery:
63+
### Using Smithery
3864

39-
To install MCP K8S Go for Claude Desktop automatically via [Smithery](https://smithery.ai/protocol/@strowk/mcpk8s):
65+
To install MCP K8S Go for Claude Desktop automatically via [Smithery](https://smithery.ai/protocol/@strowk/mcp-k8s):
4066

4167
```bash
4268
npx @smithery/cli install @strowk/mcp-k8s --client claude
4369
```
4470

45-
2. Using mcp-get:
71+
### Using mcp-get
72+
73+
To install MCP K8S Go for Claude Desktop automatically via [mcp-get](https://mcp-get.com/packages/%40strowk%2Fmcp-k8s):
74+
4675
```bash
4776
npx @michaellatman/mcp-get@latest install @strowk/mcp-k8s
4877
```
4978

50-
3. Using pre-built binaries published in npm or building from source.
51-
52-
### Using pre-built binaries
79+
### Manually with pre-built binaries
5380

5481
#### From npm
5582

@@ -120,18 +147,11 @@ Now you should be able to run Claude Desktop and:
120147
- ask Claude to list events in a given context and namespace
121148
- ask Claude to read logs of a given pod in a given context and namespace
122149

123-
## Environment Variables
150+
### Environment Variables
124151

125152
The following environment variables are used by the MCP server:
126153
- `KUBECONFIG`: Path to your Kubernetes configuration file (optional, defaults to ~/.kube/config)
127154

128-
### Contributing
155+
## Contributing
129156

130157
Check out [CONTRIBUTION.md](./CONTRIBUTION.md) for more information on how to contribute to this project.
131-
132-
### Demo usage with Claude Desktop
133-
134-
Following chat with Claude Desktop demonstrates how it looks when selected particular context as a resource and then asked to check pod logs for errors in kube-system namespace:
135-
136-
![Claude Desktop](docs/images/claude-desktop-logs.png)
137-

docs/images/logo.png

1.2 MB
Loading

0 commit comments

Comments
 (0)