Skip to main content
Glama
Cutover MCP

Cutover MCP

Official
by gocutover

Get Comments

get_comments

List comments on a runbook, optionally filtered to a specific task, to read progress notes and status updates recorded during execution.

Instructions

List the comments on a runbook, optionally filtered to a specific task.

Comments are the append-only, timestamped log channel while a runbook is running (task descriptions are locked outside edit/dynamic mode), so this is how to read back progress notes or status that were recorded earlier with add_comment, by a person or by an agent.

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>"
    },
    "name": "get_comments"
  }
}

Input Schema

NameRequiredDescriptionDefault
task_idNoOptional ID of a task (the same task ID used by the other task tools) to return only the comments attached to that task. When omitted, every comment on the runbook is returned, including runbook-level ones.
runbook_idYesThe ID of the runbook to read comments from.

Output Schema

NameRequiredDescriptionDefault
dataYes
metaYesTop-level metadata for a list response.
linksYesPagination links for a list response.
includedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden and does meaningful work: it declares the channel append-only and timestamped, and clarifies it is the live progress log rather than a mutable field. It does not state ordering of returned comments, pagination behavior, or any permission requirements, which are the remaining behavioral gaps.

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?

Front-loaded with the operation and scope in the first sentence, with supporting context after. The second sentence is dense but each clause adds information (append-only, timestamped, locked task descriptions, add_comment linkage). Minor redundancy with the schema's task_id explanation.

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 read tool with a 100%-covered schema and an output schema, the definition covers purpose, scope, and channel semantics adequately. Only ordering and pagination of results are unaddressed, which are minor given the output schema exists.

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 both runbook_id and task_id are already fully documented, including the omit-to-get-all behavior. The description restates the optional task filter but adds no syntax, format, or edge-case meaning beyond the schema, so the baseline 3 applies.

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 ('List the comments on a runbook') plus the scope modifier ('optionally filtered to a specific task'). It also names the write counterpart add_comment, so an agent can distinguish read-back from write without inspecting schemas.

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?

Gives a clear use case: reading back progress notes or status recorded earlier via add_comment. The parenthetical explaining that task descriptions are locked outside edit/dynamic mode implicitly steers the agent toward comments for in-flight updates. No explicit when-not-to-use or pointing to a sibling read tool (e.g. get_action_logs vs comments) is given.

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