Skip to main content
Glama
proprock
by proprock

add_comment

Add a comment to a Jira issue using Markdown formatting, which converts to Jira rich text. The comment cannot be edited or deleted after creation.

Instructions

Add one comment to an issue. body is Markdown -- headings, lists, fenced code blocks, bold/italic, inline code, links -- converted to Jira's rich text; anything outside that set stays literal. Returns the created comment in the same shape get_comments returns. This server cannot edit or delete a comment afterwards.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
issue_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.3.0
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "title": "add_commentDictOutput",
      -  "type": "object"
      -}New value: +null
  2. Added

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only indicate readOnly=false, idempotent=false, and destructive=false. The description adds substantial behavioral detail beyond those: the Markdown-to-Jira rich text conversion set, the fact that unsupported markup remains literal, the return shape alignment with get_comments, and the permanent inability to edit/delete the comment.

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?

Three sentences with no waste. The action is front-loaded, the Markdown details are compactly enumerated, and the limitation sentence adds necessary operational context. Every sentence earns its place.

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?

For a simple two-parameter tool, the description covers the action, body formatting behavior, return shape, and an important operational limitation. It does not describe issue_key format, but the tool's low complexity and the return-shape note make the definition essentially complete.

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 description coverage is 0%, so the description must compensate. It richly explains body semantics, specifying which Markdown constructs are converted and that everything else stays literal. However, issue_key is left completely unelaborated — no format, source, or example — so only one of the two parameters receives meaningful semantic enrichment.

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

Purpose5/5

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

The description opens with a specific verb and resource: 'Add one comment to an issue.' This clearly distinguishes it from read-oriented siblings like get_comments and from update_issue, and the mention of return shape reinforces its role as a create-comment operation.

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

Usage Guidelines4/5

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

The description makes the usage context clear: it creates a comment, returns the same shape as get_comments, and explicitly warns that the server cannot edit or delete the comment afterwards. It does not explicitly name alternatives or when-not-to-use conditions, but the context is strong enough for an agent to route correctly.

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