What is Kubernetes Documentation Mcp Server

The kubernetes-documentation-mcp-server is a Model Context Protocol (MCP) server designed to provide access to Kubernetes documentation and enable content searching through Google Custom Search.

Use cases

Use cases include developers looking to quickly reference Kubernetes documentation, teams conducting training sessions on Kubernetes, and organizations needing to integrate Kubernetes documentation into their internal tools.

How to use

To use the kubernetes-documentation-mcp-server, you need to install Docker, obtain a Google API key for Custom Search, build the Docker image, and configure the MCP server with the necessary settings. After setup, you can look up documentation and search for specific topics in Kubernetes documentation.

Key features

Key features include the ability to read Kubernetes documentation by converting pages to markdown format and searching documentation using Google Custom Search.

Where to use

The kubernetes-documentation-mcp-server can be used in software development environments, educational institutions, and organizations that require easy access to Kubernetes documentation for development and operational purposes.

Kubernetes Documentation MCP Server

Model Context Protocol (MCP) server for Kubernetes Documentation

This MCP server provides tools to access Kubernetes documentation and search for content using Google Custom Search.

Acknowledgements

This project is based on aws-documentation-mcp-server by Amazon Web Services, licensed under the Apache License 2.0.

Features

• Read Documentation: Fetch and convert Kubernetes documentation pages to markdown format
• Search Documentation: Search Kubernetes documentation using Google Custom Search

Prerequisites

Required Components

• Docker installed on your system
• Internet access to pull dependencies and access Kubernetes documentation

Google API Key Setup

To use the search functionality, you must obtain a Google API key:

1. Visit the Google Cloud Console (https://console.cloud.google.com/apis/credentials)
2. Create a new API key for the Custom Search API
3. Add this API key to your MCP configuration as shown in the installation section

Without a valid Google API key, the search_documentation tool will not function properly.

Installation

To install and use the Kubernetes Documentation MCP Server with Docker:

1. Build the Docker image:

docker build -t kubernetes-documentation-mcp-server .

2. Configure your MCP with the following settings:

{
  "mcpServers": {
    "kubernetes-documentation-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "--interactive",
        "--env",
        "FASTMCP_LOG_LEVEL=ERROR",
        "--env",
        "GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY",
        "kubernetes-documentation-mcp-server:latest"
      ],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}

Basic Usage

Example:

• “look up documentation on Pod lifecycle in Kubernetes. cite your sources”
• “search Kubernetes documentation for information about StatefulSets”

Tools

read_documentation

Fetches a Kubernetes documentation page and converts it to markdown format.

read_documentation(url: str) -> str

search_documentation

Searches Kubernetes documentation using Google Custom Search.

search_documentation(search_phrase: str, limit: int) -> list[dict]

Google Custom Search Integration

This server uses Google Custom Search to provide search functionality for Kubernetes documentation. The Custom Search Engine ID (cx) used is the one used by kubernetes.io itself:

• Custom Search Engine ID: 013288817511911618469:elfqqbqldzg

API Limits

The Google Custom Search API has the following limits:

• Free tier: 100 queries per day
• $5 per 1000 queries after that
• Maximum of 10 results per query