Skip to main content
Glama

list_work_item_properties

Read-only

List custom work item properties by workspace, project, or type. Each property includes UUID, display name, type, and options for use in PQL filters.

Instructions

List custom work item properties.

Scope resolution (highest priority first):

  • no args → ALL workspace-level properties (one API call)

  • work_item_type_id only → workspace-level properties linked to that type

  • project_id only → all properties in that project (any type)

  • project_id + work_item_type_id → properties linked to that type in that project, falling back to project-flat then workspace if empty

For PQL filtering by name, prefer calling with NO args - one workspace-wide fetch beats iterating every work item type. Each result includes the display_name you can match in-memory before composing cf["<id>"] in PQL.

Each result includes:

  • id: property UUID - use as cf[""] in PQL filters

  • display_name: user-facing label (e.g. "Fed", "Acceptance Criteria")

  • property_type: TEXT | OPTION | DECIMAL | BOOLEAN | DATETIME | RELATION | URL | EMAIL

  • options: for OPTION type, each option has id + name; use option id in PQL

PQL workflow for filtering by custom property (efficient path):

  1. list_work_item_properties() → all workspace properties, one call

  2. find the property by display_name in-memory → property.id

  3. list_work_items(pql='cf["<property.id>"] = "<option.id>"')

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsNo
project_idNo
work_item_type_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Annotations already provide readOnlyHint and openWorldHint. The description adds substantial behavioral context: scope resolution fallback logic, efficiency advice, result structure (including fields like id, display_name, property_type, options), and a PQL workflow. No contradictions with annotations.

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 sections for scope resolution, result fields, and PQL workflow. It is verbose but each section adds value. Front-loaded with purpose. Slightly long but effective.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (multiple parameter combinations, return structure, and PQL integration), the description covers scope rules, result fields, and a workflow example. Output schema exists, so return values are not required, but description still lists fields. Highly complete.

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?

Schema coverage is 0%, so the description must compensate. It explains the effect of project_id and work_item_type_id combinations on scope. The 'params' parameter is not explained (it's a generic catch-all), but the overall parameter usage is well-covered. A minor gap but still strong.

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 'List custom work item properties,' a specific verb and resource. It then details scope resolution rules for different argument combinations, clearly distinguishing the behavior from sibling property-related tools like list_work_item_property_options and retrieve_work_item_property.

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 provides explicit guidance: prefer no args for workspace-wide fetch, and outlines a clear PQL workflow. It explains when to use each argument combination but does not explicitly state when not to use the tool or list alternatives, though the context is strong.

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