Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchWorkItemApprovals

Idempotent

Update multiple work item approval statuses in Polarion in one batch. Use dry run to preview changes before applying.

Instructions

Updates a list of instances. Cardinality: targets the full collection or a batch. For a single item by ID, use patchWorkItemApproval 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 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.
requestBodyYesThe Test Run(s) body.

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

A4.1/5.0
Behavior4/5

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

Annotations already include idempotentHint=truecars, but the description explains the idempotent effect in concrete terms ('leaves the resource in the same end state, with no additional side effects'). It also discloses the dry_run preview behavior and the error-flagged result quirk for typed output schemas. This adds real behavioral context beyond the structured hints, though it does not mention authentication or reversibility.

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 a bit wordy but well-structured into sections (what, cardinality, alternative, effect, tip). Each sentence contributes unique information; the error-flagged preview note is detailed but useful. It could be tightened, but it is not padded.

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 non-read-only tool with no output schema)Skip, it covers the essential aspects: scope (batch/full collection), idempotency, the dry_run preview, and routing to the single-item sibling. It does not explain return values or error conditions, but the absence of an output schema plus the tipping behavior lessens that need. The guidance to read the text content on error-flagged results partially compensates for missing output documentation.

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% for all four parameters, so the schema already documents projectId, workItemId, requestBody, and dry_run. The description adds value only by referencing dry_run in the tip, which reinforces but does not extend the schema. Since the schema carries the full semantic burden, a baseline of 3 is appropriate.

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 specific verb ('Updates') and a resource ('a list of instances'), but 'instances' is vague and never explicitly identifies them as work item approvals. It does differentiate from the sibling tool `patchWorkItemApproval` by cardinality (list vs. single item), which helps an agent distinguish them. The name itself carries the missing specificity, but the description should have mentioned 'approvals' explicitly.

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 names the alternative (`patchWorkItemApproval`) and the exact condition for choosing it: 'For a single item by ID'. Also states the cardinality options ('full collection or a batch'), which clarifies when to use this tool. The dry_run tip adds practical guidance for safe previewing, giving an agent actionable context.

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