Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getMetadata

Read-only

Retrieve global metadata including version, build, and REST API configuration properties to understand the current server environment.

Instructions

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

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.
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.

Output Schema

TableJSON 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.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."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "apiProperties": {
+              "properties": {
+                "bodySizeLimit": {
+                  "example": 2097152,
+                  "type": "integer"
+                },
+                "defaultPageSize": {
+                  "example": 100,
+                  "type": "integer"
+                },
+                "maxIncludedSize": {
+                  "example": 500,
+                  "type": "integer"
+                },
+                "maxPageSize": {
+                  "example": 200,
+                  "type": "integer"
+                },
+                "maxRelationshipSize": {
+                  "example": 100,
+                  "type": "integer"
+                }
+              },
+              "type": "object"
+            },
+            "build": {
+              "example": "20250613-1404-master-e594c717",
+              "type": "string"
+            },
+            "cluster": {
+              "example": "cluster1",
+              "type": "string"
+            },
+            "logoUrl": {
+              "example": "/images/logos/repo_login_logo.png",
+              "type": "string"
+            },
+            "node": {
+              "example": "node2",
+              "type": "string"
+            },
+            "timezone": {
+              "example": "+05:30",
+              "type": "string"
+            },
+            "version": {
+              "example": "3.25.12",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "metadata",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/metadata",
+              "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": [
+            "metadata"
+          ],
+          "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/metadata",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  3. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already cover readOnlyHint and openWorldHint, so the safety profile is established. The description adds a useful access detail ('Available to all REST API users'), but otherwise does not disclose additional behavioral traits such as response size, pagination, or side effects. With annotations present, this is adequate but not rich.

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

Conciseness4/5

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

The description is short and front-loaded with the core purpose, followed by a useful access note. The only minor flaw is the vague 'etc.', which slightly reduces precision, but overall the description is efficient and well-structured.

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?

Given that annotations cover safety, the input schema fully documents parameters, and an output schema exists, the description does not need to explain return values or parameter mechanics. It provides enough context about the tool's scope and accessibility for an agent to invoke it 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%, and the schema provides detailed descriptions for both fields and include. The tool description itself adds no parameter-level meaning, but it is not required to compensate because the schema already carries that burden. 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 names a specific verb and resource: 'Returns global metadata' and gives concrete content examples such as version, build, and REST API configuration properties. These examples clearly distinguish it from similar sibling getters like getGlobalFieldsMetadata or getGlobalEnumerations, which target narrower metadata domains.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no guidance about when to prefer this tool over alternatives. It does not mention related siblings such as getGlobalFieldsMetadata or getGlobalEnumerations, nor does it state any selection criteria beyond the tautological need for global metadata. 'Available to all REST API users' is an access note, not a usage-vs-alternative guideline.

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