encode-toolkit

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

The description adds valuable behavioral context beyond annotations: it explains the two-step process (search then download), the default dry-run mode for previewing, and the safety limit parameter. While annotations cover idempotency and non-destructiveness, the description provides practical usage details that enhance transparency.

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 clear sections (purpose, usage guidelines, examples, args, returns) and front-loaded key information. While comprehensive, it remains efficient with no wasted sentences; each section serves a distinct purpose in guiding the agent.

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 complexity (15 parameters, batch operations) and the presence of an output schema (returns JSON), the description is complete. It covers purpose, usage, examples, parameter semantics, and behavioral details, providing all necessary context for the agent to use the tool effectively without redundancy.

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?

With 0% schema description coverage, the description compensates well by listing all 15 parameters with brief explanations in the 'Args' section. It adds meaning beyond the schema by explaining defaults (e.g., organism default, verify_md5 default True) and providing context for parameters like dry_run and limit. However, some parameters lack detailed semantic context.

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 as 'Search for files and download them all in batch,' specifying both the search and download actions. It distinguishes from siblings by mentioning encode_download_files for specific file accessions and encode_search_files as a related tool, showing clear differentiation.

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 includes an explicit 'WHEN TO USE' section that provides clear guidance: use for searching and downloading in one step, always use dry_run=True first to preview, and use encode_download_files for specific file accessions. It also lists related tools, offering clear alternatives.

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