Polarion MCP Server

getExportExcelTests

Read-only

Asynchronously export a Test Run's test cases to an Excel workbook, applying optional query and sort filters, then poll the returned job to fetch the file.

Instructions

Starts an asynchronous export of one Test Run's test cases to an Excel workbook, optionally filtered with query, ordered with sortBy, and shaped by an export template. Returns a jobs resource, not the file: poll getJob until finished, then download the workbook with getJobResultFileContent. To import results back, use importExcelTestResults.

Input Schema

TableJSON Schema

Name	Required	Description
`query`	No	Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried.
`sortBy`	No	The property to sort the test results.
`template`	No	The export template string.
`projectId`	Yes	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.
`testRunId`	Yes	The Test Run's ID within its project.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv1.2.0Sep 17, 2026

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

Previous value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried."

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": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "jobId": {
+              "example": "example",
+              "type": "string"
+            },
+            "name": {
+              "example": "example",
+              "type": "string"
+            },
+            "state": {
+              "example": "example",
+              "type": "string"
+            },
+            "status": {
+              "properties": {
+                "message": {
+                  "example": "message",
+                  "type": "string"
+                },
+                "type": {
+                  "enum": [
+                    "OK",
+                    "CANCELLED",
+                    "FAILED",
+                    "UNKNOWN"
+                  ],
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyJobId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "downloads": {
+              "example": [
+                "https://example.com/polarion/download/filename1",
+                "https://example.com/polarion/download/filename2"
+              ],
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "log": {
+              "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId",
+              "type": "string"
+            },
+            "self": {
+              "example": "server-host-name/application-path/jobs/MyJobId",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "relationships": {
+          "properties": {
+            "document": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MySpaceId/MyDocumentId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "documents"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "documents": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
+              },
+              "type": "object"
+            },
+            "project": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "projects"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "enum": [
+            "jobs"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.9/5.0

Behavior5/5

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

The description fully discloses the asynchronous behavior—that it returns a jobs resource, not the file, and that polling is required. It also mentions the import alternative, giving the agent a full picture of the operation's lifecycle. The annotations already provide readOnlyHint=true, but the description adds crucial context about the job-creation side effect and the polling/download workflow, which is beyond the annotations.

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?

The description is concise and well-structured: it states the purpose first, then the async workflow, and finally the import alternative. Each sentence earns its place, and there is no redundant or filler content. The front-loaded purpose makes it immediately scannable for an agent.

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?

The description is complete for the tool's complexity. It covers the async behavior, the optional parameters, and the follow-up tools (getJob, getJobResultFileContent, importExcelTestResults). An output schema exists, so return values are already specified. Nothing an agent needs to call this tool correctly is missing.

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?

The schema descriptions cover all five parameters, and the description adds semantic meaning by explaining the role of query ('filtered'), sortBy ('ordered'), and template ('shaped'). This goes beyond the schema's field-level descriptions and helps the agent understand how the parameters interact. Since schema coverage is 100%, the baseline is 3, but the additional context elevates it to 4.

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?

The description clearly states the action ('Starts an asynchronous export'), the resource ('one Test Run's test cases'), the target ('Excel workbook'), and the optional filters (query, sortBy, template). It distinguishes itself from sibling tools by specifying the export-to-Excel workflow and explicitly noting it returns a jobs resource rather than the file, which sets it apart from getJobResultFileContent and importExcelTestResults.

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?

The description gives explicit guidance on the complete workflow: poll getJob until finished, then download with getJobResultFileContent, and mentions importExcelTestResults for importing results back. It also implies when to use this tool (when exporting test cases to Excel) and provides context on the asynchronous nature. This is comprehensive and leaves no ambiguity about the next steps.

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

Deploy Server