alefba_download_excel

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

With no annotations, the description discloses key behaviors: it calls POST /api/download_excel/, returns download info or saved path when save_path is provided, and requires prior processing for Excel output. It does not cover error handling or permissions, but the provided details are adequate.

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 fairly concise but includes a duplicate Persian translation which adds unnecessary length for an English-speaking agent. The structure is logical: purpose, precondition, return info, instance guidance. Removing the Persian line would improve conciseness.

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 moderate complexity (3 parameters, has output schema), the description covers the essential aspects: what it does, when to use it, return behavior, and parameter semantics. It lacks examples or error scenarios but is reasonably complete for a download operation.

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 0%, so the description must clarify parameters. It effectively describes the document_url as the document to download, save_path as an optional local path, and instance as the Alefba instance target. This adds meaning beyond the basic types and titles 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 clearly states the tool's purpose: downloading an analyzed document as an Excel (.xlsx) file. It specifies the API endpoint and distinguishes itself from sibling tools like alefba_download_pdf, alefba_download_word, etc., by focusing on Excel output.

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 context by stating the precondition: 'The document must have been processed with type=excel.' It also explains the optional instance parameter. However, it does not explicitly mention when not to use it or directly reference sibling tools as alternatives, but the context is sufficient.

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