Skip to main content
Glama

repo_explain

Read-onlyIdempotent

Explains a file’s symbols, dependencies, dependents, and change history to help coding agents understand how that file fits into a codebase.

Instructions

Explain a file's symbols, dependencies, dependents, and history.

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": "repo_explain"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.6

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety and repeatability are covered. The description adds the useful behavioral fact that the tool aggregates four distinct data categories in one call, but says nothing about depth, cost on large files, or truncation behavior.

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?

One sentence, front-loaded with the verb, and zero filler. It is efficient, though its brevity borders on under-specification for a tool that returns four classes of data.

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?

No output schema exists, so the description is the only source of information about what comes back; listing the four facets partially discharges that duty. It remains thin for a tool whose output spans symbols, an inbound/outbound dependency graph, and commit history, and the sole parameter is undocumented in the schema.

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 0% for the single 'path' parameter, so the description must carry it. 'A file's ...' does establish that the path points at a file rather than a directory or symbol, which is real added meaning, but it never states whether the path is repo-relative or absolute.

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 verb ('Explain') and enumerates the resource facets it covers: symbols, dependencies, dependents, and history. That is much more informative than the name alone, but it offers no differentiation from overlapping siblings such as repo_dependencies, repo_history, or repo_graph, leaving the agent to guess which one to pick.

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 guidance, no statement of prerequisites, and no mention of alternatives. With siblings like repo_dependencies and repo_history covering two of the four facets named here, an explicit 'use this for a combined per-file overview instead of those' would be the single highest-value addition.

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