Skip to main content
Glama

create_work_item_property

Create custom properties for work items in Plane at workspace, project, or type level, with configurable data types, defaults, and validation.

Instructions

Create a new work item property.

Scope resolution:

  • project_id + work_item_type_id → type-scoped project property (legacy)

  • project_id only → project-level property (not yet linked to a type)

  • neither → workspace-level property

Args: display_name: Display name for the property property_type: TEXT | DATETIME | DECIMAL | BOOLEAN | OPTION | RELATION | URL | EMAIL | FILE | FORMULA project_id: UUID of the project. Omit for workspace-level property. work_item_type_id: UUID of the work item type — omit to create at project level relation_type: ISSUE | USER — required when property_type=RELATION description: Property description is_required: Whether the property is required default_value: Default value(s) for the property settings: Required for 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 options: List of {name, color?, is_default?} dicts — for OPTION type

Returns: Created WorkItemProperty object

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
optionsNo
is_multiNo
settingsNo
is_activeNo
project_idNo
descriptionNo
external_idNo
is_requiredNo
display_nameYes
default_valueNo
property_typeYes
relation_typeNo
external_sourceNo
validation_rulesNo
work_item_type_idNo

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
Behavior4/5

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

With no annotations, the description carries the burden of behavioral disclosure. It explains scope-dependent creation behavior, conditional required fields, and the return of a created object. However, it omits potential edge cases like providing work_item_type_id without project_id, error handling, or permission requirements, which are relevant for a create operation with complex scoping.

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 well-structured with summary, scope resolution, args, and returns sections. It is longer than minimal, but given the need to document 15 parameters without schema descriptions, each section earns its place. The front-loaded summary immediately states the core action.

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 complex 15-parameter tool with no annotations and no schema descriptions, the description covers parameter semantics, scoping logic, and return value. The only notable gap is not addressing the invalid combination of work_item_type_id without project_id, and lacking error-condition guidance. Overall, it is sufficiently complete for an agent to invoke the tool correctly.

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?

The input schema provides zero description coverage, yet the description lists all 15 parameters with types, constraints, and conditional logic (e.g., 'relation_type required when property_type=RELATION', 'settings required for TEXT/DATETIME', 'options for OPTION'). It adds rich semantics beyond the bare schema types, including detailed format examples for settings and scope resolution rules.

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 explicitly states 'Create a new work item property' with a specific verb and resource. The scope resolution section further clarifies the three possible scopes, distinguishing this create operation from update/delete/list siblings.

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

Usage Guidelines4/5

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

The description gives clear context on when to use different parameter combinations (project_id, work_item_type_id, neither) and provides conditional requirements (relation_type for RELATION, settings for TEXT/DATETIME). It does not explicitly mention using update_work_item_property for existing properties, but the tool name and 'Create a new' imply when this tool applies, making the usage clear without explicit exclusions.

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