Skip to main content
Glama

outline_file

Returns the indexed declaration outline for a supported source file so you can select focused source ranges before reading individual symbols.

Instructions

Returns the indexed declaration outline for one supported source file. Use this before read_symbol to choose focused source ranges.

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

Input Schema

NameRequiredDescriptionDefault
pathYesRepository-relative path to the source file.
repository_rootYesAbsolute path to the Git repository root to explore.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full load. 'Returns' and 'indexed' imply a read-only, possibly index-derived result, and 'supported source file' hints that unsupported files fail, but neither staleness of the index nor error behavior is stated. Basic behavior is inferable; operational caveats are not.

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, front-loaded with the return value and followed by the action guidance, with no filler or redundancy. Every clause carries information.

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?

For a simple two-parameter read tool with fully documented schema and no annotations, the definition covers purpose and sequencing well. Since there is no output schema, a brief note on what the outline actually contains (declaration kinds, ranges) or on index staleness would close the remaining gap.

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 both parameters are already documented in the schema and the baseline applies. The phrase 'one supported source file' loosely reinforces the single-path semantics, but nothing is added about repository_root or acceptable path forms beyond what the schema states.

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 pairs a specific verb ('Returns') with a specific resource ('indexed declaration outline') and scope ('one supported source file'), which is far more than a restatement of the name. It also positions itself relative to read_symbol. It stops short of differentiating from find_symbol or hybrid_retrieve, which also surface declarations.

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?

'Use this before read_symbol to choose focused source ranges' gives an explicit ordering rule and the downstream purpose, which is exactly the kind of routing an agent needs. There are no exclusion cases (e.g. when to skip the outline and go straight to reading or searching), so it falls short of a 5.

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