Polarion MCP Server

getPageRelationships

Read-only

Retrieves the linked resource identifiers (type and ID) for a specified relationship on a Rich Page, enabling quick inspection of a single relationship without loading full related resources.

Instructions

Returns the resource identifiers linked from one Rich Page through a single named relationship, as JSON:API linkage ({type, id} entries) without the related resources' attributes. relationshipId is the relationship's name, not an entry ID. Use this to inspect one relationship cheaply; to read the Rich Page with its related resources embedded, call its get tool with include instead. To change the relationship, use postPageRelationships (add), patchPageRelationships (replace), or deletePageRelationships (remove).

Input Schema

TableJSON Schema

Name	Required	Description
`fields`	No	Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set.
`include`	No	Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource.
`spaceId`	Yes	The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
`pageName`	Yes	The Rich Page's ID/name within its space — its stable identifier, not its display title.
`revision`	No	A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision.
`projectId`	Yes	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.
`page_size_`	No	Maximum 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_`	No	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.
`relationshipId`	Yes	The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.2.2Sep 25, 2026

changedInput schema / properties / relationshipId / description

Previous value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."

Changed9 schema fields changedv1.2.0Sep 17, 2026

changedInput schema / properties / fields / description

Previous value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set."

changedInput schema / properties / include / description

Previous value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."

changedInput schema / properties / pageName / description

Previous value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title."

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

changedInput schema / properties / relationshipId / description

Previous value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."

changedInput schema / properties / revision / description

Previous value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."

changedInput schema / properties / spaceId / description

Previous value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "description": "The Relationship's response body. Can return a single or a list of instances",
+  "example": {
+    "data": [
+      {
+        "id": "MyProjectId/WI-123",
+        "type": "workitems"
+      }
+    ]
+  },
+  "oneOf": [
+    {
+      "properties": {
+        "data": {
+          "properties": {
+            "id": {
+              "example": "MyResourceId",
+              "type": "string"
+            },
+            "type": {
+              "enum": [
+                "collections",
+                "categories",
+                "documents",
+                "document_attachments",
+                "document_comments",
+                "document_parts",
+                "enumerations",
+                "globalroles",
+                "icons",
+                "jobs",
+                "linkedworkitems",
+                "externallylinkedworkitems",
+                "linkedoslcresources",
+                "llms",
+                "pages",
+                "page_attachments",
+                "page_comments",
+                "plans",
+                "projectroles",
+                "projectgroups",
+                "projects",
+                "projecttemplates",
+                "spaces",
+                "testparameters",
+                "testparameter_definitions",
+                "testrecords",
+                "teststep_results",
+                "testruns",
+                "testrun_attachments",
+                "teststepresult_attachments",
+                "testrun_comments",
+                "usergroups",
+                "users",
+                "workitems",
+                "workitem_attachments",
+                "workitem_approvals",
+                "workitem_comments",
+                "featureselections",
+                "teststeps",
+                "workrecords",
+                "revisions",
+                "testrecord_attachments",
+                "license_slots",
+                "license_types",
+                "license",
+                "metadata",
+                "license_assignments",
+                "customfields"
+              ],
+              "type": "string"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    {
+      "properties": {
+        "data": {
+          "items": {
+            "properties": {
+              "id": {
+                "example": "MyResourceId",
+                "type": "string"
+              },
+              "type": {
+                "enum": [
+                  "collections",
+                  "categories",
+                  "documents",
+                  "document_attachments",
+                  "document_comments",
+                  "document_parts",
+                  "enumerations",
+                  "globalroles",
+                  "icons",
+                  "jobs",
+                  "linkedworkitems",
+                  "externallylinkedworkitems",
+                  "linkedoslcresources",
+                  "llms",
+                  "pages",
+                  "page_attachments",
+                  "page_comments",
+                  "plans",
+                  "projectroles",
+                  "projectgroups",
+                  "projects",
+                  "projecttemplates",
+                  "spaces",
+                  "testparameters",
+                  "testparameter_definitions",
+                  "testrecords",
+                  "teststep_results",
+                  "testruns",
+                  "testrun_attachments",
+                  "teststepresult_attachments",
+                  "testrun_comments",
+                  "usergroups",
+                  "users",
+                  "workitems",
+                  "workitem_attachments",
+                  "workitem_approvals",
+                  "workitem_comments",
+                  "featureselections",
+                  "teststeps",
+                  "workrecords",
+                  "revisions",
+                  "testrecord_attachments",
+                  "license_slots",
+                  "license_types",
+                  "license",
+                  "metadata",
+                  "license_assignments",
+                  "customfields"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    }
+  ],
+  "type": "object"
+}

AddedSep 7, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds useful behavioral context: it returns only linkage identifiers rather than full related resources, it is a cheap inspection, and it operates on a single named relationship. It does not cover every edge behavior, but it meaningfully augments the annotations without contradicting them.

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?

The description is compact and front-loaded: it opens with the core behavior and output format, then clarifies the key parameter ambiguity, and closes with usage routing. Every sentence earns its place and no filler is present.

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 9 parameters with full schema descriptions and an output schema, the tool description covers what an agent needs to select and invoke it correctly: purpose, output semantics, parameter caveat, and alternatives. Pagination and field filtering are already documented in the input schema, so the description is adequately 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%, so the baseline is 3. The description's clarification that `relationshipId` is the relationship's name, not an entry ID, is helpful but the schema already states the same thing explicitly. No additional parameter meaning is added beyond what the input schema provides.

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 states a specific verb ('Returns'), resource ('one Rich Page'), and precise output shape ('JSON:API linkage (`{type, id}` entries) without the related resources' attributes'). It also distinguishes itself from getPage and the relationship-mutating siblings by naming them explicitly.

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

Usage Guidelines5/5

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

It gives explicit when-to-use guidance ('inspect one relationship cheaply') and contrasts with the alternative ('call its get tool with `include` instead'). It even names the exact mutating tools for add, replace, and remove operations, leaving no ambiguity about when to choose this getter.

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

Deploy Server