Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

postPageAttachments

Upload one or more new files as attachments to a Rich Page in a single multipart request and return the created attachment IDs.

Instructions

Uploads one or more new files as attachments of a Rich Page in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchPageAttachment, and to list what is already attached use getPageAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Input Schema

NameRequiredDescriptionDefault
dry_runNoIf true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it.
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.
pageNameYesThe Rich Page's ID/name within its space — its stable identifier, not its display title.
projectIdYesThe Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
requestBodyYesAttachment metadata and file data.

Output Schema

NameRequiredDescriptionDefault
dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.4
    • changedInput schema / properties / projectId / description
      Previous 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."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access."
  2. Changed11 schema fields changedv1.3.1
    • removedOutput schema / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
    • 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 / content / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234"
    • changedOutput schema / properties / data / items / properties / links / properties / content / 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/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234"
    • 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 / type / enum
      Removed value: -[
-  "page_attachments"
-]
    • 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"
+]
  3. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / dry_run / description
      Previous value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
    • addedInput schema / properties / pageName / description
      Added value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title."
    • addedInput schema / properties / projectId / description
      Added 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."
    • addedInput schema / properties / spaceId / description
      Added 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."
  4. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "id": {
+            "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "content": {
+                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234",
+                "type": "string"
+              },
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": {
+            "enum": [
+              "page_attachments"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  5. Changed2 schema fields changed
    • addedInput schema / properties / dry_run
      Added value: +{
+  "description": "If true, validate and return the request that would be sent without calling Polarion.",
+  "type": "boolean"
+}
    • changedInput schema / properties / requestBody / description
      Previous value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
  6. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

The description spells out the multipart payload layout, that a request can carry multiple files in one call, and warns in plain language that repeating the call may create duplicate resources rather than deduplicating. That plain-language warning largely restates `idempotentHint: false` and 'creates a new resource' restates `readOnlyHint: false`, so it adds clarity rather than new information; nothing here about permissions or size limits.

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?

Core behavior and the payload contract are front-loaded in the first two sentences, and the alternatives follow logically. The trailing sentence about the executor returning the preview as text and structured content is generic boilerplate that does not help an agent decide or call the tool.

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?

Covers what the tool creates, how the multipart body must be assembled, what comes back (created attachment IDs), and how to validate first. With an output schema declaring the return shape and annotations covering the safety profile, no gap remains that would cause a mis-call.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so `dry_run`, `projectId`, `spaceId` and `pageName` are already well documented. The description earns extra credit by unpacking the opaque `requestBody` string parameter, which the schema describes only as 'Attachment metadata and file data' — it specifies the `resource.data` metadata entries (`fileName`, optional `title`) and the index-aligned `files` array of base64 bytes, which is essential to forming a valid request.

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 and resource — uploads one or more new files as attachments of a Rich Page — and names the sibling operations for the adjacent cases (`patchPageAttachment`, `getPageAttachments`). An agent can distinguish this from `postDocumentItemAttachments` and `upload_attachment` on the basis of the Rich Page target 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?

Explicitly says when to use this tool ('use this to add files') and routes away to the two named alternatives with the condition that selects each ('to change an existing attachment', 'to list what is already attached'). The `dry_run: true` recommendation gives a concrete safe-call procedure before committing.

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