github_mark_notifications_read

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

No annotations are provided, so the description carries the full burden. It implies mutation (marking as read) and explains parameter semantics, but it does not disclose side effects, irreversibility, or required permissions. The 'empty = all' detail adds some behavioral insight, but the overall transparency is only moderately sufficient.

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 compact and front-loaded: one declarative sentence for purpose followed by a structured args list. There is no superfluous wording, and every sentence contributes to understanding the tool's function and parameters.

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 the tool's simplicity, the description covers the core action and all parameters adequately. An output schema exists, so the absence of return value explanation is acceptable. It could mention that only unread notifications are affected or that the action is irreversible, but the current content is sufficient for a basic mark-as-read 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?

The input schema provides only titles and defaults with 0% description coverage, so the description must compensate. It effectively explains last_read_at as an ISO 8601 timestamp with the 'empty = all' behavior and clarifies session_name as the GitHub session. This adds meaningful value beyond the schema.

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 opens with a clear declarative sentence 'Mark all notifications as read,' which states the specific verb (mark) and resource (notifications) with an explicit scope (all). It is immediately distinguishable from sibling github_list_notifications, which lists rather than modifies.

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 offers clear context by explaining the last_read_at parameter, showing how to mark a subset versus all, and what session_name refers to. It does not explicitly name alternatives or state when not to use the tool, but the straightforward nature of the operation and the obvious contrast with list_notifications make the usage reasonably clear.

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