Skip to main content
Glama

list_document_enum_options

Read-only

Retrieve valid enum options for a document field by project, field ID, and document type. Use before updating documents to prevent invalid or ghost values.

Instructions

List valid enum options for a document field of the given document type.

Call before update_document to resolve a status / type / custom-enum value — Polarion does NOT validate on write (unknown ids persist as ghosts). Document fields only. Returns the FULL set; document_type='~' is type-agnostic, and an unknown type silently falls back to ~, so verify the type id first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesPolarion project ID.
field_idYesField id (e.g. 'status', 'type', or a custom field id).
document_typeYesDocument type id (e.g. 'systemReqSpecification'). Pass '~' for type-agnostic options.
page_sizeNo
page_numberNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
total_countYes
pageYes
page_sizeYes
has_moreNo
Behavior4/5

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

Discloses that tool returns FULL set, type-agnostic fallback with '~', and silent fallback for unknown types. Adds value beyond readOnlyHint annotation by detailing operational quirks.

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 short paragraphs, front-loaded with purpose, every sentence adds value. No redundant words.

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?

Covers crucial context: when to use (before update), what it returns (full set), fallback behavior. With output schema present, return value coverage is adequate. Pagination is handled by schema.

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?

With 60% schema coverage, description explains field_id as enum fields (status/type/custom) and document_type fallback behavior. Adds meaning beyond schema entries. Page size/number not detailed but schema handles them.

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?

Description uses specific verb 'List' and resource 'valid enum options for a document field', and distinguishes from sibling by stating 'Document fields only.'

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?

Explicitly advises calling before update_document and warns about Polarion behavior (unknown ids persist as ghosts). Provides guidance on verifying type id. Could explicitly contrast with list_work_item_enum_options but sibling context is clear.

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/devemberx/mcp-server-polarion'

If you have feedback or need assistance with the MCP directory API, please join our Discord server