Skip to main content
Glama

ApolloDocsRead

Read-onlyIdempotent

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

Input 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

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?

The annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior. The description adds useful behavioral context that reading happens in chunks by slug, which is not conveyed by the annotations alone. It does not describe iteration across chunks, but the schema and output schema cover that.

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?

The description is two sentences with zero waste. It is front-loaded with the core action and follows immediately with the key dependency on ApolloDocsSearch.

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 tool with full schema coverage, rich annotations, and an output schema, the description is complete enough. It tells the agent what the tool does, where the slug comes from, and that content is chunked, while return behavior is handled by the output schema.

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 coverage is 100%, and both parameters are fully documented in the input schema, including the chunkIndex character offset and 10000-character read size. The description adds only broad framing ('by slug', 'in chunks') beyond what the schema already provides, so the baseline of 3 is appropriate.

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?

The description states a specific verb and resource: 'Reads an Apollo documentation page by slug in chunks.' It also distinguishes itself from ApolloDocsSearch by telling the agent to use slugs returned by that sibling tool, so its role is immediately clear.

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?

It gives clear usage context by requiring slugs returned from ApolloDocsSearch, which routes the agent correctly. However, it does not explicitly state exclusions or when not to use this tool, so it falls just short of the top score.

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