Skip to main content
Glama
mcp-devops-onpremise

mcp-devops-onpremise

by zwitbaum

Update work item comment

devops_work_item_comment_update
Destructive

Modify an existing comment on an Azure DevOps work item by specifying the work item ID, comment ID, and updated text, with HTML or Markdown format support.

Instructions

Update an existing comment on a work item.

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": {
      "work_item_id": "<work_item_id>",
      "comment_id": "<comment_id>",
      "text": "<text>"
    },
    "name": "devops_work_item_comment_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesThe updated comment text.
formatNoFormat of the comment text: 'html' (default) or 'markdown'.html
comment_idYesThe numeric ID of the comment to update.
work_item_idYesThe numeric work item ID.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=false, so the safety profile is carried by structured data. The description adds nothing beyond that: it does not say the existing text is overwritten, whether history/prior revisions are retained, or that permission on the work item is required. Given destructiveHint=true, the absence of any 'replaces the existing comment text' warning is a real gap.

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?

A single front-loaded sentence with zero filler and no restatement of the title. It is efficient, though the brevity is partly under-specification rather than deliberate compression.

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 structurally simple (4 flat params, all documented, output schema present, annotations covering safety), so the description does not need to explain return values or nested shapes. The only missing piece an agent would want is confirmation that the update overwrites existing comment text, given destructiveHint=true.

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%, with each parameter (text, format, comment_id, work_item_id) documented inline, so the schema does the heavy lifting and the baseline is 3. The description contributes no additional meaning, such as whether format defaults or how text is interpreted under html versus markdown.

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 names a specific verb and resource combination: 'Update an existing comment on a work item.' This is unambiguous about what is being modified, and the work-item-comment scope distinguishes it from devops_pull_request_update_comment. It stops short of explicit sibling routing against devops_work_item_comment_add/delete, which keeps it below a 5.

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 (e.g., the comment must already exist and belong to the caller), and no reference to the add/delete siblings that cover adjacent operations. The agent must infer that this is the edit path versus comment_add for new comments.

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