Skip to main content
Glama

update_work_item_property

Idempotent

Update a work item property by ID to change its display name, type, settings, required status, and other attributes. Supports project or workspace scope.

Instructions

Update a work item property by ID.

Args: work_item_property_id: UUID of the property project_id: UUID of the project. Omit for workspace scope. work_item_type_id: UUID of the work item type - required when project_id is provided display_name: Display name for the property property_type: TEXT | DATETIME | DECIMAL | BOOLEAN | OPTION | RELATION | URL | EMAIL | FILE | FORMULA relation_type: ISSUE | USER - required when updating to RELATION description: Property description is_required: Whether the property is required default_value: Default value(s) for the property settings: Required when changing type to TEXT/DATETIME. TEXT: {"display_format": "single-line"|"multi-line"|"readonly"} DATETIME: {"display_format": "MMM dd, yyyy"|"dd/MM/yyyy"|"MM/dd/yyyy"|"yyyy/MM/dd"} is_active: Whether the property is active is_multi: Whether the property supports multiple values validation_rules: Validation rules dictionary external_source: External system source name external_id: External system identifier

Returns: Updated WorkItemProperty object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
is_multiNo
settingsNo
is_activeNo
project_idNo
descriptionNo
external_idNo
is_requiredNo
display_nameNo
default_valueNo
property_typeNo
relation_typeNo
external_sourceNo
validation_rulesNo
work_item_type_idNo
work_item_property_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
nameNo
optionsNo
projectNo
is_multiNo
settingsNo
is_activeNo
workspaceNo
created_atNo
created_byNo
deleted_atNo
issue_typeNo
logo_propsNo
sort_orderNo
updated_atNo
updated_byNo
descriptionNo
external_idNo
is_requiredNo
display_nameYes
default_valueNo
property_typeYes
relation_typeNo
external_sourceNo
validation_rulesNo
Behavior3/5

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

Annotations already provide idempotentHint and destructiveHint. The description adds conditionals (e.g., required when changing to RELATION) but lacks deeper behavioral context like auth needs 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 lengthy but well-structured as a docstring with line breaks. It could be more concise, but for 15 parameters, it is adequately organized.

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?

Given the presence of output schema and annotations, the description covers param behaviors and dependencies thoroughly. It lacks usage guidelines but is otherwise complete for a complex tool.

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?

With 0% schema description coverage, the description carries the full burden. It provides types, examples (e.g., settings format), and dependencies (e.g., relation_type required when updating to RELATION), adding significant value.

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 clearly states the action 'Update' and the resource 'work item property', distinguishing it from siblings like create, retrieve, delete, and manage work item property tools.

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 guidance on when to use this tool vs alternatives such as create or delete work item property. Only parameter dependencies are mentioned, not context of use.

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