Skip to main content
Glama
Sign In
aliyun

AlibabaCloud DevOps MCP Server

Official
by aliyun
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

create_work_item_comment

[Project Management] Create a comment for a specific work item. Set formatType to MARKDOWN for Markdown content or RICHTEXT for rich text. When omitted, the API defaults to RICHTEXT.

Instructions

[Project Management] Create a comment for a specific work item. Set formatType to MARKDOWN for Markdown content or RICHTEXT for rich text. When omitted, the API defaults to RICHTEXT.

Input Schema

NameRequiredDescriptionDefault
contentYes评论内容
formatTypeNo评论内容格式：RICHTEXT（富文本，默认）或 MARKDOWN（Markdown）。省略时使用服务端默认格式 RICHTEXT
workItemIdYes工作项ID
organizationIdYes企业ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.68
    • addedInput schema / properties / formatType
      Added value: +{
+  "description": "评论内容格式：RICHTEXT（富文本，默认）或 MARKDOWN（Markdown）。省略时使用服务端默认格式 RICHTEXT",
+  "enum": [
+    "RICHTEXT",
+    "MARKDOWN"
+  ],
+  "type": "string"
+}
  2. Changed1 schema field changedv0.3.62
    • changedInput schema / properties / workItemId / type
      Previous value: -"string"New value: +[
+  "string",
+  "number"
+]
  3. Changed2 schema fields changedv0.3.60
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / organizationId / description
      Previous value: -"企业ID，可在组织管理后台的基本信息页面获取"New value: +"企业ID"
  4. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden for a write operation. It notes the RICHTEXT default, but that same default is already documented in the schema, and it says nothing about permissions, whether the comment echoes a response, or side effects like notifications. This is a significant gap for an unannotated mutation tool.

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?

Three tight sentences, front-loaded with the action and followed by the only meaningful option detail. No filler or redundancy beyond the formatType restatement.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description would ideally cover what a successful call returns, and as an unannotated write tool it should at least hint at permissions or side effects. It is adequate for invocation since the schema is fully documented, but thin on behavioral context.

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 four parameters are already documented, making 3 the baseline. The description restates the formatType enum semantics and its default, but adds no syntax or format detail (e.g., what Markdown constructs are supported) beyond the schema.

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?

States a specific verb+resource ("Create a comment") scoped to "a specific work item", which distinguishes it from the similarly-named comment creators for change requests and commits. It is clear but does not explicitly name a sibling to route against, so it stops short of 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?

No when-to-use guidance, no prerequisites, and no mention of related tools like list_work_item_comments or update/delete counterparts. The only instruction concerns formatType, which is parameter behavior rather than usage context.

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

Deploy Server

Other Tools