Skip to main content
Glama
phillipboesger

Polarion MCP Server

getCurrentEnumerationOptionsForDocument

Read-only

Get the fully resolved enumeration options currently selected in a document field (ID, name, color/icon) instead of the bare stored value.

Instructions

Returns the enumeration option(s) currently selected in one field of one Document, resolved to full option objects (ID, name, color/icon) rather than the bare stored ID. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Use it to display or compare the current value; for the options you could switch to use getAvailableEnumOptionsForDocument.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldIdYesThe ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs.
spaceIdYesThe Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
revisionNoA specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision.
projectIdYesThe Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs.
page_size_NoMaximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set.
documentNameYesThe Document name.
page_number_No1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
metaNo
linksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.2
    • changedInput schema / properties / fieldId / description
      Previous value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
  2. Changed5 schema fields changedv1.2.0
    • changedInput schema / properties / page_number_ / description
      Previous value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page."
    • changedInput schema / properties / page_size_ / description
      Previous value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
    • changedInput schema / properties / projectId / description
      Previous value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
    • changedInput schema / properties / revision / description
      Previous value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
    • changedInput schema / properties / spaceId / description
      Previous value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
  3. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "properties": {
      +          "color": {
      +            "example": "#F9FF4D",
      +            "type": "string"
      +          },
      +          "columnWidth": {
      +            "example": "90%",
      +            "type": "string"
      +          },
      +          "createDefect": {
      +            "example": true,
      +            "type": "boolean"
      +          },
      +          "default": {
      +            "example": true,
      +            "type": "boolean"
      +          },
      +          "description": {
      +            "example": "Description",
      +            "type": "string"
      +          },
      +          "hidden": {
      +            "example": false,
      +            "type": "boolean"
      +          },
      +          "iconURL": {
      +            "example": "/polarion/icons/default/enums/status_open.gif",
      +            "type": "string"
      +          },
      +          "id": {
      +            "example": "open",
      +            "type": "string"
      +          },
      +          "limited": {
      +            "example": true,
      +            "type": "boolean"
      +          },
      +          "linkRules": {
      +            "items": {
      +              "properties": {
      +                "fromTypes": {
      +                  "example": [
      +                    "requirement"
      +                  ],
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                },
      +                "sameType": {
      +                  "example": false,
      +                  "type": "boolean"
      +                },
      +                "toTypes": {
      +                  "example": [
      +                    "requirement"
      +                  ],
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "minValue": {
      +            "example": 30,
      +            "type": "number"
      +          },
      +          "name": {
      +            "example": "Open",
      +            "type": "string"
      +          },
      +          "oppositeName": {
      +            "example": "Opposite Name",
      +            "type": "string"
      +          },
      +          "parent": {
      +            "example": true,
      +            "type": "boolean"
      +          },
      +          "requiresSignatureForTestCaseExecution": {
      +            "example": true,
      +            "type": "boolean"
      +          },
      +          "templateWorkItem": {
      +            "example": "exampleTemplate",
      +            "type": "string"
      +          },
      +          "terminal": {
      +            "example": true,
      +            "type": "boolean"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "links": {
      +      "properties": {
      +        "first": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1",
      +          "type": "string"
      +        },
      +        "last": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9",
      +          "type": "string"
      +        },
      +        "next": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6",
      +          "type": "string"
      +        },
      +        "prev": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4",
      +          "type": "string"
      +        },
      +        "self": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "meta": {
      +      "properties": {
      +        "totalCount": {
      +          "format": "int32",
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  4. Changed4 schema fields changed
    • removedInput schema / properties / page_number
      Removed value: -{
      -  "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
      -  "format": "int32",
      -  "type": "number"
      -}
    • addedInput schema / properties / page_number_
      Added value: +{
      +  "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
      +  "format": "int32",
      +  "type": "number"
      +}
    • removedInput schema / properties / page_size
      Removed value: -{
      -  "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
      -  "format": "int32",
      -  "type": "number"
      -}
    • addedInput schema / properties / page_size_
      Added value: +{
      +  "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
      +  "format": "int32",
      +  "type": "number"
      +}
  5. First observedv1.0.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 and openWorldHint=true, so the safety profile is clear. The description adds useful behavioral context: it resolves to full option objects (ID, name, color/icon) and requires fieldId to be an enumeration-typed field. This goes beyond what annotations provide, though it doesn't cover error conditions or pagination details, which the schema partially addresses.

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?

The description is concise, with the core purpose front-loaded, followed by a constraint and an explicit alternative. Every sentence contributes value; there is no redundancy or filler.

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 tool's complexity (7 parameters, output schema, many siblings), the description is nearly complete. It covers the return behavior, the field-type requirement, and when to use it versus the alternative. It doesn't explicitly mention that it only applies to documents (not work items), but the name and context make that evident. The output schema handles return format details, so no further explanation is needed.

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 100%, so the baseline is 3. The description does not add material parameter semantics beyond the schema. It does reiterate that fieldId must be enumeration-typed, but that is already stated in the schema's fieldId description. No extra insight into parameter usage is provided.

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 states a specific action ('Returns'), the exact resource (enumeration options in one field of one Document), and clarifies the key distinction that it resolves to full option objects rather than bare stored IDs. It explicitly mentions the field type requirement and names a sibling tool (getAvailableEnumOptionsForDocument) to differentiate itself, which makes the purpose 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?

It gives explicit guidance: 'Use it to display or compare the current value; for the options you could switch to use getAvailableEnumOptionsForDocument.' This directly tells the agent when to use this tool and when to use the alternative, leaving no room for guesswork.

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

Deploy Server

Other Tools