alefba_list_documents

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

With no annotations, the description carries the burden of transparency. It discloses the HTTP method (GET), the API endpoint, the response structure, and pagination behavior. It does not mention authentication or error conditions, but the read-only nature is implied by 'List'.

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, including both English and Persian. It front-loads the core action and explains pagination and parameters efficiently. Every sentence adds useful information, though the Persian could be separate.

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 output schema exists and annotations are absent, the description covers essential aspects: pagination, default values, optional instance, and response fields. Missing error handling or rate limits, but adequate for a listing 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 0%, so the description adds value by explaining the 'page' parameter (default 1, pagination) and 'instance' parameter (optional instance name, default instance). This compensates for the lack of schema descriptions, though the valid values for 'instance' are not specified.

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 lists documents page by page from an Alefba instance. It specifies the verb 'List' and the resource 'documents', and distinguishes from sibling tools like alefba_detail_document by focusing on pagination and listing.

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 explains pagination using num_pages and defaults, but does not provide explicit guidance on when to use this tool versus alternatives like alefba_detail_document or when to specify different instances. Usage context is implied but not fully explicit.

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