Skip to main content
Glama

Add Jira comment

add_comment

Posts a plain-text comment to a Jira issue using the issue key and comment body; returns the comment ID and creation time.

Instructions

Add a plain-text comment to a Jira issue. Returns ID and created.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "issue_key": "<issue_key>",
      "body": "<body>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesPlain-text comment. Blank lines separate paragraphs.
config_idNoJira instance to use, from list_configs. Omit for the default.
issue_keyYesIssue key, e.g. ONE-123.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true. The description adds two useful facts beyond them: comments are plain-text only, and the call returns ID and created. It does not mention the duplicate-on-retry behavior implied by idempotentHint=false or any permission requirement.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with zero filler, and the action is front-loaded before the return-value clause.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With full schema coverage and annotations covering the safety profile, the description supplies what is missing: the plain-text restriction and a summary of the return payload in the absence of an output schema. A note on Jira markup restrictions or mention syntax would close the remaining gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so all three parameters are already documented, including the config_id fallback to the default instance. The description's only added semantics is the plain-text constraint, which matches the body field's own description rather than extending it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Add a plain-text comment to a Jira issue") and immediately names the return values. It does not reference any sibling tool, but none of the listed siblings handle comments, so the operation is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use guidance, no prerequisites (e.g. permissions or issue state), and no mention of alternatives for richer formatted content. Usage is only implied by the verb.

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