scan_literature

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

Discloses that it walks subdirectories, uses parent folder names as tags, and deduplicates by title. No annotations provided, so description carries full burden. Lacks details on file handling or side effects, which would elevate the score.

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?

Three concise sentences front-loading the main action, with additional details in subsequent sentences. No wasted words.

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?

Covers purpose, method, and safety. Has output schema, so return values are not needed in description. Minor gap: does not mention what the tool returns or any post-condition, but overall adequate for a simple 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?

No parameters exist, so baseline is 4. Description does not need to add parameter info, but adds context about scanning behavior beyond 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?

Describes scanning a specific folder for PDFs and registering them in literature_metadata, with details on subdirectory walking and domain tagging. Clearly distinguishes from sibling tools like scan_inbox or scan_news.

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?

Implicitly indicates use when new PDFs are placed in the literature folder and notes safety of repeated runs via deduplication. Does not explicitly exclude alternative scan tools but context is clear.

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