Skip to main content
Glama

get_page_outline

Returns a documentation page's section outline with chunk IDs, headings, and token sizes, so agents can locate and read only the sections they need.

Instructions

Section outline of one doc page: chunk ids, headings and token sizes.

Args:
    project: project id.
    page: repo path, URL, or part of it / of the title (e.g. 'autoscaling').
    version: default latest.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>",
      "page": "<page>"
    },
    "name": "get_page_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYes
projectYes
versionNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden, and it does disclose the shape of what is returned (chunk ids, headings, token sizes), which implies a read-only operation. It says nothing about permissions, size limits or truncation on very large pages, or whether chunk ids are usable directly with read_chunks, leaving real behavioral gaps.

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

Conciseness4/5

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

The summary sentence is front-loaded and the argument notes follow in a compact list with no filler. Slightly mechanical docstring formatting ('Args:') but nothing that wastes an agent's attention.

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

Completeness4/5

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

An output schema exists, so return values need not be spelled out, and all three parameters receive at least a phrase of explanation despite zero schema coverage. The remaining gap is operational detail — ordering, cost and behavior on oversized pages — which matters for a survey tool but is not disqualifying.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate, and it does: 'page' is revealed to accept a repo path, a URL, or a fragment of the path or title with a concrete example ('autoscaling'), which is nowhere in the schema. 'project' and 'version' are also briefly clarified, with 'default latest' adding meaning beyond the schema's null default.

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

Purpose4/5

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

The first line names the resource ('one doc page') and enumerates exactly what comes back ('chunk ids, headings and token sizes'), so an agent can tell this is a structural survey rather than a content read like read_chunks. It stops short of explicitly contrasting itself with the siblings, but 'outline' plus the listed payload is specific enough to select on.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance: nothing says to call this before read_chunks, nor whether it is the right tool when you only have a partial title. The Args block documents inputs, not selection criteria, so the agent must infer the workflow entirely.

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