Polarion MCP

Overview Schema Source Related Servers Discussions Admin

list_document_enum_options

Read-only

Retrieve valid enum option IDs for a Polarion document field to avoid write rejections. Verify available values before creating or updating documents.

Instructions

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

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

Input Schema

TableJSON Schema

Name	Required	Description
`field_id`	Yes	e.g. 'status', 'type', or a custom field id.
`page_size`	No
`project_id`	Yes	Polarion project ID.
`page_number`	No
`document_type`	Yes	e.g. 'systemReqSpecification'; '~' = type-agnostic.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`page`	Yes
`items`	Yes
`has_more`	No
`page_size`	Yes
`total_count`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv2.0.0Jul 22, 2026

changedOutput schema / properties / items / items / description

Previous value: -"Single enum option returned by ``list_*_enum_options``."New value: +"Single enum option from ``list_*_enum_options``."

Changed2 schema fields changedv1.4.0Jun 26, 2026

changedInput schema / properties / document_type / description

Previous value: -"Document type id (e.g. 'systemReqSpecification'). Pass '~' for type-agnostic options."New value: +"e.g. 'systemReqSpecification'; '~' = type-agnostic."

changedInput schema / properties / field_id / description

Previous value: -"Field id (e.g. 'status', 'type', or a custom field id)."New value: +"e.g. 'status', 'type', or a custom field id."

Changed10 schema fields changedv1.1.0Jun 9, 2026

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."
```

First observedv0.9.0May 28, 2026

TDQS

A4.9/5.0

Behavior5/5

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

Discloses the fallback behavior for unknown document_type, which is beyond the readOnlyHint annotation. 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.

Conciseness5/5

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

Three clear, front-loaded sentences. No fluff, every sentence adds value.

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?

For a simple listing tool with an output schema, the description covers purpose, usage guidelines, and a behavioral nuance. It is complete given the tool's complexity.

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?

The schema provides descriptions for most parameters (field_id, project_id, document_type) covering 60% of parameters. The description adds critical context about document_type fallback and pre-write usage. Pagination params are standard, so the description adds value without over-explaining.

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 ('list') and clarifies the scope ('valid enum option ids for a document field of a given type'). It distinguishes from siblings like list_work_item_enum_options by specifying 'document field'.

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 states when to call this tool ('before create_document / update_document') and warns about invalid enum IDs being rejected. Also provides a caveat about unknown document_type falling back to '~'.

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

Deploy Server