Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getTestRuns

Read-only

Retrieves a filtered, paginated list of Test Runs for a Polarion project, enabling status review, sorting, and field selection.

Instructions

Returns a list of Test Runs. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRun instead. Examples: {"projectId":"myproject","query":"status:inprogress","page[size]":20}.

Input Schema

NameRequiredDescriptionDefault
sortNoComma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`).
queryNoPolarion 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.
fieldsNoSparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set.
includeNoComma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource.
revisionNoA 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_itemsNoCollect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
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.
templatesNoIf true, only return template resources; if false or omitted, return only actual (non-template) instances.
page_size_NoMaximum 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_No1-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_formatNoResponse 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

NameRequiredDescriptionDefault
dataNo
metaNo
linksNo
includedNoRelated entities might be returned, 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>.

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. Changed2 schema fields changedv1.4.0
    • 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"
+}
  3. Changed138 schema fields changedv1.3.1
    • removedOutput schema / properties / data / items / properties / attributes / properties / created / example
      Removed value: -"1970-01-01T00:00:00Z"
    • removedOutput schema / properties / data / items / properties / attributes / properties / created / format
      Removed value: -"date-time"
    • changedOutput schema / properties / data / items / properties / attributes / properties / created / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / finishedOn / example
      Removed value: -"1970-01-01T00:00:00Z"
    • removedOutput schema / properties / data / items / properties / attributes / properties / finishedOn / format
      Removed value: -"date-time"
    • changedOutput schema / properties / data / items / properties / attributes / properties / finishedOn / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / groupId / example
      Removed value: -"Group ID"
    • changedOutput schema / properties / data / items / properties / attributes / properties / groupId / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / type / enum
      Removed value: -[
-  "text/html",
-  "text/plain"
-]
    • changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / value / example
      Removed value: -"My text value"
    • changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / value / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / id / example
      Removed value: -"ID"
    • changedOutput schema / properties / data / items / properties / attributes / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / idPrefix / example
      Removed value: -"MyTestRunIdPrefix"
    • changedOutput schema / properties / data / items / properties / attributes / properties / idPrefix / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / attributes / properties / isTemplate / type
      Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / attributes / properties / keepInHistory / type
      Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / query / example
      Removed value: -"Query"
    • changedOutput schema / properties / data / items / properties / attributes / properties / query / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / selectTestCasesBy / enum
      Removed value: -[
-  "manualSelection",
-  "staticQueryResult",
-  "dynamicQueryResult",
-  "staticLiveDoc",
-  "dynamicLiveDoc",
-  "automatedProcess"
-]
    • removedOutput schema / properties / data / items / properties / attributes / properties / selectTestCasesBy / example
      Removed value: -"manualSelection"
    • changedOutput schema / properties / data / items / properties / attributes / properties / selectTestCasesBy / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / status / example
      Removed value: -"open"
    • changedOutput schema / properties / data / items / properties / attributes / properties / status / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / title / example
      Removed value: -"Title"
    • changedOutput schema / properties / data / items / properties / attributes / properties / title / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / type / example
      Removed value: -"manual"
    • changedOutput schema / properties / data / items / properties / attributes / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / attributes / properties / updated / example
      Removed value: -"1970-01-01T00:00:00Z"
    • removedOutput schema / properties / data / items / properties / attributes / properties / updated / format
      Removed value: -"date-time"
    • changedOutput schema / properties / data / items / properties / attributes / properties / updated / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / attributes / properties / useReportFromTemplate / type
      Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / attributes / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MyTestRunId"
    • changedOutput schema / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / links / properties / portal / example
      Removed value: -"server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234"
    • changedOutput schema / properties / data / items / properties / links / properties / portal / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / links / properties / self / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234"
    • changedOutput schema / properties / data / items / properties / links / properties / self / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / links / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / detail / example
      Removed value: -"Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / detail / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / example
      Removed value: -"revision"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / example
      Removed value: -"$.data"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / example
      Removed value: -"MyProjectId/id"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / example
      Removed value: -"type"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / example
      Removed value: -"400"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / example
      Removed value: -"Bad Request"
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / meta / properties / errors / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / meta / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / id / example
      Removed value: -"MyUserId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / type / enum
      Removed value: -[
-  "users"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / author / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / type / enum
      Removed value: -[
-  "documents"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / document / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / document / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / id / example
      Removed value: -"MyProjectId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / type / enum
      Removed value: -[
-  "projects"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / project / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / id / example
      Removed value: -"MyProjectId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / type / enum
      Removed value: -[
-  "projects"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / data / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / meta / properties / totalCount / format
      Removed value: -"int32"
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / meta / properties / totalCount / type
      Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / properties / meta / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / projectSpan / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / id / example
      Removed value: -"MyProjectId/MyWorkItemId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / type / enum
      Removed value: -[
-  "workitems"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / summaryDefect / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / id / example
      Removed value: -"MyProjectId/MyTestRunId"
    • changedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / type / enum
      Removed value: -[
-  "testruns"
-]
    • changedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / template / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / properties / template / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / items / properties / relationships / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / revision / example
      Removed value: -"1234"
    • changedOutput schema / properties / data / items / properties / revision / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / items / properties / type / enum
      Removed value: -[
-  "testruns"
-]
    • changedOutput schema / properties / data / items / properties / type / 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"
+]
    • changedOutput schema / properties / included / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / included / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / links / properties / first / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&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/testruns?page%5Bsize%5D=10&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/testruns?page%5Bsize%5D=10&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 / portal / example
      Removed value: -"server-host-name/application-path/polarion/redirect/project/MyProjectId/testruns"
    • changedOutput schema / properties / links / properties / portal / 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/testruns?page%5Bsize%5D=10&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/testruns?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"
+]
  4. Changed9 schema fields changedv1.2.0
    • changedInput schema / properties / fields / description
      Previous value: -"Filter returned resource fields. 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: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set."
    • changedInput schema / properties / include / description
      Previous value: -"Include related entities. 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: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
    • 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 / 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 / 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 / sort / description
      Previous value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
    • changedInput schema / properties / templates / description
      Previous value: -"If set to true, only templates will be returned, otherwise only actual instances will be returned."New value: +"If true, only return template resources; if false or omitted, return only actual (non-template) instances."
  5. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "attributes": {
+            "properties": {
+              "created": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "finishedOn": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "groupId": {
+                "example": "Group ID",
+                "type": "string"
+              },
+              "homePageContent": {
+                "properties": {
+                  "type": {
+                    "enum": [
+                      "text/html",
+                      "text/plain"
+                    ],
+                    "type": "string"
+                  },
+                  "value": {
+                    "example": "My text value",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "id": {
+                "example": "ID",
+                "type": "string"
+              },
+              "idPrefix": {
+                "example": "MyTestRunIdPrefix",
+                "type": "string"
+              },
+              "isTemplate": {
+                "type": "boolean"
+              },
+              "keepInHistory": {
+                "type": "boolean"
+              },
+              "query": {
+                "example": "Query",
+                "type": "string"
+              },
+              "selectTestCasesBy": {
+                "enum": [
+                  "manualSelection",
+                  "staticQueryResult",
+                  "dynamicQueryResult",
+                  "staticLiveDoc",
+                  "dynamicLiveDoc",
+                  "automatedProcess"
+                ],
+                "example": "manualSelection",
+                "type": "string"
+              },
+              "status": {
+                "example": "open",
+                "type": "string"
+              },
+              "title": {
+                "example": "Title",
+                "type": "string"
+              },
+              "type": {
+                "example": "manual",
+                "type": "string"
+              },
+              "updated": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "useReportFromTemplate": {
+                "type": "boolean"
+              }
+            },
+            "type": "object"
+          },
+          "id": {
+            "example": "MyProjectId/MyTestRunId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "portal": {
+                "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234",
+                "type": "string"
+              },
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "meta": {
+            "properties": {
+              "errors": {
+                "items": {
+                  "properties": {
+                    "detail": {
+                      "description": "Human-readable explanation specific to this occurrence of the problem.",
+                      "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)",
+                      "type": "string"
+                    },
+                    "source": {
+                      "properties": {
+                        "parameter": {
+                          "description": "String indicating which URI query parameter caused the error.",
+                          "example": "revision",
+                          "type": "string"
+                        },
+                        "pointer": {
+                          "description": "JSON Pointer to the associated entity in the request document.",
+                          "example": "$.data",
+                          "type": "string"
+                        },
+                        "resource": {
+                          "description": "Resource causing the error.",
+                          "properties": {
+                            "id": {
+                              "example": "MyProjectId/id",
+                              "type": "string"
+                            },
+                            "type": {
+                              "example": "type",
+                              "type": "string"
+                            }
+                          },
+                          "type": "object"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "status": {
+                      "description": "HTTP status code applicable to this problem.",
+                      "example": "400",
+                      "type": "string"
+                    },
+                    "title": {
+                      "description": "Short, human-readable summary of the problem.",
+                      "example": "Bad Request",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              }
+            },
+            "type": "object"
+          },
+          "relationships": {
+            "properties": {
+              "author": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyUserId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "users"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "document": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "project": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "projects"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "projectSpan": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "projects"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "summaryDefect": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyWorkItemId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "workitems"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "template": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyTestRunId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "testruns"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "revision": {
+            "example": "1234",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "testruns"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "included": {
+      "description": "Related entities might be returned, 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>.",
+      "items": {
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "links": {
+      "properties": {
+        "first": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=1",
+          "type": "string"
+        },
+        "last": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=9",
+          "type": "string"
+        },
+        "next": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=6",
+          "type": "string"
+        },
+        "portal": {
+          "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testruns",
+          "type": "string"
+        },
+        "prev": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=4",
+          "type": "string"
+        },
+        "self": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=5",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "meta": {
+      "properties": {
+        "totalCount": {
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  6. Changed6 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Filter returned resource fields. 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."New value: +"Filter returned resource fields. 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."
    • changedInput schema / properties / include / description
      Previous value: -"Include related entities. 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."New value: +"Include related entities. 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."
    • 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"
+}
  7. First observedv1.0.0

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety profile is covered. The description adds cardinality context (collection vs batch) but says nothing about pagination defaults, max_items interaction with paging, or payload size behavior — useful extras it could have carried.

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 tight sentences plus one example, with the scope statement and sibling routing front-loaded. No filler or restatement of the name.

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?

An output schema exists, so return values need not be explained, and annotations cover safety; the description covers purpose, scope, and alternative. Minor gap: nothing distinguishes `max_items` cross-page collection from `page_size_` paging, which is the one non-obvious behavioral choice for an 11-parameter list tool.

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 every parameter (query, fields, include, revision, max_items, response_format, etc.) is already documented. The description only shows an example touching projectId, query, and paging, adding marginal meaning beyond the schema. 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 a list of Test Runs") and immediately clarifies scope/cardinality ("full collection or a batch"). It explicitly names the sibling `getTestRun` as the single-item alternative, so an agent can separate 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 routing rule: collection/batch here, single item by ID via `getTestRun`. The concrete example ({"projectId":"myproject","query":"status:inprogress","page[size]":20}) demonstrates the intended call pattern for filtered listing.

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