patchwork-os

explainSymbol

Read-only

Retrieve comprehensive symbol information including type signature, documentation, definition location, call hierarchy, and reference count in a single call.

Instructions

Get comprehensive symbol info in one call: type signature, docs, definition location, call hierarchy, and reference count.

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": {
      "filePath": "<filePath>",
      "line": "<line>",
      "column": "<column>"
    },
    "name": "explainSymbol"
  }
}

Input Schema

Name	Required	Description
`line`	Yes	Line number (1-based)
`column`	Yes	Column number (1-based)
`filePath`	Yes	Workspace or absolute file path
`useMemoryGraph`	No	Query codebase-memory graph for architectural context: module ownership, ADRs, graph callers (default: false). Requires codebase-memory MCP connected + repo indexed.
`includeSiblings`	No	Also fetch sibling symbols in the same file — other functions, classes, and variables defined alongside the target (default: false)
`includeCodeActions`	No	Also fetch available code actions at this position (default: false)
`includeTypeHierarchy`	No	Also fetch supertypes/subtypes hierarchy (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0May 20, 2026

TDQS

A4.6/5.0

Behavior5/5

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

The description fully discloses what the tool returns and the optional boolean parameters that enhance output, including a prerequisite for useMemoryGraph. This goes beyond the readOnlyHint annotation.

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?

A single, well-structured sentence that efficiently conveys the tool's purpose and capabilities without extraneous words.

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?

The description covers key return values and optional flags, but without an output schema, it could be more explicit about the response format or structure.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the description adds context by listing the returned data types and noting the memory graph prerequisite, adding value beyond parameter descriptions.

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?

The description clearly states the tool aggregates multiple symbol details (type signature, docs, definition location, call hierarchy, reference count) into one call, distinguishing it from sibling tools that return only one aspect.

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?

The description implies use when comprehensive symbol info is needed, but it does not explicitly state when not to use it or provide alternatives for partial info.

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

Deploy Server