post_comment

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals that the comment is 'simulated', which is important, but it does not explain side effects (e.g., whether the comment is stored, sent to a real repository, or only logged), permissions required, or how the simulation behaves. The term 'record' is ambiguous about the actual action.

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 with no unnecessary words, effectively communicating the core action. It is front-loaded and easy to parse, though it lacks supporting details that would enrich structure.

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 tool with one parameter and no output schema, the description is simple, but critical contextual information is missing. It does not explain what 'simulated' means for the agent (e.g., whether comments are actually visible, whether this is a safe test action), nor does it describe what happens after the comment is recorded. The absence of behavioral context makes it incomplete for a reliable agent selection.

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 schema has one required parameter 'body' with 0% schema description coverage, so the description must compensate. However, it only implies that 'body' is the comment content without clarifying format, length limits, or whether it refers to markdown. The phrase 'public repository comment' gives some context but adds minimal meaning beyond the parameter name itself.

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 uses a clear verb 'Record' with a specific resource 'simulated public repository comment', indicating the tool creates or stores a comment. It distinguishes itself from siblings (get_issue, get_pull_request, run_command, etc.) by focusing on comment posting, though 'record' is slightly less direct than 'post' or 'create'.

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 no guidance on when to use this tool versus alternatives, such as whether it should be used for issues, pull requests, or general discussions. There are no conditions, prerequisites, or references to sibling tools, leaving the agent to infer usage from the tool name and minimal context.

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