Polarion MCP Server

getGlobalEnumeration

Read-only

Retrieves a named enumeration from Polarion's global context, spanning all projects. Use it to fetch one global enum by name/target type without extracting the full collection.

Instructions

Returns the specified Enumeration from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumeration instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getGlobalEnumerations instead.

Input Schema

TableJSON Schema

Name	Required	Description
`fields`	No	Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set.
`include`	No	Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource.
`enumName`	Yes	The Enumeration Name.
`targetType`	Yes	Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type.
`enumContext`	Yes	The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)

Output Schema

TableJSON Schema

Name	Required	Description
`data`	No
`links`	No
`included`	No	Related entities might be returned, 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>.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv1.2.0Sep 17, 2026

changedInput schema / properties / fields / description

Previous value: -"Filter returned resource fields. 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: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set."

changedInput schema / properties / include / description

Previous value: -"Include related entities. 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: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."

changedInput schema / properties / targetType / description

Previous value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "enumContext": {
+              "example": "id",
+              "type": "string"
+            },
+            "enumName": {
+              "example": "id",
+              "type": "string"
+            },
+            "options": {
+              "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"
+            },
+            "targetType": {
+              "example": "id",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "~/status/~",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/enumerations/%7E/status/%7E",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "meta": {
+          "properties": {
+            "errors": {
+              "items": {
+                "properties": {
+                  "detail": {
+                    "description": "Human-readable explanation specific to this occurrence of the problem.",
+                    "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)",
+                    "type": "string"
+                  },
+                  "source": {
+                    "properties": {
+                      "parameter": {
+                        "description": "String indicating which URI query parameter caused the error.",
+                        "example": "revision",
+                        "type": "string"
+                      },
+                      "pointer": {
+                        "description": "JSON Pointer to the associated entity in the request document.",
+                        "example": "$.data",
+                        "type": "string"
+                      },
+                      "resource": {
+                        "description": "Resource causing the error.",
+                        "properties": {
+                          "id": {
+                            "example": "MyProjectId/id",
+                            "type": "string"
+                          },
+                          "type": {
+                            "example": "type",
+                            "type": "string"
+                          }
+                        },
+                        "type": "object"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "status": {
+                    "description": "HTTP status code applicable to this problem.",
+                    "example": "400",
+                    "type": "string"
+                  },
+                  "title": {
+                    "description": "Short, human-readable summary of the problem.",
+                    "example": "Bad Request",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "enum": [
+            "enumerations"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "included": {
+      "description": "Related entities might be returned, 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>.",
+      "items": {
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "links": {
+      "properties": {
+        "self": {
+          "example": "server-host-name/application-path/enumerations/%7E/status/%7E",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

Changed2 schema fields changedSep 7, 2026

changedInput schema / properties / fields / description

Previous value: -"Filter returned resource fields. 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."New value: +"Filter returned resource fields. 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."

changedInput schema / properties / include / description

Previous value: -"Include related entities. 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."New value: +"Include related entities. 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."

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 readOnlyHint=true, so the agent knows this is a safe read operation. The description adds useful behavioral context by specifying the global scope and single-item cardinality, which are not in the annotations. It doesn't discuss errors or auth, but for a read-only get with an output schema, this is sufficient. It does not contradict the 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?

Two sentences with zero waste. The primary action and scope are front-loaded, and the alternative routing is stated compactly. Every sentence earns its place, and there is no redundant 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 output schema exists, return values are covered. The description provides the essential context: scope, cardinality, and sibling differentiation. All parameters are documented in the schema. There is nothing an agent needs to call this tool correctly that is missing.

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 all five parameters are documented in the input schema. The description adds the context that this targets a global enumeration rather than a project one, which helps interpret enumContext, but the schema already explains allowed values (including '~' for global). The description does not add syntax or format details beyond the schema, so the baseline 3 is appropriate.

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 opens with a specific verb and resource ('Returns the specified Enumeration from the Global context'), then immediately clarifies scope (global, no project filter) and cardinality (single item by ID). It explicitly differentiates from two sibling tools by name (getProjectEnumeration and getGlobalEnumerations), so an agent can tell them apart without inspecting 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?

It gives explicit when-to-use and when-not-to-use guidance: 'To act on a single project, use getProjectEnumeration instead' and 'For the full collection or a batch, use getGlobalEnumerations instead'. This directly routes the agent to the correct alternative based on context, leaving nothing to inference.

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

Deploy Server