Update a notification

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

Annotations already declare destructiveHint=false, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds useful context that the mutation is specifically setting read status, but says nothing about permissions, whether readAt=null clears the read state, or side effects.

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?

Front-loaded and brief: the effect is stated in one sentence. Minor waste in repeating the title 'Update a notification' verbatim before the substantive sentence, and in the trailing operation/tag metadata line.

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 low-complexity, two-parameter tool with full schema coverage, annotations, and no nested objects, the description covers purpose and effect adequately. No output schema exists, so explaining return values is unnecessary, leaving little genuinely missing.

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%, so both id and readAt are documented structurally. The phrase 'set its read status' loosely corresponds to readAt but adds no format or semantic detail (e.g., null clears read state) beyond the schema, so the baseline 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?

States a specific verb (update) and resource (a specific notification) and clarifies the effect is to set read status. This implicitly distinguishes it from the plural bulk sibling immich_update_notifications and from get/delete notification tools, though it never names them.

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?

Usage is implied by the singular 'a specific notification' (per-id), which contrasts with the bulk immich_update_notifications, but there is no explicit when-to-use guidance, no exclusion of alternatives, and no mention of prerequisites or auth.

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