Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchUser

Idempotent

Update a Polarion user's profile attributes from a JSON:API request body; validate changes first with dry_run before applying them.

Instructions

Updates profile attributes for one user from the supplied JSON:API request body. Requires permission to edit that user; use getUser to inspect the profile and updateAvatar for the image. 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
userIdYesThe User 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.
requestBodyYesThe User body.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  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.4/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, so the sentence restating idempotency adds little new. The description does add real value beyond annotations: the required edit permission, and concrete dry-run behavior (validates, previews the exact Polarion request, returns text plus structured content when an output schema exists). It does not state whether omitted attributes are left untouched or cleared, which matters for a PATCH-style update.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four sentences, front-loaded with the action, then permissions/alternatives, then effect, then the dry-run tip. Only mild redundancy is the idempotency sentence that echoes the annotation.

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?

Covers the mutation's safety profile (idempotent, non-destructive via annotations), permission requirement, sibling routing and a validation path, which is solid for a 3-param nested-schema tool with no output schema. The remaining gap is partial-update semantics for the nested JSON:API body, which the description leaves implicit.

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 userId, dry_run and the nested requestBody are documented structurally. The description's dry-run pointer duplicates the schema's own dry_run description and adds no guidance on which attributes or relationships can be safely omitted; baseline 3 applies.

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 profile attributes for one user') plus the input form (JSON:API request body), which immediately separates it from getUser (read) and updateAvatar (image). An agent can identify the operation without opening the 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?

Explicitly names alternatives and their conditions: use `getUser` to inspect the profile, `updateAvatar` for the image, and this tool for attribute updates. It also adds a prerequisite (permission to edit that user) and a recommended dry-run step before committing.

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