syncPayslips

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

With no annotations, the description carries full burden. It discloses that authentication uses previously ingested credentials, that it syncs both structured data and PDFs, and includes behavioral notes in parameter descriptions (e.g., skipPdf leaves existing PDFs untouched). This goes beyond merely repeating the tool name, though it lacks details on error handling or idempotency.

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 a single well-structured sentence that front-loads the primary action and includes essential context (login, data types). Every word adds value, with no fluff or redundancy.

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?

The tool has 3 parameters, no output schema, and no annotations. The description covers prerequisites and actions but does not mention return values or success/failure behavior. Since there is no output schema, the description should hint at what the agent receives after invocation, which it does not.

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 description coverage is 100% and each parameter has a detailed description explaining semantics (e.g., tenant optional via env, skipPdf behavior, monthsBack as a sanity ceiling). The tool description itself does not add parameter meaning beyond the schema, so the baseline of 3 applies.

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 a specific action: 'Log into a Hilan tenant... and sync recent payslips', with a clear verb+resource. It distinguishes itself from siblings by specifying syncing recent data (vs resyncPayslipMonth for a specific month or downloadCombinedPayslipsPdf for combined PDF).

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 implies usage when recent payslip data is needed but does not explicitly mention when not to use it or name alternatives like downloadCombinedPayslipsPdf or resyncPayslipMonth. No exclusions or comparison to sibling tools is provided.

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