Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchRichPage

Idempotent

Updates a Rich Page's title and/or HTML content, changing only the attributes you send. Use it to edit page text or metadata; create pages with postPages and LiveDoc documents with patchDocument.

Instructions

Updates one Rich Page (wiki-style page): its title and/or its HTML homePageContent, sent as requestBody.data.attributes. Only the attributes you send are changed. Use it to edit page text or metadata; to create a page use postPages, and for LiveDoc Documents use patchDocument instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. 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.
requestBodyYesThe Page body.

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. 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."
    • 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 / 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 / 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."
  3. Changed3 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"
+}
    • addedInput schema / properties / requestBody / properties / data / properties / attributes / properties / homePageContent
      Added value: +{
+  "properties": {
+    "type": {
+      "enum": [
+        "text/html",
+        "text/plain"
+      ],
+      "type": "string"
+    },
+    "value": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
    • addedInput schema / properties / requestBody / properties / data / properties / relationships
      Added value: +{
+  "properties": {
+    "watches": {
+      "properties": {
+        "data": {
+          "items": {
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "type": {
+                "enum": [
+                  "users"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  4. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare idempotency, non-destructiveness and open-world access, so the bar is lower; the description still adds the key partial-update guarantee ('Only the attributes you send are changed') and explains what dry_run returns. It does not cover permission requirements or how watches relationships behave, which are the notable remaining gaps.

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?

Front-loaded purpose, then alternatives, then effect, then dry_run tip – a clean progression with little waste. Minor deductions for restating idempotency that annotations already declare and for the closing sentence about structured content, which is irrelevant since this tool has no output schema.

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?

For a 5-parameter nested mutation tool with full schema descriptions and annotations, the description supplies everything an agent needs: scope, alternative tools, partial-update semantics, idempotency, and a validation path. Remaining details (project/space/page identifiers) are adequately handled by schema descriptions.

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 the baseline is 3. The description adds meaning the schema does not spell out: it names the request path (requestBody.data.attributes) and ties it to the editable fields, which compensates for the vague 'The Page body' schema note.

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 ('Updates one Rich Page') and names the exact fields that can be changed (title, homePageContent). It also explicitly distinguishes itself from postPages (create) and patchDocument (LiveDoc Documents), so an agent can route 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?

Usage is explicitly scoped: edit page text or metadata here, create with postPages, use patchDocument for LiveDoc Documents. It even prescribes a workflow (dry_run first) with the condition for doing so.

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