Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchDocument

Idempotent

Update Polarion documents by modifying content, title, status, or layout, and trigger workflow actions. Preview the exact request with dry_run before applying changes.

Instructions

Updates the specified Document. Effect: not guaranteed idempotent — this call can trigger a workflow action, and re-running a workflow action from a different resulting status has real additional side effects (status change, signatures, notifications). Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Input Schema

TableJSON 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.
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.
requestBodyYesThe Document body.
documentNameYesThe Document name.
workflowActionNoThe Workflow Action.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 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 / 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."
  2. Changed1 schema field 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"
+}
  3. First observedv1.0.0

TDQS

A3.5/5.0
Behavior1/5

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

The description explicitly states 'Effect: not guaranteed idempotent' and details side effects of re-running workflow actions. However, the annotations declare 'idempotentHint': true, which directly contradicts this. This is a serious inconsistency that could mislead an agent about the tool's behavior. The description contradicts the annotation, so this dimension fails.

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 moderately long but each sentence serves a purpose: the purpose, the non-idempotency warning, the dry-run tip, and the error-flag explanation. It is front-loaded with the core purpose and effectively structured. No fluff, though it could be slightly tighter.

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?

For a mutation tool with no output schema, the description covers the essential context: it explains side effects, suggests a safe preview, and clarifies an error-flag quirk. It doesn't detail the exact response on success, but that is not required. Given the complexity and the absence of an output schema, this is reasonably 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 coverage is 100%, so the schema already documents all parameters. The description adds marginal value by explaining the dry_run behavior (returns error-flagged preview), but this is more about output than parameter semantics. The baseline of 3 is appropriate given the high schema coverage; the description doesn't compensate for any gaps because there are none.

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 opens with a specific verb and resource: 'Updates the specified Document.' This clearly states the action and target, and the mention of triggering workflow actions adds specific behavioral detail that distinguishes it from generic update tools. While it doesn't name sibling alternatives, the purpose is unambiguous.

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

Usage Guidelines4/5

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

The description provides a concrete usage tip: 'set dry_run: true first to preview the exact request Polarion would receive, without changing anything.' This gives a safe-practice guideline and implies when to use this tool carefully. It doesn't explicitly exclude alternatives, but the dry-run advice is actionable and contextually relevant.

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