Skip to main content
Glama

update_work_item

Idempotent

Update a work item's details including name, assignees, priority, dates, and more by providing its project and work item IDs.

Instructions

Update a work item by ID.

Args: project_id: UUID of the project work_item_id: UUID of the work item name: Work item name assignees: List of user IDs to assign to the work item labels: List of label IDs to attach to the work item type_id: UUID of the work item type point: Story point value description_html: HTML description of the work item description_stripped: Plain text description. Convenience only - it is wrapped into HTML and stored as description_html (Plane derives description_stripped server-side). Ignored if description_html is set. priority: Priority level (urgent, high, medium, low, none) start_date: Start date (ISO 8601 format) target_date: Target/end date (ISO 8601 format) sort_order: Sort order value is_draft: Whether the work item is a draft external_source: External system source name external_id: External system identifier parent: UUID of the parent work item state: UUID of the state estimate_point: Estimate point value type: Work item type identifier

Returns: Updated WorkItem object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
typeNo
pointNo
stateNo
labelsNo
parentNo
type_idNo
is_draftNo
priorityNo
assigneesNo
project_idYes
sort_orderNo
start_dateNo
external_idNo
target_dateNo
work_item_idYes
estimate_pointNo
external_sourceNo
description_htmlNo
description_strippedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameNo
typeNo
pointNo
stateNo
parentNo
projectNo
type_idNo
is_draftNo
priorityNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
sort_orderNo
start_dateNo
updated_atNo
updated_byNo
archived_atNo
external_idNo
sequence_idNo
target_dateNo
completed_atNo
estimate_pointNo
external_sourceNo
description_htmlNo
description_binaryNo
description_strippedNo
Behavior4/5

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

Annotations indicate readOnlyHint=false, idempotentHint=true, destructiveHint=false, which are consistent with an update operation. The description adds useful detail about description_stripped being a convenience that gets wrapped into HTML and ignored if description_html is set. No contradictions.

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 front-loaded with a clear purpose, but the parameter list is verbose and could be more concise. Each parameter is listed with its type and description, which is thorough but lengthy. It could be shortened without losing clarity.

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?

For a tool with 20 parameters and an output schema, the description covers all inputs and notes the return type. It provides sufficient context for an agent to understand what fields can be updated and how they relate. The presence of an output schema reduces the need to describe return values.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, but the description provides meaningful explanations for all 20 parameters, including relationships (e.g., description_stripped vs description_html), formats (ISO 8601 for dates), and allowed values (priority levels). This fully compensates for the lack of schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description starts with 'Update a work item by ID.', clearly stating the action and resource. It distinguishes from sibling tools like create_work_item, delete_work_item, etc., by focusing on update.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when modifying an existing work item, but does not provide explicit guidance on when to use this tool versus alternatives like manage_work_item_assignee or manage_work_item_label. No exclusions or context are given.

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/Bl4nk44/plane-ce-mcp'

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