read_file_symbol

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

With no annotations provided, the description carries the burden of behavioral disclosure. It does communicate that the operation is a read and that fuzzy matching is supported, but it does not disclose what happens with multiple fuzzy matches, whether the whole symbol body is returned, or any other side effects or limits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the core action and resource. Every word earns its place, and the fuzzy-matching note is a useful second sentence rather than padding.

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

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

The tool has no output schema and no annotations, so the description must explain more than it does. It omits what is returned when a match is found, how ambiguity is resolved, and what happens when the optional file parameter is omitted—significant gaps for an agent trying to invoke the tool correctly.

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

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

Schema coverage is 100%, so the baseline is 3. The description adds value by clarifying that the symbol parameter refers to a function/class name and that fuzzy/partial names are accepted, which goes beyond the schema's generic 'Symbol name' description. It does not address the file/file_path alias semantics, but those are already documented in the schema.

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

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

The description states a specific verb (Read), a specific resource (function/class), and the lookup mechanism (by name), which clearly distinguishes it from siblings like read_file (whole file) and read_file_outline. Fuzzy matching is an extra scoping detail that further clarifies what kind of matches are returned.

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

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

There is no explicit when-to-use statement or named alternatives. The phrase 'by name' and 'Fuzzy matching supported' imply the agent should use this when it already has a symbol name (possibly approximate) rather than when it needs to explore a file, but this is left to inference.

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