Skip to main content
Glama

explain

Read-onlyIdempotent

Extract a function or class body with called dependencies by symbol name, or get a structural file overview by path, so agents avoid reading entire files.

Instructions

Extract a specific function/class body with its dependencies, without reading the entire file. Provide symbol name to get its code + called functions. Provide file path for a structural overview.

Input Schema

NameRequiredDescriptionDefault
fileNoFile to explain (overview mode if no symbol given).
rootNoAbsolute project root. Required with linked worktrees; subagents must pass their own worktree root on every call.
depthNoHow many levels of called functions to include. Default: 1. Use 0 for just the symbol.
formatNosource: body and location only, no callers/tests/dependencies. Default full.
symbolNoFunction, class, or variable name to explain.
symbolsNoBatch independent symbols in one call, instead of repeated reads. Use instead of symbol/file.
max_tokensNoBatch response byte/4 budget; default 4000. Whole omitted bodies are reported.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.4.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare this as read-only, idempotent, non-destructive, and closed-world. The description adds useful behavioral context: symbol extraction returns code plus called functions, file mode returns a structural overview, and neither requires reading the entire file. It does not cover batch behavior or token-budget truncation, but the schema covers those details.

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 description is three tight sentences with the core purpose front-loaded and no wasted phrasing. It has minor redundancy with the schema's file and symbol descriptions, but overall it is efficiently structured.

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

Completeness3/5

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

For a seven-parameter tool with batch mode, depth, format, and worktree-root requirements, the description covers only the two primary modes. The schema and annotations carry much of the burden, but an agent still lacks description-level guidance on batching and sibling alternatives.

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 file, root, depth, format, symbol, symbols, and max_tokens. The description adds mode meaning for symbol versus file, but does not explain depth, format, root requirements, batch symbols, or max_tokens beyond what the schema provides.

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 states a specific verb and resource: extract a function/class body plus dependencies without reading the whole file. It clearly distinguishes the symbol mode from the file-overview mode. It does not differentiate from siblings such as skeleton or exact_references, so it stops short of a 5.

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?

It explains how to trigger the two main modes: provide a symbol for code plus called functions, or provide a file path for a structural overview. It implies this is preferable to reading an entire file, but it does not give explicit when-to-use/when-not guidance against sibling tools or mention the batch symbols mode.

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