Cyclops MCP（模型上下文协议）

1. Make sure Cyclops is installed in your Kubernetes cluster

Check our docs on how it install it with a single command - https://cyclops-ui.com/docs/installation/install/manifest

2. Download MCP server

You can download the Cyclops MCP server binary with the following command:

GOBIN="$HOME/go/bin" go install github.com/cyclops-ui/mcp-cyclops/cmd/mcp-cyclops@latest

3. Add server configuration

⚠️ By default, Cyclops MCP will use the .kube/config file to connect to your cluster

Configure your MCP Cyclops server:

{
  "mcpServers": {
    "mcp-cyclops": {
      "command": "mcp-cyclops"
    }
  }
}

Configuration

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.

{
  "mcpServers": {
    "mcp-cyclops": {
      "command": "mcp-cyclops",
      "env": {
        "KUBECONFIG": "/path/to/your/kubeconfig"
      }
    }
  }
}

Environment variables

Below is the list of environment variables used for configuring your Cyclops MCP server:

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.

1. Before installing, make sure Cyclops and all its CRDs are installed in your cluster:

   1. Check Cyclops pods are running:

      kubectl get pods -n cyclops
      

      Should write:

      NAME                            READY   STATUS    RESTARTS   AGE
      cyclops-ctrl-676b5d9789-ntcls   1/1     Running   0          94s
      cyclops-ui-7798655f97-xdg29     1/1     Running   0          94s
      

   2. Check if CRDs are installed

      kubectl get crds | grep cyclops-ui
      

      Should write:

      modules.cyclops-ui.com             2025-04-26T15:28:18Z
      templateauthrules.cyclops-ui.com   2025-04-26T15:28:18Z
      templatestores.cyclops-ui.com      2025-04-26T15:28:18Z
      

2. Install Cyclops MCP server with the following command:

   kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/mcp-cyclops/refs/heads/main/install/mcp-server.yaml
   

3. You can now expose the cyclops-mcp service. To test your MCP server, you can port-forward it:

   kubectl port-forward svc/cyclops-mcp -n cyclops 8000:8000
   

4. Add your Cyclops MCP server host, or in case you are testing it, the localhost address where you port-forwarded the MCP service:

   {
     "mcpServers": {
       "mcp-cyclops": {
         "url": "http://localhost:8000/sse"
       }
     }
   }