Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchProjectEnumeration

DestructiveIdempotent

Replaces the full option list of a project enumeration, deleting any options omitted from the request. Read current options first and include every option to keep.

Instructions

Replaces the entire option list of one Enumeration in a project: options missing from requestBody are deleted, not merged. Read the current list with getProjectEnumeration first and send every option you want to keep. Scope: one project (requires a project ID). To act across all projects, use patchGlobalEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. 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
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.
enumNameYesThe Enumeration Name.
projectIdYesThe Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
targetTypeYesThe configured subtype for this enumeration or custom field (e.g. `requirement` for a Work Item type). Use `~` (without quotes) when the configuration applies to every subtype.
enumContextYesThe Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
requestBodyYesThe Enumeration(s) body.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.4
    • changedInput schema / properties / projectId / description
      Previous 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."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access."
  2. Changed1 schema field changedv1.4.0
    • changedInput schema / properties / targetType / description
      Previous value: -"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."New value: +"The configured subtype for this enumeration or custom field (e.g. `requirement` for a Work Item type). Use `~` (without quotes) when the configuration applies to every subtype."
  3. 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 / targetType / description
      Previous value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
  4. Changed3 schema fields 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"
+}
    • addedInput schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / limited
      Added value: +{
+  "type": "boolean"
+}
    • addedInput schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / linkRules
      Added value: +{
+  "items": {
+    "properties": {
+      "fromTypes": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "sameType": {
+        "type": "boolean"
+      },
+      "toTypes": {
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
  5. First observedv1.0.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description goes well beyond them: it explains the exact destructive mechanic (omitted options are deleted, not merged), states irreversibility ('cannot be recovered through the API'), and describes what `dry_run` returns. This is the kind of context an agent cannot get from structured fields alone.

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?

Front-loads the most important fact (full replacement, deletions) in the first sentence, then layers scope, alternative, and safety tip. Mostly tight; the closing clause about structured content in the executor response is slightly tangential to the tool's purpose.

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 destructive mutation with nested objects and no output schema, the description covers side effects, recoverability, scope, alternatives, and a safe preview path. It leaves how the target enumeration is identified (enumName + enumContext + targetType) to the schema, which is acceptable given 100% coverage but is a minor gap.

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 coverage is 100%, so baseline is 3; the description earns an extra point by defining the semantics of `requestBody` as a full replacement payload rather than a patch and by explaining the two output modes of `dry_run`. It does not elaborate on the enumName/enumContext/targetType combination that identifies the target enumeration, leaving that to the schema.

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 ('Replaces the entire option list of one Enumeration in a project') plus the crucial replace-not-merge semantics. It explicitly distinguishes itself from sibling tools by naming `getProjectEnumeration` (read the current list first) and `patchGlobalEnumeration` (cross-project variant).

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?

Gives explicit preconditions ('Read the current list with getProjectEnumeration first and send every option you want to keep') and a named alternative for the different scope ('To act across all projects, use patchGlobalEnumeration instead'). It also recommends a dry_run-first workflow, so when/how to invoke is fully specified.

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