create_comment
Creates a comment on an issue and returns its id. The text is limited to 4096 characters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | The comment's text, max 4096 characters. | |
| issueKey | Yes | The issue's key, e.g. 'BRD-42'. |
Creates a comment on an issue and returns its id. The text is limited to 4096 characters.
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | The comment's text, max 4096 characters. | |
| issueKey | Yes | The issue's key, e.g. 'BRD-42'. |
Changes observed during successful MCP inspections.
Input schema / properties / text / descriptionPrevious value: -"The comment's text."New value: +"The comment's text, max 4096 characters."Input schema / properties / text / maxLengthAdded value: +4096Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden. It does disclose the write nature and the return value (id) and the size limit, but says nothing about authorization requirements, who the comment is attributed to, whether posting triggers notifications, or whether the operation is reversible.
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 short sentences, front-loaded with the action and the result. The trailing sentence largely restates the schema's maxLength, a minor redundancy, but the text is otherwise tight.
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 simple two-parameter create tool with no output schema, the description covers purpose, return value, and the input limit. It omits side effects (attribution, notifications) and any error/authorization behavior, so it is adequate but not thorough.
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 100%, so both parameters (issueKey, text) are already fully documented with format hints ('BRD-42') and the maxLength constraint. The description only repeats the 4096-character limit, adding no semantics beyond the schema. Baseline 3 applies.
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 (creates) and resource (comment on an issue) plus the return value (its id). It is clear on its own, though it does not explicitly distinguish itself from siblings like edit_comment or list_issue_comments.
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 when-to-use or when-not-to-use guidance. The description never mentions the alternatives in a crowded comment lifecycle (edit_comment, delete_comment) or any prerequisite such as an existing issueKey.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.