Skip to main content
Glama

getGlobalEnumeration

Read-only

Retrieve a specific global enumeration by name, context, and target type across all Polarion projects. Use it for global values; choose project-scoped retrieval for one project.

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. Selection: Use getGlobalEnumeration for global enumeration values; use getProjectEnumeration for values configured in one project.

Input 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.
includeNoComma-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.
enumNameYesThe Enumeration Name.
targetTypeYesThe configured subtype for this enumeration or custom field (e.g. `requirement` for a Work Item type). Use `~` (without quotes) when the configuration applies to every subtype.
enumContextYesThe Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
response_formatNoResponse 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

NameRequiredDescriptionDefault
dataNo
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. Changed2 schema fields changedv1.4.0
    • 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"
      +}
    • changedInput schema / properties / targetType / description
      Previous value: -"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."New value: +"The configured subtype for this enumeration or custom field (e.g. `requirement` for a Work Item type). Use `~` (without quotes) when the configuration applies to every subtype."
  2. Changed83 schema fields changedv1.3.1
    • removedOutput schema / properties / data / properties / attributes / properties / enumContext / example
      Removed value: -"id"
    • changedOutput schema / properties / data / properties / attributes / properties / enumContext / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / enumName / example
      Removed value: -"id"
    • changedOutput schema / properties / data / properties / attributes / properties / enumName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / color / example
      Removed value: -"#F9FF4D"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / color / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / columnWidth / example
      Removed value: -"90%"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / columnWidth / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / createDefect / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / createDefect / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / default / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / default / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / description / example
      Removed value: -"Description"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / description / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / hidden / example
      Removed value: -false
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / hidden / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / iconURL / example
      Removed value: -"/polarion/icons/default/enums/status_open.gif"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / iconURL / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / id / example
      Removed value: -"open"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / limited / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / limited / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / fromTypes / example
      Removed value: -[
      -  "requirement"
      -]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / fromTypes / items / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / fromTypes / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / sameType / example
      Removed value: -false
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / sameType / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / toTypes / example
      Removed value: -[
      -  "requirement"
      -]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / toTypes / items / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / properties / toTypes / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / linkRules / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / minValue / example
      Removed value: -30
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / minValue / type
      Previous value: -"number"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / name / example
      Removed value: -"Open"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / name / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / oppositeName / example
      Removed value: -"Opposite Name"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / oppositeName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / parent / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / parent / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / requiresSignatureForTestCaseExecution / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / requiresSignatureForTestCaseExecution / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / templateWorkItem / example
      Removed value: -"exampleTemplate"
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / templateWorkItem / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / options / items / properties / terminal / example
      Removed value: -true
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / properties / terminal / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / properties / options / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / attributes / properties / targetType / example
      Removed value: -"id"
    • changedOutput schema / properties / data / properties / attributes / properties / targetType / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / attributes / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / id / example
      Removed value: -"~/status/~"
    • changedOutput schema / properties / data / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / links / properties / self / example
      Removed value: -"server-host-name/application-path/enumerations/%7E/status/%7E"
    • changedOutput schema / properties / data / properties / links / properties / self / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / links / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / detail / example
      Removed value: -"Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / detail / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / parameter / example
      Removed value: -"revision"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / parameter / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / pointer / example
      Removed value: -"$.data"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / pointer / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / example
      Removed value: -"MyProjectId/id"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / example
      Removed value: -"type"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / status / example
      Removed value: -"400"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / status / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / title / example
      Removed value: -"Bad Request"
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / title / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / meta / properties / errors / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / meta / properties / errors / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / meta / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / type / enum
      Removed value: -[
      -  "enumerations"
      -]
    • changedOutput schema / properties / data / properties / type / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / included / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / included / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / links / properties / self / example
      Removed value: -"server-host-name/application-path/enumerations/%7E/status/%7E"
    • 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"
      +]
  3. Changed3 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 / 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."
  4. Changed1 schema field changedv1.1.0
    • 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"
      +}
  5. Changed2 schema fields changed
    • 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."
  6. First observedv1.0.0

TDQS

A4.2/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 safety is covered; the description adds genuine context beyond that, namely that the scope spans every project with no project filter and that it targets a single item by ID. It omits anything about permissions or error behavior on an unknown name/context, which keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with scope and cardinality, but the closing 'Selection:' sentence largely restates the getProjectEnumeration contrast already made in sentence two, so not every sentence earns its place.

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?

An output schema exists and annotations cover the safety profile, so the description needn't explain return values. Scope, cardinality and sibling routing are all covered; only the absence of edge-case behavior (invalid enum name, context mismatch) keeps it short of complete.

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% and all six parameters (including enumName, targetType, enumContext, fields, include, response_format) are documented in the schema itself. The description adds no parameter-level detail such as the meaning of '~' or how fields/include interact with the enumeration, so baseline 3 applies.

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 (the specified Enumeration from the Global context) and explicitly distinguishes it from both siblings: getProjectEnumeration for single-project scope and getGlobalEnumerations for the full collection.

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?

Explicit when-to-use routing: 'To act on a single project, use getProjectEnumeration instead' and 'For the full collection or a batch, use getGlobalEnumerations instead.' The closing Selection sentence reinforces the global-vs-project choice, 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

Other Tools