Skip to main content
Glama

Page outline

toc

Retrieve a page's heading outline with levels, titles, and anchors to jump directly to a section, avoiding full-page reads.

Instructions

Heading outline of a page: level, title, anchor. Pick a section and read path#anchor instead of paging the whole page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPage path (any #anchor is ignored).
docsetYesDocset slug, e.g. 'vite'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden. It accurately conveys that the tool provides a navigation outline rather than full page content, which is the key behavioral trait. It could mention that no page text is returned, but 'heading outline' and the anchor-based reading tip make this sufficiently clear.

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, no fluff. The output contents are front-loaded, and the usage guidance is compact and actionable.

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 two-parameter tool with no output schema, the description is sufficient: it states what the result contains, how to use it, and how to proceed with a sibling tool. Nothing necessary for correct invocation is missing.

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 documents docset and path. The description adds useful workflow context around path#anchor, but it does not need to redefine parameters. Baseline 3 is appropriate.

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 description clearly identifies what the tool returns — a heading outline with level, title, and anchor — and names the page as the resource. It lacks an explicit action verb like 'returns' or 'lists', but the meaning is unambiguous and distinguishes it from read/search siblings.

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

Usage Guidelines5/5

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

It gives explicit guidance: use this tool to pick a section, then read path#anchor instead of reading the whole page. This directly addresses when to use it versus the read sibling and gives a concrete workflow.

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

Deploy Server

Other Tools