Skip to main content
Glama

ApolloDocsRead

Read-onlyIdempotent

Reads an Apollo documentation page by slug in chunks. Use slugs returned by ApolloDocsSearch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe slug returned from the ApolloDocsSearch tool
chunkIndexYesThe character index to start reading from, will return up to the next 10000 characters

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
errorsNo
extensionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / data / properties / documentation / properties / page / anyOf
      Added value: +[
      +  {
      +    "properties": {
      +      "contentSlice": {
      +        "description": "The content of the page, optionally sliced based on input parameters",
      +        "properties": {
      +          "content": {
      +            "description": "The content of the section",
      +            "type": "string"
      +          },
      +          "index": {
      +            "description": "The index of the section",
      +            "type": "integer"
      +          },
      +          "totalCount": {
      +            "description": "Total number of sections available",
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "content",
      +          "index",
      +          "totalCount"
      +        ],
      +        "type": "object"
      +      },
      +      "slug": {
      +        "description": "Unique slug identifier for the page",
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "The full URL of the documentation page",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "url",
      +      "slug",
      +      "contentSlice"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / data / properties / documentation / properties / page / oneOf
      Removed value: -[
      -  {
      -    "properties": {
      -      "contentSlice": {
      -        "description": "The content of the page, optionally sliced based on input parameters",
      -        "properties": {
      -          "content": {
      -            "description": "The content of the section",
      -            "type": "string"
      -          },
      -          "index": {
      -            "description": "The index of the section",
      -            "type": "integer"
      -          },
      -          "totalCount": {
      -            "description": "Total number of sections available",
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "content",
      -          "index",
      -          "totalCount"
      -        ],
      -        "type": "object"
      -      },
      -      "slug": {
      -        "description": "Unique slug identifier for the page",
      -        "type": "string"
      -      },
      -      "url": {
      -        "description": "The full URL of the documentation page",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "url",
      -      "slug",
      -      "contentSlice"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile with readOnlyHint, idempotentHint, and destructiveHint. The description adds useful behavioral context by revealing that pages are read in chunks and that valid slugs come from ApolloDocsSearch, which is beyond what the annotations express.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences carry the essential meaning with no filler. The core behavior is front-loaded, and the critical workflow dependency on ApolloDocsSearch appears in the second sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only tool with two well-documented parameters, an output schema, and supportive annotations, nothing critical is missing. An agent can correctly invoke it by obtaining a slug from ApolloDocsSearch and supplying a valid chunkIndex.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already fully documents both parameters. The description mostly restates the slug dependency already present in the schema, adding little new meaning beyond that baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Reads'), a specific resource ('Apollo documentation page'), and the key mechanism ('by slug in chunks'). This clearly differentiates it from the sibling ApolloDocsSearch, which is about finding slugs rather than reading pages.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives direct workflow guidance: use slugs returned by ApolloDocsSearch. It establishes when this tool is appropriate relative to the search sibling, though it does not explicitly mention exclusions or alternative tools beyond that.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources