find_doc_references

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

Without annotations, the description adds value by mentioning the prerequisite 'Requires a prior reindex' and the backtick-quoted identifier mechanism. However, it does not disclose error behavior, side effects, or whether it is read-only. Some behavioral context provided but incomplete.

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?

Three sentences, front-loaded with purpose, then use cases, then prerequisite. No wasted words. Each sentence earns its place.

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 description explains what the tool does and its prerequisite but does not describe the output format (e.g., list of files, snippets). Given no output schema, the agent would benefit from knowing return structure.

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 baseline is 3. The description adds that identifiers are backtick-quoted and implies mutual exclusivity between symbol and file. This adds modest value beyond the schema descriptions.

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 clearly states the verb 'find' and the resource 'documentation/markdown files that reference a code symbol or file', and differentiates from siblings by specifying backtick-quoted identifiers and use cases like checking before deletion.

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?

Provides explicit when-to-use scenarios (discover documentation, check before deletion) and a prerequisite (prior reindex). Lacks explicit when-not-to-use but context implies alternatives may exist.

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