Skip to content

Commit 1d75415

Browse files
committed
Update docs about Kiali
Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com>
1 parent 64f01f4 commit 1d75415

File tree

3 files changed

+57
-1
lines changed

3 files changed

+57
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Enabling only the toolsets you need can help reduce the context size and improve
204204

205205
### Available Toolsets
206206

207-
The following sets of tools are available (all on by default):
207+
The following sets of tools are available (all on by default).
208208

209209
<!-- AVAILABLE-TOOLSETS-START -->
210210

@@ -213,9 +213,12 @@ The following sets of tools are available (all on by default):
213213
| config | View and manage the current local Kubernetes configuration (kubeconfig) |
214214
| core | Most common tools for Kubernetes management (Pods, Generic Resources, Events, etc.) |
215215
| helm | Tools for managing Helm charts and releases |
216+
| kiali | Most common tools for managing Kiali |
216217

217218
<!-- AVAILABLE-TOOLSETS-END -->
218219

220+
See more info about Kiali integration in [docs/KIALI_INTEGRATION.md](docs/KIALI_INTEGRATION.md).
221+
219222
### Tools
220223

221224
In case multi-cluster support is enabled (default) and you have access to multiple clusters, all applicable tools will include an additional `context` argument to specify the Kubernetes context (cluster) to use for that operation.
@@ -343,6 +346,14 @@ In case multi-cluster support is enabled (default) and you have access to multip
343346

344347
</details>
345348

349+
<details>
350+
351+
<summary>kiali</summary>
352+
353+
- **mesh_status** - Get the status of mesh components including Istio, Kiali, Grafana, Prometheus and their interactions, versions, and health status
354+
355+
</details>
356+
346357

347358
<!-- AVAILABLE-TOOLSETS-TOOLS-END -->
348359

docs/KIALI_INTEGRATION.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Kiali integration
2+
3+
This server can expose Kiali tools so assistants can query mesh information (e.g., mesh status/graph).
4+
5+
### Enable the Kiali toolset
6+
7+
You can enable the Kiali tools via config or flags.
8+
9+
Config (TOML):
10+
11+
```toml
12+
toolsets = ["core", "kiali"]
13+
14+
[kiali]
15+
url = "https://kiali.example"
16+
# insecure = true # optional: allow insecure TLS
17+
```
18+
19+
Flags:
20+
21+
```bash
22+
kubernetes-mcp-server \
23+
--toolsets core,kiali \
24+
--kiali-url https://kiali.example \
25+
[--kiali-insecure]
26+
```
27+
28+
When the `kiali` toolset is enabled, a Kiali URL is required. Without it, the server will refuse to start.
29+
30+
### How authentication works
31+
32+
- The server uses your existing Kubernetes credentials (from kubeconfig or in-cluster) to set a bearer token for Kiali calls.
33+
- If you pass an HTTP Authorization header to the MCP HTTP endpoint, that is not required for Kiali; Kiali calls use the server's configured token.
34+
35+
### Available tools (initial)
36+
37+
- `mesh_status`: retrieves mesh components status from Kiali’s mesh graph endpoint.
38+
39+
### Troubleshooting
40+
41+
- Error: "kiali-url is required when kiali tools are enabled" → provide `--kiali-url` or set `[kiali].url` in the config TOML.
42+
- TLS issues against Kiali → try `--kiali-insecure` or `[kiali].insecure = true` for non-production environments.
43+
44+

internal/tools/update-readme/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
_ "github.com/containers/kubernetes-mcp-server/pkg/toolsets/config"
1616
_ "github.com/containers/kubernetes-mcp-server/pkg/toolsets/core"
1717
_ "github.com/containers/kubernetes-mcp-server/pkg/toolsets/helm"
18+
_ "github.com/containers/kubernetes-mcp-server/pkg/toolsets/kiali"
1819
)
1920

2021
type OpenShift struct{}

0 commit comments

Comments
 (0)