find_code_examples

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

Describes BM25 scoring, return fields, and optional filters. No annotations provided, so description carries behavioral burden. It adequately conveys search behavior without side effects, though lacks depth on performance or data 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?

Concise and well-structured. Front-loaded with main action, then details in a few sentences. No extraneous information; every sentence adds value.

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?

With no output schema, description explicitly lists all return fields. Includes prerequisites and filtering behavior. Complete for an agent to correctly invoke the tool.

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 description coverage is 83%, baseline 3. Description adds meaning: explains score, case-insensitive lang filter, and scope filters contract. Enhances understanding beyond schema definitions.

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?

Description clearly states it searches fenced code blocks using BM25 over block content and lists specific return fields. It distinguishes from sibling tools like search_sections by specifying code blocks and BM25.

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 precondition 'Use after index_local; requires INDEX_VERSION>=3.' and mentions optional scope filters with same contract as search_sections. Lacks explicit when-not-to-use or direct comparison to alternatives, but context is clear.

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