Uses Google Custom Search API to enable search functionality across OpenTelemetry documentation with configurable result limits.
Provides tools to access and search OpenTelemetry documentation, allowing users to fetch documentation pages in markdown format and search for specific content about tracing, metrics, instrumentation, and SDK configuration.
OpenTelemetry Documentation MCP Server
Model Context Protocol (MCP) server for OpenTelemetry Documentation
This MCP server provides tools to access OpenTelemetry 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 OpenTelemetry documentation pages to markdown format
- Search Documentation: Search OpenTelemetry documentation using Google Custom Search
Prerequisites
Required Components
- Docker installed on your system
- Internet access to pull dependencies and access OpenTelemetry documentation
Google API Key Setup
To use the search functionality, you must obtain a Google API key:
- Visit the Google Cloud Console (https://console.cloud.google.com/apis/credentials)
- Create a new API key for the Custom Search API
- 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
Configure the MCP server in your MCP client configuration (e.g., for Amazon Q Developer CLI, edit ~/.aws/amazonq/mcp.json
):
or docker after a successful docker build -t opentelemetry-documentation-mcp-server .
:
Basic Usage
Example:
- "look up documentation on OpenTelemetry tracing concepts. cite your sources"
- "search OpenTelemetry documentation for information about metrics and instrumentation"
- "find documentation about OpenTelemetry SDK configuration"
Tools
read_documentation
Fetches a OpenTelemetry documentation page and converts it to markdown format.
search_documentation
Searches OpenTelemetry documentation using Google Custom Search.
Google Custom Search Integration
This server uses Google Custom Search to provide search functionality for OpenTelemetry documentation. The Custom Search Engine ID (cx
) used is the one used by opentelemetry.io itself:
- Custom Search Engine ID:
015faf7de29c34606
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
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Enables access to OpenTelemetry documentation by fetching and converting pages to markdown format and searching content using Google Custom Search. Provides comprehensive documentation lookup and search capabilities for OpenTelemetry concepts, instrumentation, and configuration.
Related MCP Servers
- -securityFlicense-qualityProvides curated documentation access via the Gemini API, enabling users to query and interact with technical docs effectively by overcoming context and search limitations.Last updated -13TypeScript
- -securityAlicense-qualityProvides tools for retrieving and processing documentation through vector search, enabling AI assistants to augment their responses with relevant documentation context.Last updated -13TypeScriptMIT License
- -securityAlicense-quality* Index Management Tools: * List all indices in OpenSearch cluster * Get index mapping * Get index settings * Cluster Management Tools: * Get cluster health status * Get cluster statistics * Document Tools: * Search documentsLast updated -1PythonMIT License
- -securityFlicense-qualityEnables AI assistants to search documentation of packages and services to find implementation details, examples, and specifications.Last updated -Python