OpenTelemetry Documentation

OpenTelemetry Documentation MCP Server

python

3

GitHub Stars

python

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "ryu1maniwa-opentelemetry-documentation-mcp-server": {
      "command": "uvx",
      "args": [
        "git+https://github.com/ryu1maniwa/opentelemetry-documentation-mcp-server"
      ],
      "env": {
        "GOOGLE_API_KEY": "YOUR_GOOGLE_API_KEY",
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}

You can run an MCP server that gives you access to OpenTelemetry documentation and enables fast search through Google Custom Search. It provides two practical ways to interact: fetching documentation pages as markdown and searching the documentation corpus directly from your MCP client.

How to use

Use your MCP client to connect to the OpenTelemetry Documentation MCP Server. You can look up specific topics like tracing concepts or metrics, or search across the entire OpenTelemetry documentation collection. The server handles converting pages to markdown for easy reading and returns search results powered by Google Custom Search.

How to install

Prerequisites you need before starting:

Docker installed on your system
Internet access to pull dependencies and access OpenTelemetry documentation
A Google API key for Custom Search (required for search functionality)

Install and run the MCP server using the following configurations. Replace YOUR_GOOGLE_API_KEY with your actual Google API key you obtained from the Google Cloud Console.

{
  "mcpServers": {
    "opentelemetry_documentation_mcp": {
      "command": "uvx",
      "args": ["git+https://github.com/ryu1maniwa/opentelemetry-documentation-mcp-server"],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR",
        "GOOGLE_API_KEY": "YOUR_GOOGLE_API_KEY"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

If you prefer running the MCP server as a Docker container, build and run the container with the following settings. This also passes the Google API key as an environment variable.

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

Additional notes

This MCP server uses Google Custom Search to enable searching the OpenTelemetry documentation. You will need a valid Google API key to enable search functionality.

The Custom Search Engine ID used for searches is the one used by opentelemetry.io, and you should be aware of API usage limits: free tier allows 100 queries per day, after that it costs $5 per 1000 queries, with a maximum of 10 results per query.

Tools

read_documentation fetches a documentation page and converts it to markdown.

search_documentation searches the documentation using Google Custom Search.

Available tools

read_documentation

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

search_documentation

Searches OpenTelemetry documentation using Google Custom Search.