Skip to main content
Glama
goto-software

plane-mcp-server

update_work_item_comment

Update an existing comment on a work item by providing the project, work item, and comment IDs. Specify new content, access level, or external system details.

Instructions

Update a comment for a work item.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesUUID of the project
work_item_idYesUUID of the work item
comment_idYesUUID of the comment
comment_htmlNoComment content in HTML format
comment_jsonNoComment content in JSON format
accessNoAccess level for the comment (INTERNAL or EXTERNAL)
external_sourceNoExternal system source name
external_idNoExternal system identifier

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
is_memberNo
created_atNo
updated_atNo
deleted_atNo
comment_strippedNo
comment_htmlNo
attachmentsNo
accessNo
external_sourceNo
external_idNo
edited_atNo
created_byNo
updated_byNo
projectNo
workspaceNo
issueNo
actorNo
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 behavioral traits. It does not mention idempotency, error handling, auth requirements, or side effects like overwriting fields.

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?

The description is a single clear sentence, concise and front-loaded. However, it lacks any structure or elaboration, which might be acceptable given the schema covers details.

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?

Despite the presence of output schema and full parameter coverage, the description is too minimal. For a tool with 8 parameters and many siblings, more context on update behavior and optional fields is needed for complete understanding.

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 coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond parameter names; it does not clarify the interplay between comment_html and comment_json or the semantics of access levels.

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 clearly states the verb 'Update' and resource 'comment for a work item', distinguishing it from listing, retrieving, creating, or deleting comments. However, it does not elaborate on what fields can be updated or any constraints.

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 guidance is provided on when to use this tool versus alternatives like create_work_item_comment or delete_work_item_comment. The description does not mention prerequisites or context for updates.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/goto-software/plane-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server