Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

moveToDocument

Move a Polarion Work Item into a specified document by providing project ID, work item ID, and target document details. Preview with dry_run before applying.

Instructions

Moves the specified Work Item to the Document. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. 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.
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.
workItemIdYesThe Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads.
requestBodyYesMoving Work Item to Document parameters.

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 / workItemId / description
      Previous value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
  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.7/5.0
Behavior5/5

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

Annotations already include idempotentHint=false tolerant, but the description goes further: it explains the server-side action nature, cautions that repeats may be safe, no-ops, or rejected, and advises using dry_run. It also discloses the error-flagged preview behavior, which is exactly the kind of context that helps an agent handle this tool correctly. No contradiction exists.

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 compact and front-loaded with the core purpose. Each sentence serves a purpose. The final sentence about typed output schemas is conditional and not directly applicable to this tool (which has no output schema), making it slightly tangential, but it is still relevant for understanding dry_run behavior across tools.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a nested requestBody (nextPart, previousPart, targetDocument) and no output schema, the description does not fully explain what 'the Document' refers to or how the nested fields affect the move. The dry_run tip provides a safety net, but the overall operation remains somewhat opaque. The description is a minimum-viable definition rather than a fully self-contained one.

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 description coverage is 100%, so a baseline of 3 is warranted. The description adds value beyond the schema by explaining the significance of dry_run: previewing the exact request without side effects, and how to interpret the error-flagged result. It does not add anything about projectId or workItemId, but the schema descriptions for those are already strong.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb and resource: 'Moves the specified Work Item to the Document.' It is unambiguous about the primary action, but it does not explicitly differentiate itself from the sibling tool moveWorkItemsToDocument (which handles plural work items) or moveDocumentParts. The lack of sibling differentiation keeps it from a perfect score.

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

Usage Guidelines2/5

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

There is no explicit guidance on when to use this tool versus alternatives. The description mentions the dry_run tip and non-idempotency, but does not state conditions like 'for multiple work items use moveWorkItemsToDocument' or note any prerequisites. An agent must infer usage from the name and schema, leaving clear gaps.

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