Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchLinkedWorkItem

Idempotent

Update direct outgoing work item links in Polarion. Supports dry-run preview and idempotent updates.

Instructions

Updates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. 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
roleIdYesThe Role ID.
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 Linked Work Item(s) body.
targetProjectIdYesThe Target Project ID.
linkedWorkItemIdYesThe Linked Work Item ID.

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.9/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, readOnlyHint=false, and destructiveHint=false. The description adds value by explaining the idempotent effect in plain language ('calling it again with the same input leaves the resource in the same end state') and by detailing the dry_run behavior, including that the preview is returned as an error-flagged result on typed output schemas. This goes beyond the annotations, though it doesn't cover every behavioral aspect (e.g., permission requirements).

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, then scope exclusions, then idempotency, then the dry_run tip. Every sentence adds information. It's slightly dense with the parenthetical about error-flagged results, but that's necessary context for the dry_run behavior.

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 7 parameters and no output schema, the description covers the key operational concerns: what is updated, what is not, idempotency, and how to preview safely. It doesn't explain return values, but with no output schema and a clear idempotent update operation, that's a minor gap. The dry_run tip partially compensates for the missing output schema.

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%, so the schema already documents all 7 parameters. The description adds some context for workItemId ('not the combined project/id path used in some link payloads') and explains dry_run's behavior, but most parameter meaning is already in the schema. Baseline 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 and resource: 'Updates the direct outgoing links to other Work Items.' It also clarifies scope by excluding external links and backlinks, which helps distinguish it from sibling tools like postLinkedWorkItems, deleteLinkedWorkItems, and getWorkItemsRelationships. However, it doesn't explicitly name a sibling alternative, so it falls just short of a 5.

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 gives clear context: it updates direct outgoing links, not external links or backlinks, and it is idempotent. It also provides a practical tip to use dry_run: true to preview the request. However, it doesn't explicitly state when to prefer this over alternatives like postLinkedWorkItems or patchWorkItemRelationships, so usage guidance is good but not fully explicit.

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