Polarion MCP Server

getAvailableEnumOptionsForDocument

Read-only

Returns valid enumeration options for one field on an existing Polarion document, narrowed by document type, so you can choose a correct value before updating that field.

Instructions

Returns the enumeration options that may be set on one field of one existing Document (ID, name, color/icon), narrowed by that Document's type. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Call it before patchDocument to pick a valid value; for the value(s) currently set use getCurrentEnumerationOptionsForDocument, and for a Document that does not exist yet use getAvailableEnumOptionsForDocumentType.

Input Schema

Name	Required	Description	Default
`fieldId`	Yes	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.
`spaceId`	Yes	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.
`max_items`	No	Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
`projectId`	Yes	The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
`page_size_`	No	Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set.
`documentName`	Yes	The Document name.
`page_number_`	No	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.
`response_format`	No	Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.	detailed

Output Schema

Name	Required	Description	Default
`data`	No
`meta`	No
`links`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.4.4Oct 29, 2026

changedInput schema / properties / projectId / description

Previous 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."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access."

Changed2 schema fields changedv1.4.0Oct 24, 2026

addedInput schema / properties / max_items

Added value: +{
+  "description": "Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.",
+  "maximum": 1000,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / response_format

Added value: +{
+  "default": "detailed",
+  "description": "Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.",
+  "enum": [
+    "concise",
+    "detailed"
+  ],
+  "type": "string"
+}

Changed58 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / items / properties / color / example
```
Removed value: -"#F9FF4D"
```
- changedOutput schema / properties / data / items / properties / color / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / columnWidth / example
```
Removed value: -"90%"
```
- changedOutput schema / properties / data / items / properties / columnWidth / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / createDefect / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / createDefect / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / default / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / default / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / description / example
```
Removed value: -"Description"
```
- changedOutput schema / properties / data / items / properties / description / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / hidden / example
```
Removed value: -false
```
- changedOutput schema / properties / data / items / properties / hidden / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / iconURL / example
```
Removed value: -"/polarion/icons/default/enums/status_open.gif"
```
- changedOutput schema / properties / data / items / properties / iconURL / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / id / example
```
Removed value: -"open"
```
- changedOutput schema / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / limited / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / limited / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / linkRules / items / properties / fromTypes / example
```
Removed value: -[
-  "requirement"
-]
```
- changedOutput schema / properties / data / items / properties / linkRules / items / properties / fromTypes / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / linkRules / items / properties / fromTypes / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / linkRules / items / properties / sameType / example
```
Removed value: -false
```
- changedOutput schema / properties / data / items / properties / linkRules / items / properties / sameType / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / linkRules / items / properties / toTypes / example
```
Removed value: -[
-  "requirement"
-]
```
- changedOutput schema / properties / data / items / properties / linkRules / items / properties / toTypes / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / linkRules / items / properties / toTypes / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / linkRules / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / linkRules / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / minValue / example
```
Removed value: -30
```
- changedOutput schema / properties / data / items / properties / minValue / type
```
Previous value: -"number"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / name / example
```
Removed value: -"Open"
```
- changedOutput schema / properties / data / items / properties / name / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / oppositeName / example
```
Removed value: -"Opposite Name"
```
- changedOutput schema / properties / data / items / properties / oppositeName / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / parent / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / parent / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / requiresSignatureForTestCaseExecution / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / requiresSignatureForTestCaseExecution / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / templateWorkItem / example
```
Removed value: -"exampleTemplate"
```
- changedOutput schema / properties / data / items / properties / templateWorkItem / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / terminal / example
```
Removed value: -true
```
- changedOutput schema / properties / data / items / properties / terminal / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / first / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1"
```
- changedOutput schema / properties / links / properties / first / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / last / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9"
```
- changedOutput schema / properties / links / properties / last / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / next / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6"
```
- changedOutput schema / properties / links / properties / next / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / prev / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4"
```
- changedOutput schema / properties / links / properties / prev / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / self / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5"
```
- changedOutput schema / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / meta / properties / totalCount / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```

Changed1 schema field changedv1.2.2Sep 25, 2026

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

Changed4 schema fields changedv1.2.0Sep 17, 2026

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

Changed1 schema field changedv1.1.0Sep 11, 2026

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"
+}

Changed4 schema fields changedSep 7, 2026

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"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare read-only and open-world, so the safety profile is covered. The description adds that results are narrowed by the Document's type and that fieldId must be enumeration-typed, which goes beyond annotations. It does not cover error behavior or pagination semantics, so 4 rather than 5.

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 tightly written sentences, with the core behavior front-loaded before the alternatives. No repetition or filler.

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?

With an output schema, read-only annotations, and full parameter documentation, the description supplies everything an agent needs: purpose, precondition, alternatives, and the pre-patchDocument use case.

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 coverage is 100%, so the schema does the heavy lifting for all eight parameters. The description only reinforces the fieldId enumeration constraint, which is already in the schema, and does not add syntax/format detail beyond what the schema provides.

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?

States a specific verb ('Returns') and resource ('enumeration options ... for one field of one existing Document'), and distinguishes the existing-document variant from getAvailableEnumOptionsForDocumentType and the current-value variant getCurrentEnumerationOptionsForDocument.

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 'Call it before patchDocument to pick a valid value', names the alternative for current values (getCurrentEnumerationOptionsForDocument) and for a non-existent document (getAvailableEnumOptionsForDocumentType). The when-to-use and when-not-to-use conditions are fully stated.

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

Deploy Server