Skip to main content
Glama

add_comment

Anchors a user review comment to a saved document revision and text range so feedback stays tied to the exact content it references.

Instructions

Keep an original user review comment anchored to a saved document revision and text range.

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": {
      "id": "<id>",
      "path": "<path>",
      "expectedIdentity": "<expectedIdentity>",
      "revision": "<revision>",
      "start": "<start>",
      "end": "<end>",
      "text": "<text>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
endYes
pathYes
textYes
startYes
revisionYes
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.
expectedIdentityYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds only the anchoring concept and says nothing about what happens on revision mismatch, whether the call is idempotent, what permissions are needed, or what identifying value the new comment receives.

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

Conciseness3/5

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

A single short sentence with no padding, so it is concise by construction. The tradeoff is that brevity here is under-specification rather than density: the one clause is front-loaded on anchoring semantics instead of the actual action.

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

Completeness2/5

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

For an eight-parameter mutation tool with near-zero schema coverage and no output schema, this description is far too thin. It does not establish the creation semantics, the identity/concurrency contract, the workspacePath storage selection, or what the caller gets back.

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

Parameters2/5

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

Schema description coverage is only 13%, with 8 parameters (7 required), so the description must carry the burden. It gestures at revision, start and end through 'saved document revision and text range', but leaves id, path, text and especially expectedIdentity — the 64-hex concurrency token — entirely unexplained in both schema and description.

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

Purpose3/5

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

The description names the resource (an original user review comment) and the anchoring targets (a saved document revision and text range), which is more specific than the tool name alone. However, the verb phrase 'keep ... anchored' is opaque for what is evidently a creation/mutation operation, and nothing distinguishes it from sibling document tools beyond the incidental mention of revisions.

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 when-to-use guidance, no prerequisite stated (such as obtaining expectedIdentity from a prior read), and no reference to alternatives. The agent must infer entirely from the name and the sibling list when this is the right call versus save_document or read_document.

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