Skip to content

Commit 042ad24

Browse files
petar-cvitpetar-cvit
committed
πŸ“š mcp addon docs
1 parent 7cae47c commit 042ad24

2 files changed

Lines changed: 84 additions & 35 deletions

File tree

β€Žweb/docs/mcp/about.mdβ€Ž

Lines changed: 84 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,43 @@ It allows you to move fast and ensure no uncaught misconfigurations are hitting
1313

1414
**With Cyclops and our MCP, you can now abstract Kubernetes complexity from your developers AND your AI agents**
1515

16-
## Install
16+
## Install via UI
17+
18+
The easiest way to install the Cyclops MCP server is through the Cyclops UI. Below are instructions on how to install it via binary and kubectl, but the recommended way of installing it is via the UI.
19+
20+
> ⚠️ To install Cyclops MCP through the UI, you should run Cyclops on a version `v0.20.1` or greater
21+
22+
1. Install the Cyclops MCP by going to sidebar `β€œAddon”` > `"MCP server"`. You can now click `"Install Cyclops MCP server"` and your Cyclops MCP server will be up and running in a few seconds.
23+
24+
![Cyclops MCP Addon](../../static/img/mcp/mcp-addon.png)
25+
26+
2. Now that your MCP server is up running, all thats left is exposing it outside of your cluster and connecting your AI agent to it.
27+
28+
To expose the MCP server on localhost you can simply port-forward it with the following command:
29+
30+
```bash
31+
kubectl port-forward -n cyclops svc/cyclops-mcp 8000:8000
32+
```
33+
34+
Your server is now available on `localhost:8000`.
35+
36+
3. To connect it to an AI agent you will just have to provide the Cyclops MCP server in its configuration. For example, to add it to Cursor, you can simply add it with the following JSON:
37+
38+
```bash
39+
{
40+
"mcpServers": {
41+
"cyclops-kubernetes": {
42+
"url": "http://localhost:8000/sse"
43+
}
44+
}
45+
}
46+
```
47+
48+
You can now start a fresh conversation with your AI companion. Above is an example of how we used it with Cursor.
49+
50+
<details>
51+
52+
<summary>Install stdin binary</summary>
1753

1854
### 1. Make sure Cyclops is installed in your Kubernetes cluster
1955

@@ -36,14 +72,54 @@ Configure your MCP Cyclops server:
3672
```json
3773
{
3874
"mcpServers": {
39-
"cyclops-kubernetes": {
40-
"url": "http://localhost:8000/sse"
75+
"mcp-cyclops": {
76+
"command": "mcp-cyclops"
77+
}
78+
}
79+
}
80+
```
81+
82+
## Configuration
83+
84+
You can configure Cyclops MCP server via env variables. Below is an example of adding the configuration for specifying the kubeconfig file the Cyclops MCP server should use when managing your Cyclops applications.
85+
86+
```json
87+
{
88+
"mcpServers": {
89+
"mcp-cyclops": {
90+
"command": "mcp-cyclops",
91+
"env": {
92+
"KUBECONFIG": "/path/to/your/kubeconfig"
93+
}
4194
}
4295
}
4396
}
97+
4498
```
4599

46-
## Install on a Kubernetes cluster
100+
### Environment variables
101+
102+
Below is the list of environment variables used for configuring your Cyclops MCP server:
103+
104+
| Env var | Description |
105+
|-----------------------------------|-----------------------------------------------------------------------------------------|
106+
| `KUBECONFIG` | Path to kubeconfig file (optional, defaults to in-cluster config or $HOME/.kube/config) |
107+
| `CYCLOPS_KUBE_CONTEXT` | Kubernetes context to use (optional) |
108+
| `CYCLOPS_MODULE_NAMESPACE` | Namespace where modules are stored |
109+
| `CYCLOPS_HELM_RELEASE_NAMESPACE` | Namespace for Helm releases |
110+
| `CYCLOPS_MODULE_TARGET_NAMESPACE` | Target namespace for modules |
111+
112+
---
113+
114+
</details>
115+
116+
<details>
117+
118+
<summary>
119+
Install to a Kubernetes cluster manually
120+
</summary>
121+
122+
---
47123

48124
Instead of having each developer install `mcp-cyclops` binary, you can install the Cyclops MCP server with SSE as transport type to your Kubernetes cluster and allow all of your developers to connect to the same server.
49125

@@ -99,6 +175,9 @@ Instead of having each developer install `mcp-cyclops` binary, you can install t
99175
}
100176
}
101177
```
178+
---
179+
180+
</details>
102181

103182
## Tools
104183

@@ -110,34 +189,4 @@ Instead of having each developer install `mcp-cyclops` binary, you can install t
110189
| `update_module` | Update Module by Name. Before calling this tool, make sure to call `get_template_schema` to validate values for the given template |
111190
| `get_template_schema` | Returns JSON schema for the given template. Needs to be checked before calling `create_module` tool |
112191
| `get_template_store` | Fetch Template Store by Name |
113-
| `list_template_store` | List Template Stores from cluster |
114-
115-
## Configuration
116-
117-
You can configure Cyclops MCP server via env variables. Below is an example of adding the configuration for specifying the kubeconfig file the Cyclops MCP server should use when managing your Cyclops applications.
118-
119-
```json
120-
{
121-
"mcpServers": {
122-
"mcp-cyclops": {
123-
"command": "mcp-cyclops",
124-
"env": {
125-
"KUBECONFIG": "/path/to/your/kubeconfig"
126-
}
127-
}
128-
}
129-
}
130-
131-
```
132-
133-
### Environment variables
134-
135-
Below is the list of environment variables used for configuring your Cyclops MCP server:
136-
137-
| Env var | Description |
138-
|-----------------------------------|-----------------------------------------------------------------------------------------|
139-
| `KUBECONFIG` | Path to kubeconfig file (optional, defaults to in-cluster config or $HOME/.kube/config) |
140-
| `CYCLOPS_KUBE_CONTEXT` | Kubernetes context to use (optional) |
141-
| `CYCLOPS_MODULE_NAMESPACE` | Namespace where modules are stored |
142-
| `CYCLOPS_HELM_RELEASE_NAMESPACE` | Namespace for Helm releases |
143-
| `CYCLOPS_MODULE_TARGET_NAMESPACE` | Target namespace for modules |
192+
| `list_template_store` | List Template Stores from cluster |

β€Žweb/static/img/mcp/mcp-addon.pngβ€Ž

440 KB
Loading

0 commit comments

Comments
Β (0)