Skip to main content
Glama
Sign In

Comma

by com.commareports
OverviewDiscussionsAdmin

add_comment

Create a top-level comment on a report. Optionally anchor it to a text excerpt or block id.

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": {
      "report_id": "<report_id>",
      "body": "<body>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesComment text.
block_idNoStable block identifier in the rendered HTML.
report_idYesReport id (UUID).
anchor_textNoQuoted text the comment is anchored to.
anchor_prefixNoText before anchor_text (for disambiguation).
anchor_suffixNoText after anchor_text (for disambiguation).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden, and it discloses little beyond the name: that a comment is created and that it can be anchored. It says nothing about permissions, whether the comment is public immediately, whether it triggers a notification (a create_notification sibling exists), or whether the operation is idempotent. Anchoring behavior (must the excerpt exist in the report?) is also unstated.

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, zero filler, with the core action front-loaded and the optional anchoring clause second. Nothing needs trimming.

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

Completeness3/5

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

For a 6-parameter mutation tool with no annotations and no output schema, the description is minimal but covers the essential action and the anchoring option. It omits failure conditions, permissions, and notification side effects that would help an agent invoke it correctly.

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 100%, so every parameter is already documented in the schema, giving a baseline of 3. The description adds only the relational idea that anchoring is optional and is done via 'a text excerpt or block id,' which does not cover anchor_prefix/anchor_suffix or add syntax detail beyond the schema.

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?

The description gives a specific verb and resource ('Create a top-level comment on a report') and the word 'top-level' implicitly distinguishes it from the sibling reply_to_comment. It stops short of explicitly naming alternatives, but an agent can tell what resource is being written.

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

Usage Guidelines3/5

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

Usage is only implied: 'top-level' hints that threaded replies belong to reply_to_comment, and the optional anchoring is described. There is no explicit when-to-use statement, no prerequisites (e.g., whether the report must be shared or the caller must be a reviewer), and no exclusions.

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

All Comma toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources