scan_to_excel

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

No annotations provided, but the description explains it saves to file, mentions local caching, and limits codes to 500. Some gaps remain (e.g., overwrite behavior, error handling), but overall good transparency for a scan tool.

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 well-structured with a title, intro, callout, numbered usage flow, parameter list, and return info. Some redundancy in the flow but front-loaded with key info.

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 the tool's 4 parameters, file output, and return type, the description covers purpose, parameters, usage pattern, and return value. The output schema existence reduces the need for detailed return description.

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?

Despite 0% schema coverage, the description adds detailed explanations for each parameter (codes max 500, days default 260 weeks, include_financial for PER/PBR, filename auto-generated if empty), fully compensating for the schema gap.

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 tool collects basic info, chart statistics, and financial indicators for multiple stocks and saves to Excel. It is distinct from sibling tools that retrieve specific data points.

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?

The description provides a usage flow (scan once with this tool, then repeatedly query with query_excel), explicitly guiding the agent on when to use this tool versus alternatives.

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