Skip to main content
Glama
phillipboesger

Polarion MCP Server

getProjectEnumerations

Read-only

Fetch all enumerations from a single Polarion project using its project ID. Returns a paginated, field-selectable list to manage project-specific enum values.

Instructions

Returns a list of Enumerations from the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalEnumerations instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getProjectEnumeration instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoSparse 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.
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
includedNoRelated 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.

  1. Changed4 schema fields changedv1.2.0
    • 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 / 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."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "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"
      +      },
      +      "type": "array"
      +    },
      +    "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": {
      +        "first": {
      +          "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=1",
      +          "type": "string"
      +        },
      +        "last": {
      +          "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=9",
      +          "type": "string"
      +        },
      +        "next": {
      +          "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=6",
      +          "type": "string"
      +        },
      +        "prev": {
      +          "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=4",
      +          "type": "string"
      +        },
      +        "self": {
      +          "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=5",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "meta": {
      +      "properties": {
      +        "totalCount": {
      +          "format": "int32",
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=true, so the read-only nature is covered. The description adds scoping (one project) and cardinality (full collection or batch), which are useful behavioral details beyond the annotations. It does not contradict annotations and adds meaningful context, though it stops short of disclosing error conditions or rate limits, which are not expected here.

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?

Three sentences, each earning its place: the main purpose, the scope requirement, and two explicit alternatives. The most critical info (what it returns) is front-loaded, and there is zero waste.

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?

With an output schema present and parameters fully documented, the description covers the essentials: scope, cardinality, and alternatives. It doesn't need to explain return values. It could mention the meaning of 'batch' more explicitly, but for a list operation this is sufficient for an agent to decide and invoke correctly.

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 parameters are well-documented in the schema. The description mentions 'requires a project ID' but that is already in the schema. It adds no extra semantics beyond what the schema provides, so the baseline of 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 clearly states what the tool does: returns a list of Enumerations from the Project context. It also distinguishes itself from getGlobalEnumerations (across all projects) and getProjectEnumeration (single item), making it unambiguous which sibling it complements.

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 states when to use this tool vs alternatives: 'To act across all projects, use getGlobalEnumerations instead' and 'For a single item by ID, use getProjectEnumeration instead.' Also notes the requirement of a project ID, giving clear context for invocation.

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