Kubernetes MCP Server

🚀 Kubernetes Model Context Protocol (MCP)

This project provides a Model Context Protocol (MCP) for Kubernetes, enabling users to manage and interact with Kubernetes resources more effectively.

🚀 Quick Start

📦 Installation

To use the MCP feature in Kubernetes, you need to install and run an MCP agent first. Here are the example commands to set up the MCP agent:

# Download the MCP agent
wget https://github.com/ModelMesh/mesh-mcp/raw/main/deploy/mcp-agent.yaml
# Deploy the MCP agent to the Kubernetes cluster
kubectl apply -f mcp-agent.yaml

💻 Usage Examples

Basic Usage

MCP provides a command-line tool mcpctl for interacting with the Kubernetes cluster. Here are some commonly used commands:

# Get the version information of the MCP agent
mcpctl version

# Check the status of the MCP agent
mcpctl status

# Get the help documentation of the MCP agent
mcpctl help

Advanced Usage

mcpctl offers various functions to interact with Kubernetes resources, including:

• context create_or_update: Create or update Kubernetes resources
• context delete: Delete Kubernetes resources
• context get: Get information about Kubernetes resources
• context list: List Kubernetes resources

Example: Create a Deployment

# Create a Deployment using a YAML file
mcpctl context create_or_update \
  --api-version apps/v1 \
  --kind Deployment \
  --name my-deployment \
  --namespace default \
  --resource ./my-deployment.yaml

Example: Delete a Service

# Delete a Service named my-service
mcpctl context delete \
  --api-version v1 \
  --kind Service \
  --name my-service \
  --namespace default

🔧 Development

If you want to develop your own MCP agent, you can use the following commands:

# Compile the project
make build

# Run the MCP agent and use it with the mcp-inspector tool
npx @modelcontextprotocol/inspector@latest $(pwd)/kubernetes-mcp-server

This documentation introduces how to install, configure, and use the Kubernetes Model Context Protocol (MCP) agent, as well as how to interact with MCP resources.