Skip to main content
Glama

update_work_item_property_option

Update an existing option for a work item property by its ID, modifying fields such as name, description, color, default status, or external references.

Instructions

Update an option on a work item property.

Args: property_id: UUID of the work item property option_id: UUID of the option project_id: UUID of the project. Omit for workspace scope. name: Display name for the option description: Option description color: Hex color string e.g. "#FF5733" is_default: Whether this is the default option external_source: External system source name external_id: External system identifier

Returns: Updated WorkItemPropertyOption object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
colorNo
option_idYes
is_defaultNo
project_idNo
descriptionNo
external_idNo
property_idYes
external_sourceNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameYes
parentNo
projectNo
propertyNo
is_activeNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
is_defaultNo
logo_propsNo
sort_orderNo
updated_atNo
updated_byNo
descriptionNo
external_idNo
external_sourceNo
Behavior2/5

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

No annotations exist, so the description must disclose mutation side effects, scope behavior, and prerequisites. It mentions 'Omit for workspace scope' for project_id and describes the return object, but does not state whether the update is partial, whether the option must already exist, or any permission/reversibility requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is efficiently structured with a one-line purpose, an Args block, and a Returns line. Every parameter line carries essential information without redundancy, making it easy to scan.

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?

For a 9-parameter mutation with no annotations, the description covers purpose, parameters, and return type but omits usage context, prerequisite existence, and partial-update semantics. It is adequate but not fully complete for complex agent decision-making.

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

Parameters4/5

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

With 0% schema description coverage, the description compensates by annotating every parameter with a concise meaning, including UUID roles, the project scope omission behavior, and color format. This adds clear value beyond the bare input schema, though external_source/external_id could use slightly more detail.

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 uses a specific verb ('Update') and resource ('an option on a work item property'), clearly distinguishing it from sibling tools like create_work_item_property_option, retrieve_work_item_property_option, and delete_work_item_property_option. The tool name aligns with the description, making the purpose unmistakable.

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 explicit 'when to use' guidance or alternatives are mentioned. The description only states the action and parameters, leaving the agent to infer when to choose update over create/retrieve/delete siblings from the name alone.

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/leigangzhang/plane-mcp-server-adapter'

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