Skip to main content
Glama
phillipboesger

Polarion MCP Server

getDocumentParts

Read-only

Retrieve document parts from a Polarion project and space, supporting pagination, field filtering, and specific revisions for targeted data extraction.

Instructions

Returns a list of Document Parts. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentPart instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoSparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set.
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.
spaceIdYesThe Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
revisionNoA 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.
projectIdYesThe Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs.
page_size_NoMaximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set.
documentNameYesThe Document name.
page_number_No1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
metaNo
linksNo
includedNoRelated entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 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 / 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 / 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."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "properties": {
      +          "attributes": {
      +            "properties": {
      +              "content": {
      +                "description": "Editable only for normal and table document parts.",
      +                "example": "<div id=\"polarion_wiki macro name=module-workitem;params=id=workitem_MyWorkItemId\"></div>",
      +                "type": "string"
      +              },
      +              "external": {
      +                "description": "Whether the work item is external to the document. Applicable to: workitem parts.",
      +                "type": "boolean"
      +              },
      +              "headingText": {
      +                "description": "Applicable to: heading parts.",
      +                "example": "Heading Title",
      +                "type": "string"
      +              },
      +              "id": {
      +                "example": "workitem_MyWorkItemId",
      +                "type": "string"
      +              },
      +              "landscape": {
      +                "description": "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts.",
      +                "type": "boolean"
      +              },
      +              "layout": {
      +                "description": "Rendering layout index for the part. Applicable to: workitem parts.",
      +                "example": 0,
      +                "format": "int32",
      +                "type": "integer"
      +              },
      +              "level": {
      +                "description": "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.",
      +                "example": 0,
      +                "format": "int32",
      +                "type": "integer"
      +              },
      +              "sequence": {
      +                "description": "Sequence identifier for table of figures entry. Applicable to: tof parts.",
      +                "example": "Table",
      +                "type": "string"
      +              },
      +              "type": {
      +                "description": "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.",
      +                "example": "workitem",
      +                "type": "string"
      +              },
      +              "wikiText": {
      +                "description": "Wiki markup content for the block. Applicable to: wikiblock parts.",
      +                "example": "#documentPanel(true \"approved\")",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "id": {
      +            "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
      +            "type": "string"
      +          },
      +          "links": {
      +            "properties": {
      +              "self": {
      +                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234",
      +                "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"
      +          },
      +          "relationships": {
      +            "properties": {
      +              "nextPart": {
      +                "properties": {
      +                  "data": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
      +                        "type": "string"
      +                      },
      +                      "revision": {
      +                        "example": "1234",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "document_parts"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "previousPart": {
      +                "properties": {
      +                  "data": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
      +                        "type": "string"
      +                      },
      +                      "revision": {
      +                        "example": "1234",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "document_parts"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "workItem": {
      +                "properties": {
      +                  "data": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyProjectId/MyWorkItemId",
      +                        "type": "string"
      +                      },
      +                      "revision": {
      +                        "example": "1234",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "workitems"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "revision": {
      +            "example": "1234",
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "document_parts"
      +            ],
      +            "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/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=1",
      +          "type": "string"
      +        },
      +        "last": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=9",
      +          "type": "string"
      +        },
      +        "next": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=6",
      +          "type": "string"
      +        },
      +        "prev": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=4",
      +          "type": "string"
      +        },
      +        "self": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=5",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "meta": {
      +      "properties": {
      +        "totalCount": {
      +          "format": "int32",
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed6 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."
    • removedInput schema / properties / page_number
      Removed value: -{
      -  "description": "Specify the page number to be returned. Counting starts from 1. 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.",
      -  "format": "int32",
      -  "type": "number"
      -}
    • addedInput schema / properties / page_number_
      Added value: +{
      +  "description": "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.",
      +  "format": "int32",
      +  "type": "number"
      +}
    • removedInput schema / properties / page_size
      Removed value: -{
      -  "description": "Limit the number of entities returned in a single response. 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.",
      -  "format": "int32",
      -  "type": "number"
      -}
    • addedInput schema / properties / page_size_
      Added value: +{
      +  "description": "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.",
      +  "format": "int32",
      +  "type": "number"
      +}
  4. First observedv1.0.0

TDQS

A4.3/5.0
Behavior3/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 elsewhere. The description adds the cardinality scoping ('full collection or a batch') but does not disclose pagination behavior or other runtime characteristics; given the annotations and output schema, this is adequate but not extensive.

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 two sentences with no filler. It front-loads the main action and cardinality, then immediately gives the sibling alternative, making it easy to parse in one read.

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 the read-only annotations, a rich output schema, and a fully self-describing input schema, the description covers the key decision an agent needs: when to use this tool versus `getDocumentPart`. Nothing critical is missing for correct invocation.

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 every parameter already has a meaningful description in the schema. The tool description adds no parameter-level semantics, so the baseline of 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?

The description states a specific verb ('Returns') and resource ('list of Document Parts') and clarifies cardinality: full collection or batch, not a single item. It explicitly distinguishes itself from the sibling tool `getDocumentPart`, so an agent can tell them apart immediately.

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: target the full collection or a batch. It also names the alternative `getDocumentPart` for the single-item case, making the decision between the two tools unambiguous.

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