MCP K8S Go

https://github.com/strowk/mcp-k8s-go
Admin
A Golang-based MCP server that connects Claude and other MCP clients to Kubernetes clusters for...
Tokens:13,072
Snippets:122
Trust Score:8.9
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install mcptee for Development

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Install the mcptee tool, which is used for hot reloading and logging during development. Requires Go to be installed.

```bash
go install github.com/strowk/mcptee@latest
```

--------------------------------

### Install MCP K8S Go via npm

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Installs the MCP K8S Go server globally using npm. Verify the installation by checking the version.

```bash
# Global installation
npm install -g @strowk/mcp-k8s
```

```bash
# Verify installation
mcp-k8s --version
```

```bash
# Or run directly with npx
npx @strowk/mcp-k8s
```

--------------------------------

### MCP K8S Go - Installation

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Instructions for installing the MCP K8S Go server using various methods.

```APIDOC
## Installation

### Install via npm

```bash
# Global installation
npm install -g @strowk/mcp-k8s

# Verify installation
mcp-k8s --version

# Or run directly with npx
npx @strowk/mcp-k8s
```

### Install via Smithery (Auto-configures Claude Desktop)

```bash
npx -y @smithery/cli install @strowk/mcp-k8s --client claude
```

### Install via Docker

```bash
docker run -i -v ~/.kube/config:/home/nonroot/.kube/config --rm mcpk8s/server:latest
```

### Build from Source

```bash
go get github.com/strowk/mcp-k8s-go
go install github.com/strowk/mcp-k8s-go
```
```

--------------------------------

### Install via mcp-get

Source: https://github.com/strowk/mcp-k8s-go/blob/main/README.md

Automatically install the MCP server for Claude Desktop using the mcp-get package manager.

```bash
npx @michaellatman/mcp-get@latest install @strowk/mcp-k8s
```

--------------------------------

### Install MCP K8S Go via Smithery

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Installs MCP K8S Go using Smithery, which auto-configures it for Claude Desktop.

```bash
npx -y @smithery/cli install @strowk/mcp-k8s --client claude
```

--------------------------------

### Run project with synf

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Starts the project process with automatic reload capabilities.

```bash
synf dev .
```

--------------------------------

### MCP K8S Go - Claude Desktop Configuration

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Configuration examples for integrating MCP K8S Go with Claude Desktop.

```APIDOC
## Claude Desktop Configuration

### Basic Configuration

Add the MCP server to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "mcp-k8s",
      "args": []
    }
  }
}
```

### Configuration with npx

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "npx",
      "args": ["@strowk/mcp-k8s"]
    }
  }
}
```

### Configuration with Context Restrictions and Read-only Mode

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "mcp-k8s",
      "args": [
        "--allowed-contexts=dev,staging",
        "--readonly"
      ]
    }
  }
}
```

### Docker Configuration

```json
{
  "mcpServers": {
    "mcp_k8s_go": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "-v",
        "~/.kube/config:/home/nonroot/.kube/config",
        "--rm",
        "mcpk8s/server:latest"
      ]
    }
  }
}
```
```

--------------------------------

### Start Development Server with mcptee

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Launch the development server using mcptee, specifying log configuration, synf, and the project path. Replace the path with your local clone path.

```bash
mcptee dev.log.yaml synf dev .
```

```bash
mcptee C:/work/mcp-k8s-go/dev.log.yaml synf dev C:/work/mcp-k8s-go
```

--------------------------------

### Build MCP K8S Go from Source

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Builds and installs the MCP K8S Go server from its source code using Go commands.

```bash
go get github.com/strowk/mcp-k8s-go
go install github.com/strowk/mcp-k8s-go
```

--------------------------------

### Run GolangCI-Lint

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Execute the project's linter to check for code quality and style issues. Ensure golangci-lint is installed.

```bash
golangci-lint run
```

--------------------------------

### Run All Tests

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Execute all tests in the project. The first run may be slower due to image downloads and cluster setup.

```bash
go test
```

--------------------------------

### mcptee Configuration for Claude

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Example JSON configuration for mcptee, specifying server commands and arguments for development logging.

```json
{
    "mcpServers": {
      "mcp_k8s_dev": {
        "command": "mcptee",
        "args": [
          "C:/work/mcp-k8s-go/dev.log.yaml",
          "synf",
          "dev",
          "C:/work/mcp-k8s-go"
        ]
      }
    }
}
```

--------------------------------

### Install MCP K8S via npm

Source: https://github.com/strowk/mcp-k8s-go/blob/main/packages/npm-mcp-k8s/README.md

Install the MCP K8S package globally using npm. This command is used to add the MCP server to your system.

```bash
npm install -g @strowk/mcp-k8s
```

--------------------------------

### Get Pod Logs Since Specific Time

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves logs for 'my-nginx-pod' starting from a specific timestamp ('2024-12-01T19:00:08Z') using the 'sinceTime' argument.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 13,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod",
      "sinceTime": "2024-12-01T19:00:08Z"
    }
  }
}
```

--------------------------------

### Get Kubernetes Resource

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Gets detailed information about a specific Kubernetes resource. Returns the complete JSON object or renders output using a Go template.

```APIDOC
## POST /tools/call (get-k8s-resource)

### Description
Gets detailed information about a specific Kubernetes resource. Returns the complete JSON object or renders output using a Go template.

### Method
POST

### Endpoint
/tools/call

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tool to call, 'get-k8s-resource'.
- **arguments** (object) - Required - Arguments for the tool.
  - **context** (string) - Optional - The Kubernetes context to use.
  - **namespace** (string) - Required - The namespace of the resource.
  - **kind** (string) - Required - The kind of Kubernetes resource (e.g., 'Pod', 'Secret').
  - **name** (string) - Required - The name of the specific resource.
  - **go_template** (string) - Optional - A Go template string to format the output.

### Request Example (Get Pod Details)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 7,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "context": "minikube",
      "namespace": "kube-system",
      "kind": "Pod",
      "name": "coredns-5d78c9869d-abc12"
    }
  }
}
```

### Request Example (Get Resource with Go Template)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 8,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "kind": "Pod",
      "name": "my-pod",
      "namespace": "default",
      "go_template": "Name: {{.metadata.name}}, Status: {{.status.phase}}"
    }
  }
}
```

### Request Example (Get Secret - Masked by Default)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 9,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "kind": "Secret",
      "name": "my-secret",
      "namespace": "default"
    }
  }
}
```

### Response
#### Success Response (200)
- **content** (array) - An array of objects, each containing details of the resource.
  - **type** (string) - The type of content, usually 'text'.
  - **text** (string) - A JSON string representing the resource details or formatted output.

#### Response Example (Get Resource with Go Template)
```json
{
  "content": [
    {"type": "text", "text": "Name: my-pod, Status: Running"}
  ]
}
```

#### Response Example (Get Secret - Masked)
```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"apiVersion\":\"v1\",\"kind\":\"Secret\",\"data\":{\"password\":\"MASKED\",\"username\":\"MASKED\"}}"
    }
  ]
}
```
```

--------------------------------

### Claude Desktop MCP Server Configuration with npx

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Configures Claude Desktop to use MCP K8S Go via npx, allowing direct execution without global installation.

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "npx",
      "args": ["@strowk/mcp-k8s"]
    }
  }
}
```

--------------------------------

### Install MCP K8S Go via Docker

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Runs the MCP K8S Go server using Docker. Mounts the local kubeconfig file to allow access to Kubernetes clusters.

```bash
docker run -i -v ~/.kube/config:/home/nonroot/.kube/config --rm mcpk8s/server:latest
```

--------------------------------

### Get Kubernetes Resource with Go Template

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Fetches a Pod named 'my-pod' and formats the output using a Go template to display its name and status. This demonstrates the 'go_template' argument for custom output.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 8,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "kind": "Pod",
      "name": "my-pod",
      "namespace": "default",
      "go_template": "Name: {{.metadata.name}}, Status: {{.status.phase}}"
    }
  }
}
```

--------------------------------

### Get Pod Logs

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves logs for a pod named 'my-nginx-pod' in the 'default' namespace. This uses the 'get-k8s-pod-logs' method.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 11,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod"
    }
  }
}
```

--------------------------------

### Get Pod Logs from Last 5 Minutes

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Fetches logs for 'my-nginx-pod' from the last 5 minutes using the 'sinceDuration' argument. This is useful for recent activity monitoring.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 12,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod",
      "sinceDuration": "5m"
    }
  }
}
```

--------------------------------

### Get Kubernetes Secret (Masked)

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves a Secret named 'my-secret' from the 'default' namespace. Sensitive data within the secret is masked by default.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 9,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "kind": "Secret",
      "name": "my-secret",
      "namespace": "default"
    }
  }
}
```

--------------------------------

### Get Pod Logs with Byte Limit and Container Selection

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Fetches logs for a specific container ('sidecar') within 'my-multi-container-pod', limiting the output to 10000 bytes. This is useful for managing log size and targeting specific containers.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 14,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-multi-container-pod",
      "containerName": "sidecar",
      "limitBytes": 10000
    }
  }
}
```

--------------------------------

### Get Specific Kubernetes Pod Details

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves detailed information for a specific Pod named 'coredns-5d78c9869d-abc12' in the 'kube-system' namespace. This uses the 'get-k8s-resource' method.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 7,
  "params": {
    "name": "get-k8s-resource",
    "arguments": {
      "context": "minikube",
      "namespace": "kube-system",
      "kind": "Pod",
      "name": "coredns-5d78c9869d-abc12"
    }
  }
}
```

--------------------------------

### Get Pod Logs

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves logs from a specific pod. Supports time-based filtering, byte limits, previous container logs, and specific container selection.

```APIDOC
## POST /tools/call (get-k8s-pod-logs)

### Description
Retrieves logs from a specific pod. Supports time-based filtering, byte limits, previous container logs, and specific container selection.

### Method
POST

### Endpoint
/tools/call

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tool to call, 'get-k8s-pod-logs'.
- **arguments** (object) - Required - Arguments for the tool.
  - **context** (string) - Optional - The Kubernetes context to use.
  - **namespace** (string) - Required - The namespace of the pod.
  - **pod** (string) - Required - The name of the pod.
  - **containerName** (string) - Optional - The name of the container within the pod to get logs from.
  - **sinceDuration** (string) - Optional - Only return logs newer than a relative duration like '5m' or '1h'.
  - **sinceTime** (string) - Optional - Only return logs after a specific timestamp (RFC3339 format).
  - **limitBytes** (integer) - Optional - Maximum number of bytes of back-log to be written from the past logs for this container.
  - **previous** (boolean) - Optional - If true, print the logs for the previous instance of the container in a pod if it, becausethe container crashed.

### Request Example (Get Logs)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 11,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod"
    }
  }
}
```

### Request Example (Get Logs from Last 5 Minutes)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 12,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod",
      "sinceDuration": "5m"
    }
  }
}
```

### Request Example (Get Logs Since Specific Time)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 13,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod",
      "sinceTime": "2024-12-01T19:00:08Z"
    }
  }
}
```

### Request Example (Get Logs with Byte Limit and Container Selection)
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 14,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-multi-container-pod",
      "containerName": "sidecar",
      "limitBytes": 10000
    }
  }
}
```

### Response
#### Success Response (200)
- **content** (array) - An array of objects, each containing log lines.
  - **type** (string) - The type of content, usually 'text'.
  - **text** (string) - A string representing a log line or a JSON object with log details.

#### Response Example
```json
{
  "content": [
    {"type": "text", "text": "2024-12-02 10:00:00 INFO: Application started."} 
  ]
}
```
```

--------------------------------

### Get Previous Container Logs (Crashed Container)

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves logs from a previous instance of a container within a Kubernetes pod, useful for debugging crashed containers.

```APIDOC
## Get Previous Container Logs (Crashed Container)

### Description
Retrieves logs from a previous instance of a container within a Kubernetes pod. This is particularly useful for debugging containers that have crashed.

### Method
POST

### Endpoint
/tools/call

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **method** (string) - Required - The method to call, should be "tools/call".
- **id** (integer) - Required - A unique identifier for the request.
- **params** (object) - Required - Parameters for the method call.
  - **name** (string) - Required - The name of the tool to execute, "get-k8s-pod-logs".
  - **arguments** (object) - Required - Arguments for the tool.
    - **context** (string) - Optional - The Kubernetes context to use.
    - **namespace** (string) - Required - The namespace of the pod.
    - **pod** (string) - Required - The name of the pod.
    - **previousContainer** (boolean) - Required - Set to true to retrieve logs from a previous container instance.
```

--------------------------------

### Get Previous Container Logs

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Use this to retrieve logs from a previously crashed container within a Kubernetes pod. Specify the context, namespace, and pod name.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 15,
  "params": {
    "name": "get-k8s-pod-logs",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-crashing-pod",
      "previousContainer": true
    }
  }
}
```

--------------------------------

### Build the Project with Go Modules

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Use this command to build the project. Assumes Go modules are set up.

```bash
go build
```

--------------------------------

### Build and Run Commands

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CLAUDE.md

Standard commands for building, running with hot reload, and testing the application.

```bash
go build
```

```bash
arelo -p '**/*.go' -i '**/.*' -i '**/*_test.go' -- go run main.go
```

```bash
go test
```

```bash
go test -run '^TestName$'
```

```bash
go test -run '^TestListContexts$'
```

```bash
tools/generate-mocks.sh
```

```bash
golangci-lint run
```

--------------------------------

### Configure Claude Desktop for source build

Source: https://github.com/strowk/mcp-k8s-go/blob/main/README.md

Configuration for the claude_desktop_config.json file after building from source.

```json
{
  "mcpServers": {
    "mcp_k8s_go": {
      "command": "mcp-k8s-go",
      "args": []
    }
  }
}
```

--------------------------------

### Run project with jq output

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Pipes the server output through jq for prettified formatting.

```bash
synf dev . | jq
```

--------------------------------

### MCP Prompts - List Kubernetes Namespaces

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

A pre-built prompt to list all Kubernetes namespaces within a specified context, formatted for AI interaction.

```APIDOC
## MCP Prompts - List Kubernetes Namespaces

### Description
A pre-built prompt designed to list all Kubernetes namespaces in a given context. The output is formatted to be easily consumable in AI-driven conversations.

### Method
POST

### Endpoint
/prompts/get

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **method** (string) - Required - The method to call, should be "prompts/get".
- **id** (integer) - Required - A unique identifier for the request.
- **params** (object) - Required - Parameters for the method call.
  - **name** (string) - Required - The name of the prompt, "list-k8s-namespaces".
  - **arguments** (object) - Required - Arguments for the prompt.
    - **context** (string) - Required - The Kubernetes context from which to list namespaces.
```

--------------------------------

### Configure Claude Desktop for GitHub release binary

Source: https://github.com/strowk/mcp-k8s-go/blob/main/README.md

Configuration for the claude_desktop_config.json file after placing the binary in your PATH.

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "mcp-k8s-go",
      "args": []
    }
  }
}
```

--------------------------------

### Run MCP Kubernetes with npx

Source: https://github.com/strowk/mcp-k8s-go/blob/main/README.md

Executes the server directly using npx.

```bash
npx @strowk/mcp-k8s
```

--------------------------------

### List available tools via JSON-RPC

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Sends a tools/list request to the server to discover available functionality.

```json
{ "jsonrpc": "2.0", "method": "tools/list", "id": 1, "params": {} }
```

--------------------------------

### Configure Claude Desktop for npx

Source: https://github.com/strowk/mcp-k8s-go/blob/main/README.md

Configuration for the claude_desktop_config.json file when using npx.

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "npx",
      "args": [
        "@strowk/mcp-k8s"
      ]
    }
  }
}
```

--------------------------------

### Run with mcptee logging

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Captures server-client communication to a YAML file while running the server.

```bash
mcptee log.yaml synf dev C:/work/mcp-k8s-go
```

--------------------------------

### MCP K8S Go - Command-line Options

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Available command-line options for the mcp-k8s executable.

```APIDOC
## Command-line Options

```bash
# Show help
mcp-k8s --help

# Show version
mcp-k8s --version

# Restrict to specific contexts
mcp-k8s --allowed-contexts=dev,prod

# Enable read-only mode (disables write operations)
mcp-k8s --readonly

# Disable secret masking (secrets are masked by default)
mcp-k8s --mask-secrets=false
```
```

--------------------------------

### Kubernetes Contexts as Resources

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists available Kubernetes contexts exposed as MCP resources, allowing clients to select and utilize specific contexts.

```APIDOC
## Kubernetes Contexts as Resources

### Description
This endpoint exposes Kubernetes contexts as MCP resources. Clients can use this to discover and select the specific Kubernetes context they wish to interact with.

### Method
POST

### Endpoint
/resources/list

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **method** (string) - Required - The method to call, should be "resources/list".
- **id** (integer) - Required - A unique identifier for the request.
- **params** (object) - Required - Parameters for the method call. This endpoint typically accepts an empty params object.

### Response
#### Success Response (200)
- **result** (object) - Contains the list of available resources.
  - **resources** (array) - A list of resource objects.
    - **name** (string) - The name of the resource (e.g., a Kubernetes context name).
    - **description** (string) - A description of the resource.
    - **uri** (string) - The unique identifier or URI for the resource (e.g., "contexts/minikube").
    - **annotations** (object) - Optional annotations for the resource.
```

--------------------------------

### Claude Desktop Basic MCP Server Configuration

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Configures a basic MCP server for Kubernetes interaction in Claude Desktop's configuration file.

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "mcp-k8s",
      "args": []
    }
  }
}
```

--------------------------------

### MCP K8S Go Command-line Options

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Common command-line options for the MCP K8S Go server, including help, version, context restriction, read-only mode, and secret masking.

```bash
# Show help
mcp-k8s --help
```

```bash
# Show version
mcp-k8s --version
```

```bash
# Restrict to specific contexts
mcp-k8s --allowed-contexts=dev,prod
```

```bash
# Enable read-only mode (disables write operations)
mcp-k8s --readonly
```

```bash
# Disable secret masking (secrets are masked by default)
mcp-k8s --mask-secrets=false
```

--------------------------------

### MCP Tools - list-k8s-contexts

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists all available Kubernetes contexts from kubeconfig files.

```APIDOC
## MCP Tools

### list-k8s-contexts

Lists all available Kubernetes contexts from kubeconfig files. Returns context name, cluster information, and indicates which context is currently active.

#### Request Example

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 1,
  "params": {
    "name": "list-k8s-contexts",
    "arguments": {}
  }
}
```

#### Response Example (Success)

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"context\":{\"cluster\":\"minikube\",\"user\":\"minikube\"},\"name\":\"minikube\",\"current\":true}"
    },
    {
      "type": "text",
      "text": "{\"context\":{\"cluster\":\"production\",\"user\":\"admin\"},\"name\":\"production\",\"current\":false}"
    }
  ]
}
```
```

--------------------------------

### MCP Prompts - List Kubernetes Pods

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

A pre-built prompt to list pods within a Kubernetes namespace or across all namespaces, with support for namespace auto-completion.

```APIDOC
## MCP Prompts - List Kubernetes Pods

### Description
A pre-built prompt that lists all pods within a specified namespace or across all namespaces. It includes support for auto-completing namespace names, enhancing usability.

### Method
POST

### Endpoint
/prompts/get

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **method** (string) - Required - The method to call, should be "prompts/get".
- **id** (integer) - Required - A unique identifier for the request.
- **params** (object) - Required - Parameters for the method call.
  - **name** (string) - Required - The name of the prompt, "list-k8s-pods".
  - **arguments** (object) - Required - Arguments for the prompt.
    - **namespace** (string) - Required - The namespace in which to list pods. Can be omitted to list across all namespaces.
```

--------------------------------

### List Kubernetes Namespaces

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves a list of all Kubernetes namespaces within a specified context. This prompt is formatted for AI conversation.

```json
{
  "jsonrpc": "2.0",
  "method": "prompts/get",
  "id": 21,
  "params": {
    "name": "list-k8s-namespaces",
    "arguments": {
      "context": "minikube"
    }
  }
}
```

--------------------------------

### List Kubernetes Contexts

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Fetches a list of available Kubernetes contexts exposed as MCP resources. This allows clients to select and utilize specific contexts.

```json
{
  "jsonrpc": "2.0",
  "method": "resources/list",
  "id": 23,
  "params": {}
}
```

--------------------------------

### Inspect MCP K8s Capabilities

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Use the MCP Inspector CLI tool to browse the capabilities of the mcp-k8s-go project. This command helps in understanding available functions and resources.

```bash
npx @modelcontextprotocol/inspector npx @strowk/mcp-k8s
```

--------------------------------

### Claude Desktop Docker MCP Server Configuration

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Configures Claude Desktop to run the MCP K8S Go server using Docker, mounting the kubeconfig for cluster access.

```json
{
  "mcpServers": {
    "mcp_k8s_go": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "-v",
        "~/.kube/config:/home/nonroot/.kube/config",
        "--rm",
        "mcpk8s/server:latest"
      ]
    }
  }
}
```

--------------------------------

### Debug with MCP inspector

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Launches the MCP inspector UI to interact with the server and monitor requests.

```bash
npx @modelcontextprotocol/inspector synf dev .
```

--------------------------------

### List Kubernetes Resources

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists arbitrary Kubernetes resources by kind. Supports filtering by namespace, API group, and version. Works with built-in and custom resources.

```APIDOC
## POST /tools/call (list-k8s-resources)

### Description
Lists arbitrary Kubernetes resources by kind. Supports filtering by namespace, API group, and version. Works with built-in and custom resources.

### Method
POST

### Endpoint
/tools/call

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tool to call, 'list-k8s-resources'.
- **arguments** (object) - Required - Arguments for the tool.
  - **context** (string) - Optional - The Kubernetes context to use.
  - **namespace** (string) - Optional - The namespace to filter resources by.
  - **kind** (string) - Required - The kind of Kubernetes resource to list (e.g., 'Pod', 'Deployment').
  - **group** (string) - Optional - The API group of the resource (e.g., 'apps').
  - **version** (string) - Optional - The API version of the resource (e.g., 'v1').

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 4,
  "params": {
    "name": "list-k8s-resources",
    "arguments": {
      "context": "minikube",
      "namespace": "kube-system",
      "kind": "Pod"
    }
  }
}
```

### Response
#### Success Response (200)
- **content** (array) - An array of objects, each containing details of a resource.
  - **type** (string) - The type of content, usually 'text'.
  - **text** (string) - A JSON string representing the resource details.

#### Response Example
```json
{
  "content": [
    {"type": "text", "text": "{\"name\":\"coredns-5d78c9869d-abc12\",\"namespace\":\"kube-system\"}"},
    {"type": "text", "text": "{\"name\":\"etcd-minikube\",\"namespace\":\"kube-system\"}"},
    {"type": "text", "text": "{\"name\":\"kube-apiserver-minikube\",\"namespace\":\"kube-system\"}"}
  ]
}
```
```

--------------------------------

### List Kubernetes Pods in a Namespace

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Use this to list all Pod resources within the 'kube-system' namespace. Requires the 'list-k8s-resources' method.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 4,
  "params": {
    "name": "list-k8s-resources",
    "arguments": {
      "context": "minikube",
      "namespace": "kube-system",
      "kind": "Pod"
    }
  }
}
```

--------------------------------

### Configure Claude Desktop with MCP K8S

Source: https://github.com/strowk/mcp-k8s-go/blob/main/packages/npm-mcp-k8s/README.md

Add the MCP K8S server configuration to your Claude Desktop settings. This allows Claude Desktop to connect to the MCP K8S server.

```json
{
    "mcpServers": {
        "mcp_k8s": {
            "command": "mcp-k8s",
            "args": []
        }
    }
}
```

--------------------------------

### List Kubernetes Services in a Namespace

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists all Service resources within the 'default' namespace using the 'list-k8s-resources' method. No specific API group is required for Services.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 6,
  "params": {
    "name": "list-k8s-resources",
    "arguments": {
      "kind": "Service",
      "namespace": "default"
    }
  }
}
```

--------------------------------

### Configure Claude Desktop with Specific Contexts and Readonly Mode

Source: https://github.com/strowk/mcp-k8s-go/blob/main/packages/npm-mcp-k8s/README.md

Configure Claude Desktop to use specific Kubernetes contexts and enable readonly mode for the MCP K8S server. This limits access to 'dev' and 'prod' contexts and prevents any write operations to the cluster.

```json
{
    "mcpServers": {
        "mcp_k8s": {
            "command": "mcp-k8s",
            "args": [
                "--allowed-contexts=dev,prod",
                "--readonly"
            ]
        }
    }
}
```

--------------------------------

### MCP Tools - list-k8s-namespaces

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists all namespaces in a Kubernetes cluster. Optionally specify a context; defaults to the current context if not provided.

```APIDOC
### list-k8s-namespaces

Lists all namespaces in a Kubernetes cluster. Optionally specify a context; defaults to the current context if not provided.

#### Request Example

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 2,
  "params": {
    "name": "list-k8s-namespaces",
    "arguments": {
      "context": "minikube"
    }
  }
}
```

#### Response Example (Success)

```json
{
  "content": [
    {"type": "text", "text": "{\"name\":\"default\"}"},
    {"type": "text", "text": "{\"name\":\"kube-node-lease\"}"},
    {"type": "text", "text": "{\"name\":\"kube-public\"}"},
    {"type": "text", "text": "{\"name\":\"kube-system\"}"}
  ]
}
```
```

--------------------------------

### MCP Tool: List Kubernetes Namespaces

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Calls the 'list-k8s-namespaces' MCP tool to list all namespaces in a Kubernetes cluster. An optional context can be specified; otherwise, it defaults to the current context.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 2,
  "params": {
    "name": "list-k8s-namespaces",
    "arguments": {
      "context": "minikube"
    }
  }
}
```

```json
{
  "content": [
    {"type": "text", "text": "{\"name\":\"default\"}"},
    {"type": "text", "text": "{\"name\":\"kube-node-lease\"}"},
    {"type": "text", "text": "{\"name\":\"kube-public\"}"},
    {"type": "text", "text": "{\"name\":\"kube-system\"}"}
  ]
}
```

--------------------------------

### List Kubernetes Deployments in a Namespace

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

This snippet lists all Deployment resources in the 'default' namespace, specifying the 'apps/v1' API group. It utilizes the 'list-k8s-resources' method.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 5,
  "params": {
    "name": "list-k8s-resources",
    "arguments": {
      "kind": "Deployment",
      "group": "apps",
      "version": "v1",
      "namespace": "default"
    }
  }
}
```

--------------------------------

### Apply Kubernetes Resource from Manifest

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Creates or updates Kubernetes resources defined in a YAML manifest. This can include single or multiple resources, such as ConfigMaps or Deployments. Ensure the manifest is valid YAML.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 18,
  "params": {
    "name": "apply-k8s-resource",
    "arguments": {
      "context": "minikube",
      "manifest": "apiVersion: v1\nkind: ConfigMap\nmetadata:\n  name: my-config\n  namespace: default\ndata:\n  key1: value1\n  key2: value2"
    }
  }
}
```

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 19,
  "params": {
    "name": "apply-k8s-resource",
    "arguments": {
      "manifest": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: nginx-deployment\n  namespace: default\nspec:\n  replicas: 3\n  selector:\n    matchLabels:\n      app: nginx\n  template:\n    metadata:\n      labels:\n        app: nginx\n    spec:\n      containers:\n      - name: nginx\n        image: nginx:1.21\n        ports:\n        - containerPort: 80"
    }
  }
}
```

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 20,
  "params": {
    "name": "apply-k8s-resource",
    "arguments": {
      "manifest": "apiVersion: v1\nkind: Namespace\nmetadata:\n  name: my-app\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n  name: app-config\n  namespace: my-app\ndata:\n  APP_ENV: production"
    }
  }
}
```

--------------------------------

### Run Specific Test with Go Test

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Run a specific test case, such as 'TestListContexts', using a regular expression to filter test names.

```bash
go test -run '^TestListContexts$'
```

--------------------------------

### Execute Command in Kubernetes Pod

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Executes a command inside a specified Kubernetes pod. Supports standard input and captures standard output and error streams. Ensure the pod and namespace are correctly identified.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 16,
  "params": {
    "name": "k8s-pod-exec",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "pod": "my-nginx-pod",
      "command": "ls -la /var/log"
    }
  }
}
```

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 17,
  "params": {
    "name": "k8s-pod-exec",
    "arguments": {
      "namespace": "default",
      "pod": "my-pod",
      "command": "cat > /tmp/myfile.txt",
      "stdin": "Hello from MCP K8S!"
    }
  }
}
```

--------------------------------

### Claude Desktop MCP Server Configuration with Context Restrictions and Read-only Mode

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Configures Claude Desktop to use MCP K8S Go with specific context restrictions and read-only mode enabled for enhanced security.

```json
{
  "mcpServers": {
    "mcp_k8s": {
      "command": "mcp-k8s",
      "args": [
        "--allowed-contexts=dev,staging",
        "--readonly"
      ]
    }
  }
}
```

--------------------------------

### List Kubernetes Pods

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists all pods within a specified namespace or across all namespaces. Supports auto-completion for namespace names.

```json
{
  "jsonrpc": "2.0",
  "method": "prompts/get",
  "id": 22,
  "params": {
    "name": "list-k8s-pods",
    "arguments": {
      "namespace": "kube-system"
    }
  }
}
```

--------------------------------

### MCP Tool: List Kubernetes Contexts

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Calls the 'list-k8s-contexts' MCP tool to retrieve all available Kubernetes contexts from kubeconfig files. The response includes context name, cluster info, and active status.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 1,
  "params": {
    "name": "list-k8s-contexts",
    "arguments": {}
  }
}
```

```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"context\":{\"cluster\":\"minikube\",\"user\":\"minikube\"},\"name\":\"minikube\",\"current\":true}"
    },
    {
      "type": "text",
      "text": "{\"context\":{\"cluster\":\"production\",\"user\":\"admin\"},\"name\":\"production\",\"current\":false}"
    }
  ]
}
```

--------------------------------

### Configure git hooks

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

Sets the local git hooks path to the project's .githooks directory.

```bash
git config core.hooksPath .githooks
```

--------------------------------

### List Kubernetes Events

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists Kubernetes events in a specified namespace. Useful for debugging and monitoring cluster activity.

```APIDOC
## POST /tools/call (list-k8s-events)

### Description
Lists Kubernetes events in a specified namespace. Useful for debugging and monitoring cluster activity.

### Method
POST

### Endpoint
/tools/call

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tool to call, 'list-k8s-events'.
- **arguments** (object) - Required - Arguments for the tool.
  - **context** (string) - Optional - The Kubernetes context to use.
  - **namespace** (string) - Required - The namespace to list events from.
  - **limit** (integer) - Optional - The maximum number of events to return.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 10,
  "params": {
    "name": "list-k8s-events",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "limit": 10
    }
  }
}
```

### Response
#### Success Response (200)
- **content** (array) - An array of objects, each representing a Kubernetes event.
  - **type** (string) - The type of content, usually 'text'.
  - **text** (string) - A JSON string representing the event details.

#### Response Example
```json
{
  "content": [
    {
      "type": "text",
      "text": "{\"action\":\"Binding\",\"message\":\"Successfully assigned default/my-pod to minikube\",\"type\":\"Normal\",\"reason\":\"Scheduled\",\"involvedObject\":{\"kind\":\"Pod\",\"name\":\"my-pod\"}}"
    },
    {
      "type": "text",
      "text": "{\"action\":\"\",\"message\":\"Started container nginx\",\"type\":\"Normal\",\"reason\":\"Started\",\"involvedObject\":{\"kind\":\"Pod\",\"name\":\"my-pod\"}}"
    }
  ]
}
```
```

--------------------------------

### List Kubernetes Events

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Lists Kubernetes events within the 'default' namespace, with a limit of 10 events. This is useful for monitoring cluster activity and debugging. Requires the 'list-k8s-events' method.

```json
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "id": 10,
  "params": {
    "name": "list-k8s-events",
    "arguments": {
      "context": "minikube",
      "namespace": "default",
      "limit": 10
    }
  }
}
```

--------------------------------

### Read a Specific Context Resource

Source: https://context7.com/strowk/mcp-k8s-go/llms.txt

Retrieves details for a specific Kubernetes context resource using its URI.

```APIDOC
## Read a Specific Context Resource

### Description
Retrieves detailed information about a specific Kubernetes context resource. The resource is identified by its unique URI.

### Method
POST

### Endpoint
/resources/read

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC version.
- **method** (string) - Required - The method to call, should be "resources/read".
- **id** (integer) - Required - A unique identifier for the request.
- **params** (object) - Required - Parameters for the method call.
  - **uri** (string) - Required - The URI of the resource to read (e.g., "contexts/minikube").
```

--------------------------------

### Delete k3d Cluster

Source: https://github.com/strowk/mcp-k8s-go/blob/main/CONTRIBUTING.md

If the k3d cluster is not deleted automatically after tests, use this command to remove it manually.

```bash
k3d cluster delete mcp-k8s-integration-test
```
Tokens:
Raw