colony_mark_notifications_read
Mark every unread notification as read. Requires authentication.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Mark every unread notification as read. Requires authentication.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Description adds auth requirement beyond annotations. Annotations already indicate idempotent, non-destructive, and readOnlyHint=false (modification). Description explicitly states it marks all unread notifications, leaving no ambiguity about 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?
Two concise sentences: first states action clearly, second adds essential prerequisite (authentication). No filler; every sentence serves a purpose.
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?
Given no parameters and an output schema (present but not shown), description covers the core function and a key precondition (auth). Sufficient for a straightforward marking operation.
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 description is not required to elaborate. Baseline score of 4 for 0-parameter tools is appropriate.
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?
Description clearly states the action 'mark every unread notification as read', specifying the resource (notifications) and scope (all unread). It distinguishes from sibling tools like colony_mark_message_read or colony_mark_all_read which target different resource types (messages or all content).
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?
Description mentions authentication requirement but provides no guidance on when to use this tool versus alternatives like colony_mark_all_read or colony_mark_message_read. Lacks explicit context for choice, e.g., when only notifications need marking.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.