Skip to main content
Glama

add_issue_comment

Post a new comment to a review issue thread (marked as AI-generated). Returns the created comment object. USAGE GUIDELINE: Whenever you finish updating a mock or rule to address an open issue, you MUST call add_issue_comment on that issueSlugId to explain what was changed and how you verified it (e.g. via test_mock), then ask the user to review and resolve the issue.

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": {
      "issueSlugId": "<issueSlugId>",
      "content": "<content>"
    },
    "name": "add_issue_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYesComment text explaining the fix, rule changes, or diagnostic findings.
issueSlugIdYesUnique slug ID of the target issue (e.g. 'ISS-xxxxxx').

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / content / description
      Previous value: -"Comment text content"New value: +"Comment text explaining the fix, rule changes, or diagnostic findings."
    • changedInput schema / properties / issueSlugId / description
      Previous value: -"The slug ID of the Issue (e.g. 'ISS-xxxxxx')"New value: +"Unique slug ID of the target issue (e.g. 'ISS-xxxxxx')."
  2. First observed

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden; it does disclose the AI-generated marking and that a created comment object is returned. It does not cover failure modes, whether posting to a resolved or closed issue is allowed, or any permission requirements. Useful mutation context, but the disclosure stops short of full behavioral coverage.

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

Conciseness4/5

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

The purpose and return value are front-loaded in the first sentence, with the guideline second and clearly separated by a label. The usage guideline is somewhat long and imperative-heavy, but each clause adds a real trigger or follow-up action rather than filler.

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 two-parameter write tool with no output schema, the description covers what is posted, how it is tagged, what comes back, and when to call it. Only error and eligibility behavior for the target issue thread is left unaddressed.

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%, with both required parameters documented, so the baseline is 3. The description only re-anchors issueSlugId as 'that issueSlugId' tied to the issue just fixed, adding situational meaning but no format or content-shaping detail beyond the schema.

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?

States a specific verb and resource — 'Post a new comment to a review issue thread' — and adds the distinguishing trait that the comment is marked as AI-generated. An agent can separate this from siblings like get_issue, list_issues, and resolve_issue without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('Whenever you finish updating a mock or rule to address an open issue'), mandates the call, and names the downstream step ('ask the user to review and resolve the issue'), which implicitly routes resolution elsewhere. This is when-to-use guidance with a concrete condition rather than inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources