read_documentation
Convert OpenTelemetry documentation pages to markdown format. Fetch content in chunks for long documents, preserving headings, code blocks, lists, and tables.
Instructions
Fetch and convert a OpenTelemetry documentation page to markdown format.
Usage
This tool retrieves the content of a OpenTelemetry documentation page and converts it to markdown format. For long documents, you can make multiple calls with different start_index values to retrieve the entire content in chunks.
URL Requirements
- Must be from the opentelemetry.io domain
- Must be a documentation page
Example URLs
- https://opentelemetry.io/docs/concepts/observability-primer/
- https://opentelemetry.io/docs/instrumentation/
- https://opentelemetry.io/docs/collector/
Output Format
The output is formatted as markdown text with:
- Preserved headings and structure
- Code blocks for examples
- Lists and tables converted to markdown format
Handling Long Documents
If the response indicates the document was truncated, you have several options:
- Continue Reading: Make another call with start_index set to the end of the previous response
- Stop Early: For very long documents (>30,000 characters), if you've already found the specific information needed, you can stop reading
Args: ctx: MCP context for logging and error handling url: URL of the OpenTelemetry documentation page to read max_length: Maximum number of characters to return start_index: On return output starting at this character index
Returns: Markdown content of the OpenTelemetry documentation
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_length | No | Maximum number of characters to return. | |
| start_index | No | On return output starting at this character index, useful if a previous fetch was truncated and more content is required. | |
| url | Yes | URL of the OpenTelemetry documentation page to read |