trmnl_hide_author_plugin_error

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

Annotations already declare this is a non-destructive, non-read-only mutation; the description adds substantive effect detail — the row stops appearing on the dashboard and in related emails — plus a scoping caution. It does not say whether repeating the call is harmless, which matters since idempotentHint is false.

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?

Effect and inverse are front-loaded in the first two sentences; the trailing endpoint path and the generic "Changes remote state or starts work" boilerplate add little but are brief.

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 single-purpose mutation with no output schema, the description covers what changes, what the caller must supply, and how to undo it. The uncharted pieces are the response shape and profile scoping, both minor.

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 coverage is only 50%, but the description compensates by stating that kind, subject_id, owner and message are taken from a listAuthorPluginErrors row, which tells the agent where to source the values. The nested body wrapper and the profile parameter are not explained.

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 and resource ("Hide an error row from your analytics") and names the inverse operation unhideAuthorPluginError, so the agent can place it precisely among siblings.

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?

Explains the context of use (error rows surfaced by listAuthorPluginErrors) and explicitly names the alternative that reverses it. No explicit when-not guidance, but the trigger condition is clear.

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