profile_writeback_suggestions

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds value beyond that by disclosing the output structure (field, value, repo, evidence, source, confidence, private) and the auto-mode confidence threshold, which tells the agent what the results mean.

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-loads the purpose before the Args/Returns blocks, and every sentence carries information. The Args/Returns formatting slightly duplicates what a schema would normally hold, but given 0% schema coverage it earns its place.

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?

With no output schema, the Returns section is essential and present. Parameter behavior and thresholds are documented. Only the default mode value and any permission/pagination considerations are missing, which is minor for a two-parameter read tool.

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 0%, so the description must carry parameter meaning — and it does: author is a GitHub username, and mode's two values are defined with the 0.8 confidence cutoff. This compensates well for the empty schema, though it doesn't state the default value ('suggest') that the schema declares.

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 ('Get profile writeback suggestions') and names the basis ('PR status analysis'), with an example of the fields suggested. It does not explicitly differentiate itself from siblings like analyze_pr or get_repo_profile, so it stops short of a 5.

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 mode parameter is explained with a concrete selection rule ('suggest' = all, 'auto' = confidence >= 0.8), which implies usage. However, there is no guidance on when to call this tool versus analyze_pr, get_repo_profile, or other profile/PR siblings.

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