Skip to main content
Glama

find_symbol

Read-onlyIdempotent

Search a project tree for an identifier or symbol, using optional file extensions and a match limit to narrow results.

Instructions

DEPRECATED (removed in 0.6.0): use inspect_source(root=..., symbol=...).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
extsNoFile extensions to search.
rootYesAbsolute path to the project folder to scan recursively.
limitNoStop after this many matches.
symbolYesIdentifier to search for.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.5.0
    • addedInput schema / properties / exts / description
      Added value: +"File extensions to search."
    • addedInput schema / properties / limit / description
      Added value: +"Stop after this many matches."
    • addedInput schema / properties / root / description
      Added value: +"Absolute path to the project folder to scan recursively."
    • addedInput schema / properties / symbol / description
      Added value: +"Identifier to search for."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "title": "find_symbolDictOutput",
      +  "type": "object"
      +}
  2. First observedv0.4.1

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds the critical behavioral fact that the tool is deprecated and removed in 0.6.0, which is beyond what annotations provide. It also hints that it is a search function via the replacement's parameters. No further behavioral context is needed for a deprecated 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?

The description is a single, front-loaded sentence that delivers the deprecation notice and the replacement route with no filler. Every character earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool is deprecated and has a clear replacement, the description is complete. An agent knows exactly what to do: avoid this tool and use inspect_source with the same parameters. No output schema explanation is necessary because the tool should not be invoked.

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% with clear descriptions for each parameter (e.g., 'Absolute path to the project folder', 'Identifier to search for'). The description adds no additional syntax or precedence guidance, but the baseline of 3 applies because the schema fully documents the parameters.

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 description clearly states that the tool is deprecated and removed in 0.6.0, and explicitly names the replacement (inspect_source). While it doesn't restate the original purpose of find_symbol itself, for an agent this is the essential information to correctly select and invoke the tool. It also differentiates from inspect_source by design.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit instructions on what to use instead: 'use inspect_source(root=..., symbol=...)'. This is a direct when-not-to-use and proper-alternative directive, leaving no ambiguity about how to handle this tool.

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