Skip to main content
Glama

getGlobalEnumerations

Read-only

Retrieve global enumerations across every project when you need cross-project configuration values; supports paging, sparse fields, and concise/detailed responses.

Instructions

Returns a list of Enumerations from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumerations instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getGlobalEnumeration instead.

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.
max_itemsNoCollect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
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.
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
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. Changed2 schema fields changedv1.4.0
    • 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"
      +}
  2. Changed95 schema fields changedv1.3.1
    • removedOutput schema / properties / data / items / properties / attributes / properties / enumContext / example
      Removed value: -"id"
    • changedOutput schema / properties / data / items / properties / attributes / properties / enumContext / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / enumName / example
      Removed value: -"id"
    • changedOutput schema / properties / data / items / properties / attributes / properties / enumName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / color / example
      Removed value: -"#F9FF4D"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / color / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / columnWidth / example
      Removed value: -"90%"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / columnWidth / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / createDefect / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / createDefect / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / default / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / default / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / description / example
      Removed value: -"Description"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / description / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / hidden / example
      Removed value: -false
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / hidden / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / iconURL / example
      Removed value: -"/polarion/icons/default/enums/status_open.gif"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / iconURL / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / id / example
      Removed value: -"open"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / limited / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / limited / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / linkRules / items / properties / fromTypes / example
      Removed value: -[
      -  "requirement"
      -]
    • changedOutput schema / properties / data / items / 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 / items / properties / attributes / properties / options / items / properties / linkRules / items / properties / fromTypes / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / linkRules / items / properties / sameType / example
      Removed value: -false
    • changedOutput schema / properties / data / items / 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 / items / properties / attributes / properties / options / items / properties / linkRules / items / properties / toTypes / example
      Removed value: -[
      -  "requirement"
      -]
    • changedOutput schema / properties / data / items / 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 / items / properties / attributes / properties / options / items / properties / linkRules / items / properties / toTypes / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / linkRules / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / linkRules / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / minValue / example
      Removed value: -30
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / minValue / type
      Previous value: -"number"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / name / example
      Removed value: -"Open"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / name / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / oppositeName / example
      Removed value: -"Opposite Name"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / oppositeName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / parent / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / parent / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / requiresSignatureForTestCaseExecution / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / requiresSignatureForTestCaseExecution / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / templateWorkItem / example
      Removed value: -"exampleTemplate"
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / templateWorkItem / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / terminal / example
      Removed value: -true
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / properties / terminal / type
      Previous value: -"boolean"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / attributes / properties / options / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / targetType / example
      Removed value: -"id"
    • changedOutput schema / properties / data / items / properties / attributes / properties / targetType / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / attributes / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / id / example
      Removed value: -"~/status/~"
    • changedOutput schema / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / links / properties / self / example
      Removed value: -"server-host-name/application-path/enumerations/%7E/status/%7E"
    • changedOutput schema / properties / data / items / properties / links / properties / self / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / links / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / 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 / items / properties / meta / properties / errors / items / properties / detail / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / example
      Removed value: -"revision"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / example
      Removed value: -"$.data"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / example
      Removed value: -"MyProjectId/id"
    • changedOutput schema / properties / data / items / 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 / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / example
      Removed value: -"type"
    • changedOutput schema / properties / data / items / 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 / items / properties / meta / properties / errors / items / properties / source / properties / resource / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / example
      Removed value: -"400"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / example
      Removed value: -"Bad Request"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / data / items / properties / meta / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / type / enum
      Removed value: -[
      -  "enumerations"
      -]
    • changedOutput schema / properties / data / items / properties / type / type
      Previous value: -"string"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"
      +]
    • 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 / first / example
      Removed value: -"server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&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/enumerations/%7E/status?page%5Bsize%5D=10&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/enumerations/%7E/status?page%5Bsize%5D=10&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/enumerations/%7E/status?page%5Bsize%5D=10&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/enumerations/%7E/status?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"
      +]
  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 / 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."
  4. 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"
      +}
  5. Added

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 and openWorldHint=true, so the safety profile is covered. The description adds useful scope context (no project filter) and cardinality expectations (full collection or batch), which go beyond the annotations. It does not detail pagination behavior, but the schema and output schema handle that.

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 short sentences, front-loaded with scope, then cardinality, then sibling routing. Every sentence earns its place with no redundancy.

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 an output schema, rich annotations, and fully described parameters, the description supplies exactly the missing piece: scope and sibling routing. Nothing an agent needs to invoke this correctly is absent.

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 (fields, max_items, page_size_, page_number_, response_format) are fully documented by the schema. The description adds no parameter-level meaning beyond that, 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?

States a specific verb (Returns a list) plus the resource (Enumerations) and explicitly scopes it to the Global context spanning every project. It also names the two sibling tools it is not, so an agent can distinguish it from getProjectEnumerations and getGlobalEnumeration without opening a schema.

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?

Gives explicit routing rules: use getProjectEnumerations to act on a single project, use getGlobalEnumeration for a single item by ID, and this tool for the full collection or a batch. Both the when-to-use and the alternatives are spelled out.

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