@futuretea/rancher-mcp-server 0.3.1 → 0.3.3

package/README.md

@@ -12,21 +12,26 @@ A powerful and flexible [Model Context Protocol (MCP)](https://blog.marcnuri.com
 
 - **✅ Multi-cluster Management**: Access and manage multiple Kubernetes clusters through Rancher API
 - **✅ Core Kubernetes Resources**: Perform operations on Kubernetes resources across multiple clusters
-  - **List** clusters, nodes, workloads, and namespaces
+  - **List** clusters, nodes, workloads, namespaces, services, configmaps, and secrets
   - **Get** kubeconfig for any cluster
+  - **Intelligent Diagnostic Chain**: Perform health checks with Service → Pods and Ingress → Service → Pods diagnostic chains
+  - **Ready/Degraded Dual-State Diagnosis**: Identify both critical failures and performance degradation
 - **✅ Rancher-specific Resources**: Access Rancher-specific resources
   - **List** Rancher projects and users
   - **Check** cluster health status
   - **View** project access permissions
 - **✅ Security Configuration**: Support for read-only mode and disabling destructive operations
+  - **Secrets Protection**: Secret data is never exposed, only metadata
 - **✅ Multiple Output Formats**: Support for table, YAML, and JSON output formats
+- **✅ Performance Optimized**: Intelligent API call caching reduces API calls by up to 93% during bulk operations
 - **✅ Cross-platform Support**: Available as native binaries for Linux, macOS, and Windows, as well as an npm package
 
 Unlike other Kubernetes MCP server implementations, this server is **specifically designed for Rancher multi-cluster environments** and provides seamless access to multiple clusters through a single interface.
 
 - **✅ Lightweight**: The server is distributed as a single native binary for Linux, macOS, and Windows
 - **✅ High-Performance / Low-Latency**: Directly interacts with Rancher API server without the overhead of calling external commands
-- **✅ Cross-Platform**: Available as a native binary for Linux, macOS, and Windows, as well as an npm package
+- **✅ Efficient Bulk Operations**: Optimized API calls with intelligent caching for diagnosing multiple resources
+- **✅ Self-Documenting**: Detailed tool descriptions help LLMs understand capabilities and select the right tools
 - **✅ Configurable**: Supports [command-line arguments](#configuration) to configure the server behavior
 - **✅ Well tested**: The server has an extensive test suite to ensure its reliability and correctness
 
@@ -54,7 +59,7 @@ Open your `claude_desktop_config.json` and add the mcp server to the list of `mc
         "-y",
         "@futuretea/rancher-mcp-server@latest",
         "--rancher-server-url",
-        "https://your-rancher-server.com",
+        "https://your-rancher-server.com/v3",
         "--rancher-token",
         "your-token"
       ]
@@ -69,10 +74,10 @@ Install the Rancher MCP server extension in VS Code by running the following com
 
 ```shell
 # For VS Code
-code --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com","--rancher-token","your-token"]}'
+code --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com/v3","--rancher-token","your-token"]}'
 
 # For VS Code Insiders
-code-insiders --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com","--rancher-token","your-token"]}'
+code-insiders --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com/v3","--rancher-token","your-token"]}'
 ```
 
 ### Cursor
@@ -88,7 +93,7 @@ Install the Rancher MCP server extension in Cursor by editing the `mcp.json` fil
         "-y",
         "@futuretea/rancher-mcp-server@latest",
         "--rancher-server-url",
-        "https://your-rancher-server.com",
+        "https://your-rancher-server.com/v3",
         "--rancher-token",
         "your-token"
       ]
@@ -120,14 +125,17 @@ npx @futuretea/rancher-mcp-server@latest --help
 | `--port` | Starts the MCP server in HTTP/SSE mode and listens on the specified port. Use 0 for stdio mode (default for MCP clients) |
 | `--sse-base-url` | SSE public base URL to use when sending the endpoint message (e.g. https://example.com) |
 | `--log-level` | Sets the logging level (values from 0-9) |
-| `--rancher-server-url` | URL of the Rancher server |
+| `--rancher-server-url` | URL of the Rancher server (must include `/v3` path, e.g., `https://your-rancher-server.com/v3`) |
 | `--rancher-token` | Bearer token for Rancher API authentication |
 | `--rancher-access-key` | Access key for Rancher API authentication |
 | `--rancher-secret-key` | Secret key for Rancher API authentication |
-| `--list-output` | Output format for resource list operations (one of: table, yaml, json) (default "table") |
+| `--rancher-tls-insecure` | Skip TLS certificate verification for Rancher server (default: false) |
+| `--list-output` | Output format for resource list operations (one of: table, yaml, json) (default "json") |
 | `--read-only` | If set, the MCP server will run in read-only mode, meaning it will not allow any write operations on the Rancher cluster |
 | `--disable-destructive` | If set, the MCP server will disable all destructive operations on the Rancher cluster |
-| `--toolsets` | Comma-separated list of toolsets to enable. Check the [🛠️ Tools and Functionalities](#tools-and-functionalities) section for more information |
+| `--toolsets` | Comma-separated list of toolsets to enable. Default: [config,core,rancher,networking] |
+| `--enabled-tools` | Comma-separated list of tools to enable (overrides toolsets) |
+| `--disabled-tools` | Comma-separated list of tools to disable (overrides toolsets) |
 
 ### Configuration File
 
@@ -140,18 +148,19 @@ log_level: 0
 # SSE (Server-Sent Events) configuration (optional, for HTTP/SSE mode)
 # sse_base_url: https://your-domain.com:8080
 
-rancher_server_url: https://your-rancher-server.com
+rancher_server_url: https://your-rancher-server.com/v3
 rancher_token: your-bearer-token
 # Or use Access Key/Secret Key:
 # rancher_access_key: your-access-key
 # rancher_secret_key: your-secret-key
-list_output: table
+list_output: json
 read_only: false
 disable_destructive: false
 toolsets:
   - config
   - core
   - rancher
+  - networking  # Optional: enable network resource management
 ```
 
 ### HTTP/SSE Mode
@@ -167,7 +176,7 @@ The Rancher MCP server supports running in HTTP/SSE (Server-Sent Events) mode fo
 ```shell
 # Start the server on port 8080
 rancher-mcp-server --port 8080 \
-  --rancher-server-url https://your-rancher-server.com \
+  --rancher-server-url https://your-rancher-server.com/v3 \
   --rancher-token your-token
 ```
 
@@ -185,7 +194,7 @@ When deploying behind a reverse proxy or load balancer, you can specify a public
 ```shell
 rancher-mcp-server --port 8080 \
   --sse-base-url https://your-domain.com:8080 \
-  --rancher-server-url https://your-rancher-server.com \
+  --rancher-server-url https://your-rancher-server.com/v3 \
   --rancher-token your-token
 ```
 
@@ -202,16 +211,17 @@ The following sets of tools are available (all on by default):
 | Toolset | Description |
 |---------|-------------|
 | config | Tools for managing cluster configuration (kubeconfig) |
-| core | Core Kubernetes resource management tools (clusters, nodes, workloads, namespaces) |
-| rancher | Rancher-specific tools (projects, users, cluster health, access control) |
+| core | Core Kubernetes resource management tools (nodes, workloads, namespaces, configmaps, secrets, services) |
+| rancher | Rancher-specific tools (clusters, projects, users, cluster health, access control) |
+| networking | Network resource management tools (ingresses) |
 
 ### Tools
 
 <details>
 <summary>config</summary>
 
-- **kubeconfig_get** - Get kubeconfig file for a cluster
-  - `cluster_id` (`string`) **(required)** - ID of the cluster to get kubeconfig for
+- **configuration_view** - Generate and view Kubernetes configuration (kubeconfig) for a Rancher cluster
+  - `cluster` (`string`) - Cluster ID to generate kubeconfig for
 
 </details>
 
@@ -219,44 +229,134 @@ The following sets of tools are available (all on by default):
 <summary>core</summary>
 
 - **cluster_list** - List all available Kubernetes clusters
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **node_get** - Get a single node by ID, more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `node` (`string`) **(required)** - Node ID to get
+  - `format` (`string`) - Output format: yaml or json (default: "json")
 
 - **node_list** - List all nodes in a cluster
   - `cluster` (`string`) - Cluster ID to list nodes from (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **workload_get** - Get a single workload by name and namespace, more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `namespace` (`string`) **(required)** - Namespace name
+  - `name` (`string`) **(required)** - Workload name to get
+  - `project` (`string`) - Project ID (optional, will auto-detect if not provided)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
 
 - **workload_list** - List workloads (deployments, statefulsets, daemonsets, jobs) and orphan pods in a cluster
   - `cluster` (`string`) **(required)** - Cluster ID
   - `project` (`string`) - Project ID to filter workloads (optional)
   - `namespace` (`string`) - Namespace name to filter workloads (optional)
   - `node` (`string`) - Node name to filter workloads (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **namespace_get** - Get a single namespace by name, more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `name` (`string`) **(required)** - Namespace name to get
+  - `format` (`string`) - Output format: yaml or json (default: "json")
 
 - **namespace_list** - List namespaces in a cluster
   - `cluster` (`string`) **(required)** - Cluster ID
   - `project` (`string`) - Project ID to filter namespaces (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **configmap_get** - Get a single ConfigMap by name and namespace, more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `namespace` (`string`) **(required)** - Namespace name
+  - `name` (`string`) **(required)** - ConfigMap name to get
+  - `project` (`string`) - Project ID (optional, will auto-detect if not provided)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
+
+- **configmap_list** - List all ConfigMaps in a cluster
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `project` (`string`) - Project ID to filter ConfigMaps (optional)
+  - `namespace` (`string`) - Namespace name to filter ConfigMaps (optional)
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **secret_get** - Get a single Secret by name and namespace, more efficient than list (metadata only, does not expose secret data)
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `namespace` (`string`) **(required)** - Namespace name
+  - `name` (`string`) **(required)** - Secret name to get
+  - `project` (`string`) - Project ID (optional, will auto-detect if not provided)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
+
+- **secret_list** - List all Secrets in a cluster (metadata only, does not expose secret data)
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `project` (`string`) - Project ID to filter secrets (optional)
+  - `namespace` (`string`) - Namespace name to filter secrets (optional)
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **service_get** - Get a single service by name with optional pod diagnostic check (Service → Pods), more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `namespace` (`string`) **(required)** - Namespace name
+  - `name` (`string`) **(required)** - Service name to get
+  - `project` (`string`) - Project ID (optional, will auto-detect if not provided)
+  - `getPodDetails` (`boolean`) - Get detailed pod information and perform health checks (default: false)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
+
+- **service_list** - List services with optional pod diagnostic check (Service → Pods)
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `project` (`string`) - Project ID to filter services (optional)
+  - `namespace` (`string`) - Namespace name to filter services (optional)
+  - `getPodDetails` (`boolean`) - Get pod information and perform health checks for services (default: false)
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
 
 </details>
 
 <details>
 <summary>rancher</summary>
 
+- **cluster_list** - List all available Kubernetes clusters
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **project_get** - Get a single Rancher project by ID, more efficient than list
+  - `project` (`string`) **(required)** - Project ID to get
+  - `cluster` (`string`) **(required)** - Cluster ID (required for verification)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
+
 - **project_list** - List Rancher projects across clusters
   - `cluster` (`string`) - Filter projects by cluster ID (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+- **user_get** - Get a single Rancher user by ID, more efficient than list
+  - `user` (`string`) **(required)** - User ID to get
+  - `format` (`string`) - Output format: yaml or json (default: "json")
 
 - **user_list** - List all Rancher users
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
 
 - **cluster_health** - Get health status of Rancher clusters
   - `cluster` (`string`) - Specific cluster ID to check health (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
 
 - **project_access** - List user access permissions for Rancher projects
   - `project` (`string`) - Project ID to check access (optional)
   - `cluster` (`string`) - Cluster ID (optional)
-  - `format` (`string`) - Output format: table, yaml, or json (default: "table")
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
+
+</details>
+
+<details>
+<summary>networking</summary>
+
+- **ingress_get** - Get a single ingress by name with diagnostic chain check (Ingress → Service → Pods), more efficient than list
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `namespace` (`string`) **(required)** - Namespace name
+  - `name` (`string`) **(required)** - Ingress name to get
+  - `project` (`string`) - Project ID (optional, will auto-detect if not provided)
+  - `getPodDetails` (`boolean`) - Get detailed pod information and perform health checks (default: false)
+  - `format` (`string`) - Output format: yaml or json (default: "json")
+
+- **ingress_list** - List ingresses with full diagnostic chain check (Ingress → Service → Pods)
+  - `cluster` (`string`) **(required)** - Cluster ID
+  - `project` (`string`) - Project ID to filter ingresses (optional)
+  - `namespace` (`string`) - Namespace name to filter ingresses (optional)
+  - `getPodDetails` (`boolean`) - Get detailed pod information and perform health checks (default: false)
+  - `format` (`string`) - Output format: table, yaml, or json (default: "json")
 
 </details>
 

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@futuretea/rancher-mcp-server",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Model Context Protocol (MCP) server for Rancher multi-cluster management",
   "main": "./bin/index.js",
   "bin": {
     "rancher-mcp-server": "bin/index.js"
   },
   "optionalDependencies": {
-    "@futuretea/rancher-mcp-server-darwin-amd64": "0.3.1",
-    "@futuretea/rancher-mcp-server-darwin-arm64": "0.3.1",
-    "@futuretea/rancher-mcp-server-linux-amd64": "0.3.1",
-    "@futuretea/rancher-mcp-server-linux-arm64": "0.3.1",
-    "@futuretea/rancher-mcp-server-windows-amd64": "0.3.1",
-    "@futuretea/rancher-mcp-server-windows-arm64": "0.3.1"
+    "@futuretea/rancher-mcp-server-darwin-amd64": "0.3.3",
+    "@futuretea/rancher-mcp-server-darwin-arm64": "0.3.3",
+    "@futuretea/rancher-mcp-server-linux-amd64": "0.3.3",
+    "@futuretea/rancher-mcp-server-linux-arm64": "0.3.3",
+    "@futuretea/rancher-mcp-server-windows-amd64": "0.3.3",
+    "@futuretea/rancher-mcp-server-windows-arm64": "0.3.3"
   },
   "repository": {
     "type": "git",