Skip to main content
Glama

Outline

outline
Read-onlyIdempotent

Extract a markdown file's heading outline with 1-based line numbers and frontmatter position, skipping fenced code, to navigate and reference document structure.

Instructions

Heading outline of a markdown file (ATX and setext headings, frontmatter and fenced code skipped) with 1-based line numbers, plus frontmatter position.

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": {
      "path": "<path>"
    },
    "name": "outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesPath relative to the allowed folder
offsetNoSkip this many headings (for paging; 400 are listed per call)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/non-destructive, so the safety profile is handled. The description adds genuinely useful behavior the annotations cannot convey: which heading syntaxes are recognized, that frontmatter and fenced code are excluded from the outline, that line numbers are 1-based, and that frontmatter position is also returned.

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?

A single front-loaded sentence with no filler; the parenthetical is dense but every clause carries real information. Slightly overstuffed, but nothing is wasted.

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?

With no output schema, the description does carry the burden of describing the result, and it covers line-number basis, frontmatter position, and exclusion rules. Minor gaps remain, such as the shape of the frontmatter position value and whether results are ordered by line.

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%, and the schema itself documents path scope and the offset paging semantics (400 per call). The description adds nothing about either parameter, so the baseline 3 applies.

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?

States a specific resource and operation: extract a heading outline from a markdown file, with 1-based line numbers and frontmatter position. It does not name or contrast with the obvious sibling read_markdown, so an agent must infer the difference from the 'headings only' framing.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the parenthetical about skipping frontmatter and fenced code hints at why one would pick this over reading raw markdown, but there is no explicit 'use when' or mention of an alternative tool.

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