Skip to content

Commit 9c2d187

Browse files
committed
install mcp as addon docs
1 parent d120610 commit 9c2d187

File tree

1 file changed

+77
-31
lines changed

1 file changed

+77
-31
lines changed

README.md

Lines changed: 77 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,41 @@ It allows you to move fast and ensure no uncaught misconfigurations are hitting
1414

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

17-
## Install
17+
## Install via UI
18+
19+
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.
20+
21+
> ⚠️ To install Cyclops MCP through the UI, you should run Cyclops on a version `v0.20.1` or greater
22+
23+
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.
24+
25+
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.
26+
27+
To expose the MCP server on localhost you can simply port-forward it with the following command:
28+
29+
```bash
30+
kubectl port-forward -n cyclops svc/cyclops-mcp 8000:8000
31+
```
32+
33+
Your server is now available on `localhost:8000`.
34+
35+
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:
36+
37+
```bash
38+
{
39+
"mcpServers": {
40+
"mcp-cyclops": {
41+
"url": "http://localhost:8000/sse"
42+
}
43+
}
44+
}
45+
```
46+
47+
You can now start a fresh conversation with your AI companion. Above is an example of how we used it with Cursor.
48+
49+
<details>
50+
51+
<summary>Install stdin binary</summary>
1852

1953
### 1. Make sure Cyclops is installed in your Kubernetes cluster
2054

@@ -44,7 +78,45 @@ Configure your MCP Cyclops server:
4478
}
4579
```
4680

47-
## Install on a Kubernetes cluster
81+
## Configuration
82+
83+
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.
84+
85+
```json
86+
{
87+
"mcpServers": {
88+
"mcp-cyclops": {
89+
"command": "mcp-cyclops",
90+
"env": {
91+
"KUBECONFIG": "/path/to/your/kubeconfig"
92+
}
93+
}
94+
}
95+
}
96+
97+
```
98+
99+
### Environment variables
100+
101+
Below is the list of environment variables used for configuring your Cyclops MCP server:
102+
103+
| Env var | Description |
104+
|-----------------------------------|-----------------------------------------------------------------------------------------|
105+
| `KUBECONFIG` | Path to kubeconfig file (optional, defaults to in-cluster config or $HOME/.kube/config) |
106+
| `CYCLOPS_KUBE_CONTEXT` | Kubernetes context to use (optional) |
107+
| `CYCLOPS_MODULE_NAMESPACE` | Namespace where modules are stored |
108+
| `CYCLOPS_HELM_RELEASE_NAMESPACE` | Namespace for Helm releases |
109+
| `CYCLOPS_MODULE_TARGET_NAMESPACE` | Target namespace for modules |
110+
111+
---
112+
113+
</details>
114+
115+
<details>
116+
117+
<summary>
118+
Install to a Kubernetes cluster manually
119+
</summary>
48120

49121
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.
50122

@@ -100,6 +172,9 @@ Instead of having each developer install `mcp-cyclops` binary, you can install t
100172
}
101173
}
102174
```
175+
---
176+
177+
</details>
103178

104179
## Tools
105180

@@ -113,32 +188,3 @@ Instead of having each developer install `mcp-cyclops` binary, you can install t
113188
| `get_template_store` | Fetch Template Store by Name |
114189
| `list_template_store` | List Template Stores from cluster |
115190

116-
## Configuration
117-
118-
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.
119-
120-
```json
121-
{
122-
"mcpServers": {
123-
"mcp-cyclops": {
124-
"command": "mcp-cyclops",
125-
"env": {
126-
"KUBECONFIG": "/path/to/your/kubeconfig"
127-
}
128-
}
129-
}
130-
}
131-
132-
```
133-
134-
### Environment variables
135-
136-
Below is the list of environment variables used for configuring your Cyclops MCP server:
137-
138-
| Env var | Description |
139-
|-----------------------------------|-----------------------------------------------------------------------------------------|
140-
| `KUBECONFIG` | Path to kubeconfig file (optional, defaults to in-cluster config or $HOME/.kube/config) |
141-
| `CYCLOPS_KUBE_CONTEXT` | Kubernetes context to use (optional) |
142-
| `CYCLOPS_MODULE_NAMESPACE` | Namespace where modules are stored |
143-
| `CYCLOPS_HELM_RELEASE_NAMESPACE` | Namespace for Helm releases |
144-
| `CYCLOPS_MODULE_TARGET_NAMESPACE` | Target namespace for modules |

0 commit comments

Comments
 (0)