Skip to main content
Glama
mcp-devops-onpremise

mcp-devops-onpremise

by zwitbaum

Add work item comment

devops_work_item_comment_add

Adds an HTML or Markdown comment to a specified Azure DevOps work item, enabling teams to document updates and communicate status in context.

Instructions

Add a comment to 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>",
      "text": "<text>"
    },
    "name": "devops_work_item_comment_add"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesThe comment text (Html or Markdown depending on format).
formatNoFormat of the comment text: 'html' (default) or 'markdown'.html
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

C2.8/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 structurally. The description adds nothing beyond that: it does not say whether the comment is appended versus replacing existing discussion, whether identity/authorization is required, or what happens if the work item is closed or missing. For a write operation, that is a thin disclosure.

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?

The single sentence is front-loaded and contains no filler, which is good. But it is concise by omission rather than by discipline: the brevity leaves the agent with less information than the schema alone already provides.

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?

An output schema exists and the input schema is fully described, so return values and parameters need no explanation here. What remains missing is behavioral context for a mutation: side effects, permission or identity requirements, and any indication of how this differs from the sibling comment tools. For a write tool with several near-identical siblings, that gap is material.

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% and each parameter (text, format, work_item_id) is documented inline, including the html/markdown default. The description contributes no additional meaning about the interplay between text and format, so the baseline of 3 applies.

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 sentence names a specific verb ('Add') and resource ('comment to a work item'), so the action is unambiguous. It does not, however, distinguish this tool from the closely named siblings devops_work_item_comment_update, devops_work_item_comment_list, or devops_work_item_comment_delete, so an agent gets no help disambiguating within the comment family.

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 at all: nothing says to use this rather than comment_update, and no prerequisites (existing work item, permissions) are stated. The only implied usage is 'when you want a new comment,' which is a restatement of the name rather than guidance.

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