Polarion MCP Server

getWorkflowActionsForTestRun

Read-only

Returns the workflow actions available from a Test Run's current status, including target status and requirements, so you can choose a valid transition before updating the Test Run.

Instructions

Returns the workflow actions (transitions) possible from one Test Run's current status, each with its action ID, name, target status, whether it is available to the calling user (with an unavailableReason if not), and the fields, roles, or signatures it requires. Call it before patchTestRun with workflowAction to choose a valid transition; for Work Items use getWorkflowActionsForWorkItem.

Input Schema

Name	Required	Description	Default
`revision`	No	A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision.
`max_items`	No	Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
`projectId`	Yes	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.
`testRunId`	Yes	The Test Run's ID within its project.
`page_size_`	No	Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set.
`page_number_`	No	1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page.
`response_format`	No	Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.	detailed

Output Schema

Name	Required	Description	Default
`data`	No
`meta`	No
`links`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.4.4Oct 29, 2026

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."

Changed2 schema fields changedv1.4.0Oct 24, 2026

addedInput schema / properties / max_items

Added value: +{
+  "description": "Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.",
+  "maximum": 1000,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / response_format

Added value: +{
+  "default": "detailed",
+  "description": "Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.",
+  "enum": [
+    "concise",
+    "detailed"
+  ],
+  "type": "string"
+}

Changed34 schema fields changedv1.3.1Oct 22, 2026

changedOutput schema / properties / data / items / properties / available / type

Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / clearedFields / items / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / clearedFields / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
removedOutput schema / properties / data / items / properties / id / example
```
Removed value: -"0"
```

changedOutput schema / properties / data / items / properties / id / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / isAddingSignature / type

Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / isSignatureRequired / type

Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / data / items / properties / name / example
```
Removed value: -"actionName"
```

changedOutput schema / properties / data / items / properties / name / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / data / items / properties / nativeActionId / example
```
Removed value: -"nativeActionId"
```

changedOutput schema / properties / data / items / properties / nativeActionId / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / requiredFields / items / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / requiredFields / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```

changedOutput schema / properties / data / items / properties / requiredRoles / items / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / requiredRoles / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
removedOutput schema / properties / data / items / properties / targetStatus / example
```
Removed value: -"done"
```

changedOutput schema / properties / data / items / properties / targetStatus / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / unavailableReason / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / type

Previous value: -"object"New value: +[
+  "object",
+  "null"
+]

changedOutput schema / properties / data / type

Previous value: -"array"New value: +[
+  "array",
+  "null"
+]

removedOutput schema / properties / links / properties / first / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1"

changedOutput schema / properties / links / properties / first / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / links / properties / last / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9"

changedOutput schema / properties / links / properties / last / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / links / properties / next / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6"

changedOutput schema / properties / links / properties / next / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / links / properties / prev / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4"

changedOutput schema / properties / links / properties / prev / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / links / properties / self / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5"

changedOutput schema / properties / links / properties / self / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / links / type

Previous value: -"object"New value: +[
+  "object",
+  "null"
+]

removedOutput schema / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```

changedOutput schema / properties / meta / properties / totalCount / type

Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / meta / type

Previous value: -"object"New value: +[
+  "object",
+  "null"
+]

Changed5 schema fields changedv1.2.0Sep 17, 2026

changedInput schema / properties / page_number_ / description

Previous value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page."

changedInput schema / properties / page_size_ / description

Previous value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."

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 / revision / description

Previous value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."

changedInput schema / properties / testRunId / description

Previous value: -"The Test Run ID."New value: +"The Test Run's ID within its project."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "available": {
+            "type": "boolean"
+          },
+          "clearedFields": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "id": {
+            "example": "0",
+            "type": "string"
+          },
+          "isAddingSignature": {
+            "type": "boolean"
+          },
+          "isSignatureRequired": {
+            "type": "boolean"
+          },
+          "name": {
+            "example": "actionName",
+            "type": "string"
+          },
+          "nativeActionId": {
+            "example": "nativeActionId",
+            "type": "string"
+          },
+          "requiredFields": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "requiredRoles": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "targetStatus": {
+            "example": "done",
+            "type": "string"
+          },
+          "unavailableReason": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "links": {
+      "properties": {
+        "first": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1",
+          "type": "string"
+        },
+        "last": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9",
+          "type": "string"
+        },
+        "next": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6",
+          "type": "string"
+        },
+        "prev": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4",
+          "type": "string"
+        },
+        "self": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "meta": {
+      "properties": {
+        "totalCount": {
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

Changed4 schema fields changedSep 7, 2026

removedInput schema / properties / page_number

Removed value: -{
-  "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
-  "format": "int32",
-  "type": "number"
-}

addedInput schema / properties / page_number_

Added value: +{
+  "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
+  "format": "int32",
+  "type": "number"
+}

removedInput schema / properties / page_size

Removed value: -{
-  "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
-  "format": "int32",
-  "type": "number"
-}

addedInput schema / properties / page_size_

Added value: +{
+  "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
+  "format": "int32",
+  "type": "number"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered; the description adds that availability is computed per calling user with an `unavailableReason`, plus required fields, roles, and signatures. That is meaningful behavioral context beyond the annotations, though it does not discuss result volume or pagination behavior.

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?

Two dense sentences: the first defines the return contents, the second delivers the routing guidance. No filler, and the call-order instruction is placed where an agent will act on it.

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

Completeness5/5

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

With an output schema present and 100% schema description coverage, the description only needs purpose, usage, and the user-availability nuance, all of which it supplies. Nothing required to call this correctly is missing.

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 coverage is 100%, so revision, pagination, and response_format semantics are fully documented in the schema. The description adds no parameter-level detail of its own, which is acceptable given the schema carries that burden; 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 ('Returns the workflow actions (transitions)... for one Test Run's current status') and enumerates exactly what each action contains. It explicitly separates itself from the Work Item sibling, so an agent can distinguish the two without opening either 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?

Gives an explicit call-order instruction ('Call it before patchTestRun with `workflowAction` to choose a valid transition') and names the correct alternative for Work Items ('getWorkflowActionsForWorkItem'). Both the when and the when-otherwise are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server