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

Beyond the readOnlyHint/destructiveHint annotations, the description discloses significant behavioral details: truncation at 200K chars with a flag, the embedding model and windowing strategy, and the return of offsets/scores. This exceeds what annotations provide and fully informs the agent of the tool's limits and output characteristics.

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?

The description is dense but well-organized: purpose, usage scenario, complementary tool, implementation details, and limits. Every sentence carries useful information with no filler, and it front-loads the core 'semantic search inside a fetched record' concept immediately.

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?

Given no output schema, the description fully compensates by explaining the return format (passages with character offsets and similarity scores), the 200K char cap and truncation flag, and how it fits into a larger workflow. This is complete for a complex search 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 coverage is 100%, so baseline is 3. However, the description adds practical semantics by explaining what kind of text to pass (e.g., SEC 10-K body, article, long tool result), clarifies the 'query' is natural-language, and describes the result format (top-N passages with offsets/scores). This enhances the schema's basic descriptions without duplicating them.

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+resource: 'Semantic search INSIDE a fetched record.' It clearly differentiates from siblings by emphasizing it operates on already-fetched text and explicitly mentions pairing with ask_pipeworx_grounded, making its unique niche obvious.

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?

Explicit usage guidance is provided: 'Use when the record is too big to cram into the prompt' and 'saves context, returns only the passages that matter.' It also names an alternative/companion tool (ask_pipeworx_grounded) and explains how they combine, giving clear when-to-use and when-not-to-use context.

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