Skip to content

Commit 8b3ddab

Browse files
committed
doc: add configuration section to README.md
1 parent efa09cb commit 8b3ddab

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
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)
8+
[✨ Features](#features) | [🚀 Getting Started](#getting-started) | [🎥 Demos](#demos) | [⚙️ Configuration](#configuration)
99

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

1212
## ✨ Features <a id="features"></a>
1313

14-
A powerful and flexible Kubernetes MCP server implementation with support for OpenShift.
14+
A powerful and flexible Kubernetes [Model Context Protocol (MCP)](https://blog.marcnuri.com/model-context-protocol-mcp-introduction) server implementation with support for OpenShift.
1515

1616
- **✅ Configuration**: View and manage the [Kubernetes `.kube/config`](https://blog.marcnuri.com/where-is-my-default-kubeconfig-file).
1717
- **View** the current configuration.
@@ -32,7 +32,6 @@ A powerful and flexible Kubernetes MCP server implementation with support for Op
3232

3333
If you have npm installed, this is the fastest way to get started with `kubernetes-mcp-server` on Claude Desktop.
3434

35-
3635
Open your `claude_desktop_config.json` and add the mcp server to the list of `mcpServers`:
3736
``` json
3837
{
@@ -75,3 +74,24 @@ Demo showcasing how Kubernetes MCP server is leveraged by Claude Desktop to auto
7574

7675
https://github.com/user-attachments/assets/a576176d-a142-4c19-b9aa-a83dc4b8d941
7776

77+
## ⚙️ Configuration <a id="configuration"></a>
78+
79+
The Kubernetes MCP server can be configured using command line (CLI) arguments.
80+
81+
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).
82+
83+
```shell
84+
# Run the Kubernetes MCP server using npx (in case you have npm installed)
85+
npx kubernetes-mcp-server@latest --help
86+
```
87+
88+
```shell
89+
# Run the Kubernetes MCP server using the latest release binary
90+
./kubernetes-mcp-server --help
91+
```
92+
93+
### Configuration Options
94+
95+
| Option | Description |
96+
|--------------|------------------------------------------------------------------------------------------|
97+
| `--sse-port` | Starts the MCP server in Server-Sent Event (SSE) mode and listens on the specified port. |

0 commit comments

Comments
 (0)