post_pr_comment

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the tool can post or update a comment, but fails to explain key behaviors such as how updates work (e.g., upsert logic), required permissions, rate limits, or side effects. The six parameters remain completely undocumented, leaving the agent blind to their role.

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 a single sentence of 12 words, which is concise and front-loads the core action. However, it sacrifices necessary detail for brevity; while efficient, it leaves out parameter descriptions and usage guidance. Still, no wasted words.

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 complexity (6 parameters, no schema descriptions, no annotations, no output schema), the description is far from complete. It only covers the high-level purpose. Critical details about parameters, required inputs, and return behavior are missing, making it inadequate for an agent to use correctly without additional context.

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 has 0% description coverage, meaning no parameter descriptions exist. The description does not compensate: it provides no information about what each of the six parameters ('project', 'prNumber', 'runId', 'environment', 'body', 'confirm') means or how they should be used. The agent cannot infer correct parameter usage from this minimal description.

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 clearly states the tool's purpose: 'Post or update a VisualQ VRT summary comment on a GitHub PR'. It specifies the verb (post/update), resource (VisualQ VRT summary comment), and context (GitHub PR). Among sibling tools, no other tool explicitly posts or updates PR comments, so it distinguishes well.

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 mentions 'requires GitHub integration' as a prerequisite but does not provide explicit guidance on when to use this tool versus alternatives, or when not to use it. Without sibling comparison or usage context, the agent has limited decision support.

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