Skip to main content
Glama

Explain one function or class from the codebase graph

graph_show
Read-only

Retrieve a function, method or class from a local codebase graph to see its summary, signature, callers, dependencies, covering tests, expected input/output pairs and change verdict. Returns JSON, read-only.

Instructions

One function, method or class from the codebase graph: its plain-English summary, signature, who uses it, what it uses, the tests that reach it within 3 calls, literal input/output pairs its tests expect, and its change verdict when the working tree changed it. Also: description (now, and before when the code changed since the previous one was written), change_note (the saved change explanation, with impact: how the change reaches each caller) and impact_preview (code proven to call it within 3 steps, production first, then tests). Returns JSON. Read-only and local.

Works without SKYLOS_API_KEY and has no daily limit: it reads the repository on this machine and sends nothing to Skylos Cloud.

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

Input Schema

NameRequiredDescriptionDefault
nameYesGraph id, dotted name, short name, or path::Name
pathNoProject directory. A relative path resolves against the MCP server's working directory..
with_codeNoInclude the source code

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv5.6.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover the safe-read profile (readOnlyHint, destructiveHint=false, openWorldHint=false), so the bar is lower, and the description still adds real context beyond them: no SKYLOS_API_KEY needed, no daily limit, local repository access only, nothing sent to Skylos Cloud, and a JSON return. What it lacks is any note on failure modes when a name is ambiguous or unresolved.

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?

No, wait.

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?

With an output schema present there was no need to enumerate every returned field, yet the description spends most of its length doing exactly that while omitting the one thing only prose can supply: when to choose this over graph_impact or graph_describe. It is complete on access and safety, thin on selection guidance for a three-parameter, read-only tool.

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%, including the accepted identifier forms (graph id, dotted name, short name, path::Name) and the path resolution rule, so the schema does the heavy lifting. The description adds nothing further about the three parameters; the "within 3 calls / 3 steps" phrasing describes depth semantics of the result, not input meaning.

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 verb is implied by the title ("Explain one function or class") and the description spells out exactly what profile of a single graph node is returned: summary, signature, callers, callees, reaching tests, input/output pairs, and change verdict. It is clearly distinguished from a search/list tool, but it never names a sibling, so overlap with graph_impact or graph_describe is left for the agent to infer.

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 only implied: fetch this when you need everything about one symbol. There is no explicit when-to-use, no when-not-to-use, and no routing to alternatives even though graph_impact and graph_describe sit in the same catalog and share surface area (impact_preview vs graph_impact).

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