Skip to main content
Glama

explain_code

Read-only

Why the code is the way it is: the history behind a path or symbol, oldest first — each edit (who, when, what changed), completed intents with their rationales, reverted attempts and anchored notes. Use it before git blame or git log: it includes uncommitted work and the reasons given. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoFile to explain; with no symbol, the whole file.
symbolNoNarrow the history to one symbol.
repo_idYesThe repository id, e.g. github.com/org/repo (repo_id in .collide/config.json).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / path / description
      Added value: +"File to explain; with no symbol, the whole file."
    • addedInput schema / properties / repo_id / description
      Added value: +"The repository id, e.g. github.com/org/repo (repo_id in .collide/config.json)."
    • addedInput schema / properties / symbol / description
      Added value: +"Narrow the history to one symbol."
  2. Changed9 schema fields changed
    • removedInput schema / properties / path / default
      Removed value: -""
    • removedInput schema / properties / path / description
      Removed value: -"Repo-relative file path, e.g. src/app/api.py."
    • removedInput schema / properties / path / title
      Removed value: -"Path"
    • removedInput schema / properties / repo_id / description
      Removed value: -"Repository id — the git remote (e.g. github.com/acme/api) or a bare folder name; a #branch suffix scopes to that branch."
    • removedInput schema / properties / repo_id / title
      Removed value: -"Repo Id"
    • removedInput schema / properties / symbol / default
      Removed value: -""
    • removedInput schema / properties / symbol / description
      Removed value: -"A symbol in the file — function, class, method, or constant name."
    • removedInput schema / properties / symbol / title
      Removed value: -"Symbol"
    • removedInput schema / title
      Removed value: -"explain_codeArguments"
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description redundantly restates 'Read-only'. Its real added value is disclosing what the result contains — edits with author/time/change, completed intents with rationales, reverted attempts, anchored notes, and uncommitted work — which is beyond what annotations cover.

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?

Front-loaded with the core purpose, then the content inventory, then the routing rule and safety note in a single efficient paragraph. The colon-separated list is dense but every element earns its place; only the redundant 'Read-only' is wasted given the annotations.

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 usefully enumerates the kinds of records returned and the ordering, and it covers both path and symbol scoping. Safety and usage context are present, leaving little an agent would need that is absent.

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 all three parameters are already documented, and the description adds only the 'oldest first' ordering hint. No new syntax or format detail is supplied beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific deliverable — the history behind a path or symbol, oldest first, with who/when/what per edit — which is a concrete verb+resource. It distinguishes itself from git blame and git log by naming them explicitly, so an agent can route without opening the schema.

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?

Gives an explicit use-before rule ('Use it before git blame or git log') and the reason (uncommitted work and stated reasons are included). It does not name any sibling MCP tool as an alternative or state when not to use it, so it stops short of full routing guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources