profilarr_sync_database

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

With no annotations, the description shoulders the transparency burden. It discloses that the operation is asynchronous, returns HTTP 202 with a jobId, and that it pulls the linked database repository rather than an Arr instance. It does not mention potential side effects on existing data, but the core async behavior is clearly described.

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?

Two sentences, no fluff. The action is stated first, followed by async behavior and a clarifying note. Every word earns its place and the structure is easy to scan.

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 description covers purpose, async behavior, return format, and a common confusion (Arr sync). However, it misses the parameter meaning entirely, which is critical for correct invocation. Overall, it is adequate but has a notable gap for a tool with one parameter.

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 schema has one required integer parameter 'id' with no description (schema coverage 0%). The description does not mention 'id' at all, leaving the agent to guess whether it refers to a database id, job id, or something else. This is a significant omission for a single-parameter tool.

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 uses a specific verb 'Trigger' and clearly identifies the resource ('database pull / PCD sync'). It also distinguishes itself from an Arr instance sync, which is a key differentiator among sibling tools.

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 explicitly states what the tool does NOT do ('NOT an Arr instance sync'), which helps avoid misuse. It also instructs to poll with profilarr_get_job(jobId) for async completion. However, it does not provide broader when-to-use context or prerequisites beyond the linked DB repo.

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