Skip to main content
Glama
goto-software

plane-mcp-server

create_work_item_comment

Add a comment to a work item by specifying the project and work item IDs. Supports HTML or JSON content, access levels, and external references.

Instructions

Create a comment for a work item.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesUUID of the project
work_item_idYesUUID of the work item
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 full burden but only states it creates a comment. No disclosure of mutation effects, permission requirements, error conditions, or side effects.

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 description is a single, clear sentence. It is concise but lacks structure or additional context for a tool with 7 parameters, making it passable but not exemplary.

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?

Given the tool has many optional parameters (e.g., comment_html vs comment_json, access levels) and no output schema details in description, the context is insufficient for an agent to correctly use all features.

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 parameters are described in the schema. The tool description adds no additional meaning beyond what the schema provides, which meets baseline expectations.

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 'Create a comment for a work item' clearly states the action and target resource. It differentiates from other comment-related tools like list or delete, but does not emphasize sibling differentiation.

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 usage guidelines are provided. There is no indication when to use this tool versus other comment operations (e.g., update_work_item_comment) or what prerequisites exist.

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