Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Add Comment

add_comment

Post comments on a runbook or specific task to record progress notes and results without overwriting task descriptions.

Instructions

Post a comment on a runbook, optionally attached to a specific task.

Use this to record progress notes or results (e.g. while working through a runbook's tasks) without overwriting task descriptions.

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": {
      "runbook_id": "<runbook_id>",
      "content": "<content>"
    },
    "name": "add_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYesThe text content of the comment. Content supports a limited set of HTML tags (for example, <p>, <b>, <ul>, <code>); markdown is not rendered and disallowed tags are stripped.
task_idNoOptional ID of the task to attach the comment to (the same task ID used by the other task tools). When omitted, the comment is posted at runbook level.
runbook_idYesThe ID of the runbook to comment on.

Output Schema

NameRequiredDescriptionDefault
dataYes
includedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations supplied, the description must carry the behavioral load. It discloses the key trait that this is additive and non-destructive ('without overwriting task descriptions') and that task attachment is optional, but says nothing about required permissions, whether comments can later be edited or deleted, or other side effects of a write operation.

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?

Two sentences, front-loaded with the action and followed by the selection rationale; no filler or restatement of the title beyond the necessary verb-resource pairing. The parenthetical example is slightly verbose but earns its place by clarifying the intended workflow.

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?

An output schema exists, so return values need not be described, and the three parameters are fully covered by the schema. For a simple write tool with no annotations the description covers action, scope, and intent adequately; only permission and mutability/lifecycle details are left unstated.

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 all three parameters are already documented in detail, including HTML-tag support and the runbook-level default. The description only echoes the optional task_id semantics, adding no syntax or format guidance beyond the schema, which is the expected baseline.

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 first sentence uses a specific verb and resource ('Post a comment on a runbook') and adds the scope modifier of optional task attachment, which lets an agent distinguish it from the read-side sibling get_comments. It stops short of naming any sibling to sharpen that contrast, but the operation itself 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 Guidelines4/5

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

The second sentence gives concrete when-to-use context ('record progress notes or results ... while working through a runbook's tasks') and an implicit alternative ('without overwriting task descriptions'), steering the agent away from editing tasks. It gives no explicit when-not-to-use or named alternative tool, so it falls short of a 5.

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