Skip to main content
Glama

read_symbol

Retrieves an indexed symbol's source range, body, and surrounding line using a stable symbol ID from outline_file, so you can inspect exact code without searching.

Instructions

Returns one indexed symbol's source range, body, and one line of surrounding context. Obtain the stable symbol ID from outline_file.

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>",
      "symbol_id": "<symbol_id>"
    },
    "name": "read_symbol"
  }
}

Input Schema

NameRequiredDescriptionDefault
symbol_idYesStable indexed symbol ID returned by outline_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.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It does disclose the return shape (source range, body, one line of context), which implies a read-only operation, but it says nothing about error behavior for unknown IDs, repository_root validation, or cost/latency characteristics for a source-reading tool.

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 with zero filler, and the most decision-relevant information (what is returned) is front-loaded ahead of the prerequisite hint. Every sentence earns its place.

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 only two fully documented parameters, no nested objects, and no output schema, the description covers the essentials and usefully spells out the return contents in the absence of an output schema. It falls short only on failure modes and the role of repository_root.

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, and the description's note that the ID comes from outline_file merely repeats the symbol_id schema text. repository_root is not mentioned at all in the description, so no meaning is added beyond the schema.

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 and resource — returns one indexed symbol's source range, body, and one line of surrounding context — which is concrete enough for an agent to know exactly what comes back. It does not explicitly differentiate itself from siblings like find_symbol (name-based lookup) or outline_file, so the distinction is only implied by the mention of outline_file as the ID source.

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?

The second sentence establishes a prerequisite workflow: the symbol ID must come from outline_file, which tells the agent how to get into a valid state. However, there is no explicit guidance on when to prefer this over find_symbol, nor any statement about what happens with an invalid or stale ID.

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