Skip to main content
Glama

list_work_item_enum_options

Read-only

Lists valid enum option IDs for a work item field before creating or updating items, preventing write rejections from invalid enum values.

Instructions

List valid enum option ids for a work item field of a given type.

Call this before create_work_items / update_work_items — invalid enum ids are rejected on write. An unknown work_item_type silently falls back to '~', so verify the type id first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
field_idYese.g. 'status', 'type', 'severity', 'priority', or a custom field id.
page_sizeNo
project_idYesPolarion project ID.
page_numberNo
work_item_typeYese.g. 'task', 'requirement'; '~' = type-agnostic.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYes
itemsYes
has_moreNo
page_sizeYes
total_countYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.0
  2. Removedv2.0.0
  3. Changed2 schema fields changedv1.4.0
    • changedInput schema / properties / field_id / description
      Previous value: -"Field id (e.g. 'status', 'type', 'severity', 'priority', or a custom field id)."New value: +"e.g. 'status', 'type', 'severity', 'priority', or a custom field id."
    • changedInput schema / properties / work_item_type / description
      Previous value: -"Work item type id (e.g. 'task', 'requirement'). Pass '~' for type-agnostic options."New value: +"e.g. 'task', 'requirement'; '~' = type-agnostic."
  4. Changed10 schema fields changedv1.1.0
    • removedInput schema / properties / page_number / description
      Removed value: -"Page number to retrieve (1-based, default 1)."
    • removedInput schema / properties / page_size / description
      Removed value: -"Number of options per page (1-100, default 100)."
    • removedOutput schema / properties / has_more / description
      Removed value: -"True if more pages follow."
    • changedOutput schema / properties / items / items / description
      Previous value: -"Single enum option returned by ``list_document_enum_options``.\n\nSurfaces only the attributes an LLM needs to pick a value before a\nwrite call. Other Polarion option fields (color, iconURL, columnWidth,\ncreateDefect, limited, minValue, oppositeName, parent,\nrequiresSignatureForTestCaseExecution, templateWorkItem) are not\nexposed."New value: +"Single enum option returned by ``list_*_enum_options``."
    • removedOutput schema / properties / items / items / properties / default / description
      Removed value: -"True when this option is the project default."
    • removedOutput schema / properties / items / items / properties / description / description
      Removed value: -"Option description; empty when Polarion has none."
    • removedOutput schema / properties / items / items / properties / hidden / description
      Removed value: -"True when the option is hidden in the UI; avoid selecting."
    • removedOutput schema / properties / items / items / properties / id / description
      Removed value: -"Option id; pass verbatim to write tools."
    • removedOutput schema / properties / items / items / properties / name / description
      Removed value: -"Human-readable display name."
    • removedOutput schema / properties / items / items / properties / terminal / description
      Removed value: -"For status fields, True for workflow end-states."
  5. First observedv0.9.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true. Description adds that invalid enum ids cause rejection on write and that an unknown work_item_type silently falls back to '~'. These are useful behavioral details beyond the annotation but not extensive.

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?

Two concise sentences, no fluff. First sentence states main purpose, second adds usage guidance. Front-loaded and efficient.

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 output schema exists (not shown), the description adequately covers the main use case, prerequisites, and a critical fallback behavior. Could mention pagination or the output format, but overall sufficient for the tool's simplicity.

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

Parameters3/5

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

Schema description coverage is 60% and the description does not elaborate on individual parameters beyond what the schema already says. The description implies the 'type' parameter but adds no new semantic detail for field_id, project_id, page_size, or page_number.

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?

Clearly states the verb 'List' and the resource 'valid enum option ids for a work item field of a given type'. Differentiates from sibling list_document_enum_options by specificity to work items. Fully unambiguous.

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

Usage Guidelines5/5

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

Explicitly instructs to call before create/update work items because invalid enum ids are rejected. Also warns about the fallback of unknown work_item_type to '~' and recommends verifying the type id first. Provides both context and caveat.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.