Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getAvailableEnumOptionsForWorkItemType

Read-only

Fetch allowed enum values for a specified field and work item type to validate inputs before creating Polarion work items.

Instructions

Returns the enumeration options that may be set on one field for a Work Item type (e.g. type=requirement), before any concrete item exists. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Pass type=~ for options that apply regardless of type. Call it before postWorkItems to choose valid values; for an existing item use getAvailableEnumOptionsForWorkItem, which also applies that item's dependent enumerations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNoThe Type of the object. Use '~' without quotes to represent no target Type.
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.
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.
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. Changed3 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."
  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. Changed5 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"
+}
    • changedInput schema / properties / type / description
      Previous value: -"The Type of the object."New value: +"The Type of the object. Use '~' without quotes to represent no target Type."
  5. First observedv1.0.0

TDQS

A4.7/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 read-only nature is handled. The description adds meaningful behavioral context beyond that: it requires `fieldId` to be an enumeration-typed field, clarifies that the call is valid before an item exists, and explains that the sibling applies dependent enumerations. It does not contradict the annotations, and the added constraints help an agent use it correctly.

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 three sentences, each earning its place: the first states the core purpose and scope, the second states a key constraint on `fieldId`, and the third gives usage timing plus the alternative. It is front-loaded and contains no 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?

Given the tool has a full parameter schema with 100% description coverage, an output schema, and read-only annotations, the description fills the remaining gaps: the pre-item usage context, the enum-field prerequisite, and the sibling for existing items. An agent has everything needed to invoke it correctly.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by illustrating `type=requirement`, explaining the `type=~` special value in context, and emphasizing the enum-typed precondition for `fieldId`. This goes beyond simply restating parameter descriptions.

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 verb ('Returns') and resource ('enumeration options... for a Work Item type'), and qualifies the scope with 'before any concrete item exists'. It explicitly distinguishes itself from the sibling `getAvailableEnumOptionsForWorkItem` by noting that the sibling applies to existing items, so an agent can select the correct tool without opening schemas.

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?

The description gives explicit when-to-use guidance: 'Call it before postWorkItems to choose valid values'. It also provides a clear exclusion, directing users with an existing item to `getAvailableEnumOptionsForWorkItem`, and explains the special `type=~` value for type-independent options. This is unambiguous and actionable.

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