Skip to content

Commit a9f17db

Browse files
committed
doc: organized tools list and added projects_list entry
1 parent bdad267 commit a9f17db

File tree

1 file changed

+45
-41
lines changed

1 file changed

+45
-41
lines changed

README.md

Lines changed: 45 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/manusa/kubernetes-mcp-server?sort=semver)](https://github.com/manusa/kubernetes-mcp-server/releases/latest)
66
[![Build](https://github.com/manusa/kubernetes-mcp-server/actions/workflows/build.yaml/badge.svg)](https://github.com/manusa/kubernetes-mcp-server/actions/workflows/build.yaml)
77

8-
[✨ Features](#features) | [🚀 Getting Started](#getting-started) | [🎥 Demos](#demos) | [⚙️ Configuration](#configuration) | [🧑‍💻 Development](#development)
8+
[✨ Features](#features) | [🚀 Getting Started](#getting-started) | [🎥 Demos](#demos) | [⚙️ Configuration](#configuration) | [🛠️ Tools](#tools) | [🧑‍💻 Development](#development)
99

1010
https://github.com/user-attachments/assets/be2b67b3-fc1c-4d11-ae46-93deba8ed98e
1111

@@ -95,7 +95,46 @@ extensions:
9595

9696
```
9797

98-
## Tools
98+
## 🎥 Demos <a id="demos"></a>
99+
100+
### Diagnosing and automatically fixing an OpenShift Deployment
101+
102+
Demo showcasing how Kubernetes MCP server is leveraged by Claude Desktop to automatically diagnose and fix a deployment in OpenShift without any user assistance.
103+
104+
https://github.com/user-attachments/assets/a576176d-a142-4c19-b9aa-a83dc4b8d941
105+
106+
### _Vibe Coding_ a simple game and deploying it to OpenShift
107+
108+
In this demo, I walk you through the process of _Vibe Coding_ a simple game using VS Code and how to leverage [Podman MCP server](https://github.com/manusa/podman-mcp-server) and Kubernetes MCP server to deploy it to OpenShift.
109+
110+
<a href="https://www.youtube.com/watch?v=l05jQDSrzVI" target="_blank">
111+
<img src="docs/images/vibe-coding.jpg" alt="Vibe Coding: Build & Deploy a Game on Kubernetes" width="240" />
112+
</a>
113+
114+
## ⚙️ Configuration <a id="configuration"></a>
115+
116+
The Kubernetes MCP server can be configured using command line (CLI) arguments.
117+
118+
You can run the CLI executable either by using `npx` or by downloading the [latest release binary](https://github.com/manusa/kubernetes-mcp-server/releases/latest).
119+
120+
```shell
121+
# Run the Kubernetes MCP server using npx (in case you have npm installed)
122+
npx kubernetes-mcp-server@latest --help
123+
```
124+
125+
```shell
126+
# Run the Kubernetes MCP server using the latest release binary
127+
./kubernetes-mcp-server --help
128+
```
129+
130+
### Configuration Options
131+
132+
| Option | Description |
133+
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
134+
| `--sse-port` | Starts the MCP server in Server-Sent Event (SSE) mode and listens on the specified port. |
135+
| `--log-level` | Sets the logging level (values [from 0-9](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md)). Similar to [kubectl logging levels](https://kubernetes.io/docs/reference/kubectl/quick-reference/#kubectl-output-verbosity-and-debugging). |
136+
137+
## 🛠️ Tools <a id="tools"></a>
99138

100139
### `configuration_view`
101140

@@ -196,6 +235,10 @@ Run a Kubernetes Pod in the current or provided namespace with the provided cont
196235
- TCP/IP port to expose from the Pod container
197236
- No port exposed if not provided
198237

238+
### `projects_list`
239+
240+
List all the OpenShift projects in the current cluster
241+
199242
### `resources_create_or_update`
200243

201244
Create or update a Kubernetes resource in the current cluster by providing a YAML or JSON representation of the resource
@@ -258,45 +301,6 @@ List Kubernetes resources and objects in the current cluster
258301
- Ignored for cluster-scoped resources
259302
- Lists resources from all namespaces if not provided
260303

261-
## 🎥 Demos <a id="demos"></a>
262-
263-
### Diagnosing and automatically fixing an OpenShift Deployment
264-
265-
Demo showcasing how Kubernetes MCP server is leveraged by Claude Desktop to automatically diagnose and fix a deployment in OpenShift without any user assistance.
266-
267-
https://github.com/user-attachments/assets/a576176d-a142-4c19-b9aa-a83dc4b8d941
268-
269-
### _Vibe Coding_ a simple game and deploying it to OpenShift
270-
271-
In this demo, I walk you through the process of _Vibe Coding_ a simple game using VS Code and how to leverage [Podman MCP server](https://github.com/manusa/podman-mcp-server) and Kubernetes MCP server to deploy it to OpenShift.
272-
273-
<a href="https://www.youtube.com/watch?v=l05jQDSrzVI" target="_blank">
274-
<img src="docs/images/vibe-coding.jpg" alt="Vibe Coding: Build & Deploy a Game on Kubernetes" width="240" />
275-
</a>
276-
277-
## ⚙️ Configuration <a id="configuration"></a>
278-
279-
The Kubernetes MCP server can be configured using command line (CLI) arguments.
280-
281-
You can run the CLI executable either by using `npx` or by downloading the [latest release binary](https://github.com/manusa/kubernetes-mcp-server/releases/latest).
282-
283-
```shell
284-
# Run the Kubernetes MCP server using npx (in case you have npm installed)
285-
npx kubernetes-mcp-server@latest --help
286-
```
287-
288-
```shell
289-
# Run the Kubernetes MCP server using the latest release binary
290-
./kubernetes-mcp-server --help
291-
```
292-
293-
### Configuration Options
294-
295-
| Option | Description |
296-
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
297-
| `--sse-port` | Starts the MCP server in Server-Sent Event (SSE) mode and listens on the specified port. |
298-
| `--log-level` | Sets the logging level (values [from 0-9](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md)). Similar to [kubectl logging levels](https://kubernetes.io/docs/reference/kubectl/quick-reference/#kubectl-output-verbosity-and-debugging). |
299-
300304
## 🧑‍💻 Development <a id="development"></a>
301305

302306
### Running with mcp-inspector

0 commit comments

Comments
 (0)