Skip to main content
Glama

Edit or resolve a comment

handover.update_comment

Edit an authored comment, or resolve/reopen an annotation. Set resolvedRevisionId when a new handover revision addressed the feedback.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoReplacement comment body; omit to preserve the current body.
statusNoOpen, resolve, or reopen the feedback thread.
targetNoReplacement annotation target, or null to remove the anchor.
commentIdYesComment or annotation to edit, resolve, or reopen.
handoverIdYesHandover containing the comment.
resolvedRevisionIdNoRevision that addressed the feedback, or null when reopening.
mentionPrincipalIdsNoReplacement collaborator mentions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • addedInput schema / properties / body / description
      Added value: +"Replacement comment body; omit to preserve the current body."
    • addedInput schema / properties / commentId / description
      Added value: +"Comment or annotation to edit, resolve, or reopen."
    • addedInput schema / properties / handoverId / description
      Added value: +"Handover containing the comment."
    • addedInput schema / properties / mentionPrincipalIds / description
      Added value: +"Replacement collaborator mentions."
    • addedInput schema / properties / resolvedRevisionId / description
      Added value: +"Revision that addressed the feedback, or null when reopening."
    • addedInput schema / properties / status / description
      Added value: +"Open, resolve, or reopen the feedback thread."
    • changedInput schema / properties / target / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "artifactId": {
      -        "pattern": "^art_",
      -        "type": "string"
      -      },
      -      "revisionId": {
      -        "pattern": "^rev_",
      -        "type": "string"
      -      },
      -      "selector": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "endLine": {
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "endOffset": {
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "exact": {
      -            "description": "The exact selected text.",
      -            "maxLength": 4000,
      -            "minLength": 1,
      -            "type": "string"
      -          },
      -          "prefix": {
      -            "description": "Text immediately before the selection.",
      -            "maxLength": 500,
      -            "type": "string"
      -          },
      -          "startLine": {
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "startOffset": {
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "suffix": {
      -            "description": "Text immediately after the selection.",
      -            "maxLength": 500,
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "exact"
      -        ],
      -        "type": "object"
      -      },
      -      "targetKind": {
      -        "enum": [
      -          "text",
      -          "code",
      -          "html"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "revisionId",
      -      "artifactId",
      -      "targetKind",
      -      "selector"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "artifactId": {
      +        "description": "Artifact containing the selected text or code.",
      +        "pattern": "^art_",
      +        "type": "string"
      +      },
      +      "revisionId": {
      +        "description": "Immutable revision containing the annotated artifact.",
      +        "pattern": "^rev_",
      +        "type": "string"
      +      },
      +      "selector": {
      +        "additionalProperties": false,
      +        "description": "Exact quote plus optional position and surrounding context.",
      +        "properties": {
      +          "endLine": {
      +            "description": "Zero-based line where the selection ends.",
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "endOffset": {
      +            "description": "Zero-based character offset immediately after the selection.",
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "exact": {
      +            "description": "The exact selected text.",
      +            "maxLength": 4000,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "prefix": {
      +            "description": "Text immediately before the selection.",
      +            "maxLength": 500,
      +            "type": "string"
      +          },
      +          "startLine": {
      +            "description": "Zero-based line where the selection starts.",
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "startOffset": {
      +            "description": "Zero-based character offset where the selection starts.",
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "suffix": {
      +            "description": "Text immediately after the selection.",
      +            "maxLength": 500,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "exact"
      +        ],
      +        "type": "object"
      +      },
      +      "targetKind": {
      +        "description": "Rendering context used to relocate and display the annotation.",
      +        "enum": [
      +          "text",
      +          "code",
      +          "html"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "revisionId",
      +      "artifactId",
      +      "targetKind",
      +      "selector"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / target / description
      Added value: +"Replacement annotation target, or null to remove the anchor."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already convey readOnly=false and destructiveHint=false. The description adds meaningful context beyond annotations by mentioning the two actions (edit vs resolve/reopen) and the resolvedRevisionId condition, which clarifies the effect of the operation without contradicting the annotations.

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?

The description is two sentences, front-loaded with the primary purpose, and the second sentence adds a targeted usage hint. No extra words or redundant information.

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?

The tool is moderately complex with 7 parameters, but the schema provides comprehensive detail. The description covers the core scenarios (edit and resolve/reopen) and the resolvedRevisionId behavior, which is sufficient given the rich schema. It does not mention all parameters, but they are well-documented in the schema.

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 the baseline is 3. The description only repeats the resolvedRevisionId guidance already present in the schema, providing no additional parameter meaning beyond what the schema already documents.

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?

The description uses specific verbs ('Edit', 'resolve/reopen') and clearly names the resource ('authored comment', 'annotation'), distinguishing it from siblings like handover.comment and handover.annotate. It also mentions the condition for setting resolvedRevisionId, providing a clear scope.

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 description provides clear context for when to use the tool: editing an authored comment or resolving/reopening an annotation. It does not explicitly name sibling alternatives or exclusions, but the restriction to 'authored' comments and the specific actions imply appropriate usage.

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.