post_test_case_comment

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

Annotations declare destructiveHint=true, openWorldHint=true, and non-idempotent, meaning this creates a persistent, non-reversible side effect. The description does not mention permissions, rate limits, validation constraints, or that this mutates server state, adding nothing beyond the annotations.

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?

Two sentences, but the second repeats the first almost verbatim instead of adding information. No front-loaded detail about behavior or constraints. Not harmful, but half the content is wasted.

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?

A mutating, destructive, open-world tool with nested parameters, zero schema coverage and no output schema. The minimal description leaves the agent without guidance on required permissions, comment format constraints, or response handling.

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 compensate, but it only says 'using its unique identifier' which loosely maps to testCaseId. The 'message' field (max 10000 chars) receives no elaboration, and the nested body/path structure is 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?

Clear verb+resource ('Post a comment on a test case') that names the specific target entity. Its siblings include post_issue_comment and post_test_result_comment, so the target resource distinguishes it. The second sentence restates essentially the same purpose rather than differentiating further.

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?

No guidance about when to use this vs. siblings like post_issue_comment or post_test_result_comment, no prerequisites (auth, permissions), no exclusions. The agent must infer usage entirely from the tool name.

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