ingest_payslips

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

With no annotations provided, the description carries the transparency burden. It discloses deduplication via SHA-256 and the return summary structure. However, it does not mention potential issues like invalid PDF handling or permission requirements, though the core write behavior is clear.

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 two sentences, front-loaded with the main action, and includes essential behavioral details without any filler. Highly concise and well-structured.

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?

For a simple one-parameter tool, the description covers the process, deduplication, and return summary. Since an output schema exists, return values are explained elsewhere. Minor gaps exist around error handling or file format specifics, but overall it is sufficiently complete.

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?

The description adds meaning by stating the parameter is the directory to scan for PDFs, which goes beyond the schema's raw title. However, it does not specify whether the scan is recursive, path constraints, or other details, so compensation is only partial.

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 scans a directory, parses PDF payslips, and stores them in the database. It uses specific verbs and resources and is distinct from sibling tools that are all query operations.

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 purpose clearly implies when to use this tool (for ingesting payslips), but there is no explicit statement about when to use it vs alternatives. Sibling tool names suggest they are for querying, yet no alternatives are referenced directly.

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