MCP K8s Server

🚀 MCP-K8S Server

MCP-K8S is a Python-based Kubernetes resource management tool that provides access to and operations on Kubernetes cluster resources through the Model Context Protocol (MCP). This tool supports multiple resource types and offers a wide range of features for managing and monitoring Kubernetes resources.

🚀 Quick Start

Start the Server

To start the MCP-K8S server, run the following command:

python -m mcp_k8s_server.run --kube-config ~/.kube/config

By default, the server will run at http://localhost:8000.

Configuration File

You can customize the server's behavior by editing the configuration file. The format of the configuration file is as follows:

# config.yaml
server:
  name: mcp-k8s-server
  transport: both  # Supports stdio, sse, or both
  port: 8000
  host: 0.0.0.0

kubernetes:
  config_path: ~/.kube/config
  context: default
  namespace: default

Test the Connection

After starting the server, you can access it at http://localhost:8000 or interact with it using an MCP client tool.

📦 Installation

To install the MCP-K8S server, run the following command:

pip install mcp-k8s-server

🔗 Resource URI Patterns

The MCP-K8S server supports the following resource URI patterns:

Namespaced Resources

• k8s://{namespace}/{resource_type} - Get all resources of a specific type in the specified namespace.
  • Example: k8s://default/pods - Get all pods in the default namespace.
• k8s:///{namespace}/{resource_type}/{name} - Get a single resource of a specific type in the specified namespace.
  • Example: k8s://default/deployments/nginx - Get the deployment named nginx in the default namespace.

Cluster-wide Resources

• k8s:///{resource_type} - Get all resources of a specific type across the cluster.
  • Example: k8s:///nodes - Get all nodes in the cluster.
• k8s:///{resource_type}/{name} - Get a single resource of a specific type across the cluster.
  • Example: k8s:///nodes/worker-1 - Get the node named worker-1.

Supported Resource Types

Namespaced Resources

• pods
• deployments
• services
• persistentvolumeclaims
• events

Cluster-wide Resources

• nodes
• persistentvolumes
• namespaces

✨ Features

The MCP-K8S server provides the following features:

Resource Information

• get_resources: Get all resources of a specified type.
• get_resource: Get detailed information about a specific resource.
• get_namespaces: Get all available namespaces.
• get_events: Get all events in the cluster.

Resource Operations

• create_pod: Create a new pod.
• delete_pod: Delete a specified pod.
• update_deployment: Update the configuration of a deployment.
• scale_deployment: Adjust the number of replicas of a deployment.

Cluster Monitoring

• list_nodes: Get information about all nodes.
• get_node_status: Get the status of a specified node.
• get_cluster_events: Get all events across the cluster.
• watch_resources: Monitor resource changes in real-time.

💻 Usage Examples

Basic Usage

from mcp_k8s_server.client import MCPClient

client = MCPClient("http://localhost:8000")
pod_info = client.get_resource("k8s://default/pods/my-pod")
namespace_list = client.get_namespaces()

📚 Configuration Guide

Default Configuration

When starting the server, it will read the configuration from the config.yaml file by default. If the file does not exist, you can generate the default configuration using the following command:

mcp-k8s-server init-config

Custom Configuration

You can customize the server's behavior by editing the config.yaml file, such as specifying the Kubernetes configuration file path and choosing the transport protocol (HTTP or SSE).

❓ Troubleshooting

If you encounter issues during use, check the following common problems:

1. Unable to connect to the Kubernetes cluster: Ensure that the Kubernetes configuration file is valid and the cluster is running.
2. Resource retrieval failure: Check the network connection and permission configuration.
3. Performance issues: Optimize query parameters to reduce unnecessary data loading.

📄 License

The MCP-K8S server is licensed under the MIT License. You can find the full license information in the project repository.

The MCP-K8S server is a powerful Kubernetes resource management tool that helps developers and operators manage and monitor Kubernetes cluster resources more efficiently. With the powerful capabilities of the MCP protocol, you can easily perform real-time operations and monitoring on cluster resources.