kubernetes-documentation-mcp-server

# 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](https://github.com/awslabs/mcp/tree/main/src/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: ```json { "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. ```python read_documentation(url: str) -> str ``` ### search_documentation Searches Kubernetes documentation using Google Custom Search. ```python 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