Polarion MCP Server

getTestRecords

Read-only

Retrieve a list of Test Records from a Polarion project and test run for browsing or batch-fetching results, with pagination, field selection, and optional related resources.

Instructions

Returns a list of Test Records. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecord instead.

Input Schema

Name	Required	Description	Default
`fields`	No	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.
`include`	No	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.
`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.
`testCaseId`	No	The Test Case's ID being referenced.
`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.
`testResultId`	No	testResultId
`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
`testCaseProjectId`	No	The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project.

Output Schema

Name	Required	Description
`data`	No
`meta`	No
`links`	No
`included`	No	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>.

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"
+}

Changed88 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / items / properties / attributes / properties / comment / properties / type / enum
```
Removed value: -[
-  "text/html",
-  "text/plain"
-]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / comment / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / comment / properties / value / example
```
Removed value: -"My text value"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / comment / properties / value / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / comment / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / duration / type
```
Previous value: -"number"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / executed / example
```
Removed value: -"1970-01-01T00:00:00Z"
```
- removedOutput schema / properties / data / items / properties / attributes / properties / executed / format
```
Removed value: -"date-time"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / executed / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / iteration / example
```
Removed value: -0
```
- removedOutput schema / properties / data / items / properties / attributes / properties / iteration / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / iteration / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / result / example
```
Removed value: -"passed"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / result / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / testCaseRevision / example
```
Removed value: -"Test Case Revision"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / testCaseRevision / type
```
Previous value: -"string"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: -"elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
```
- 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 / self / example
```
Removed value: -"server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0"
```
- 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 / defect / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MyWorkItemId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / properties / type / enum
```
Removed value: -[
-  "workitems"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / defect / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / defect / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / id / example
```
Removed value: -"MyUserId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / type / enum
```
Removed value: -[
-  "users"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / executedBy / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / executedBy / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MyWorkItemId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / type / enum
```
Removed value: -[
-  "workitems"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / testCase / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / testCase / 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: -[
-  "testrecords"
-]
```
- 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/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?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/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?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/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?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 / prev / example
```
Removed value: -"server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?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/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?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"
+]
```

Changed9 schema fields changedv1.2.0Sep 17, 2026

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

Previous value: -"testCaseId"New value: +"The Test Case's ID being referenced."

changedInput schema / properties / testCaseProjectId / description

Previous value: -"testCaseProjectId"New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project."

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": {
+          "attributes": {
+            "properties": {
+              "comment": {
+                "properties": {
+                  "type": {
+                    "enum": [
+                      "text/html",
+                      "text/plain"
+                    ],
+                    "type": "string"
+                  },
+                  "value": {
+                    "example": "My text value",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "duration": {
+                "type": "number"
+              },
+              "executed": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "iteration": {
+                "example": 0,
+                "format": "int32",
+                "type": "integer"
+              },
+              "result": {
+                "example": "passed",
+                "type": "string"
+              },
+              "testCaseRevision": {
+                "example": "Test Case Revision",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "id": {
+            "example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "self": {
+                "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0",
+                "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": {
+              "defect": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyWorkItemId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "workitems"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "executedBy": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyUserId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "users"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "testCase": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyWorkItemId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "workitems"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "revision": {
+            "example": "1234",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "testrecords"
+            ],
+            "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/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=1",
+          "type": "string"
+        },
+        "last": {
+          "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=9",
+          "type": "string"
+        },
+        "next": {
+          "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=6",
+          "type": "string"
+        },
+        "prev": {
+          "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=4",
+          "type": "string"
+        },
+        "self": {
+          "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=5",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "meta": {
+      "properties": {
+        "totalCount": {
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

Changed6 schema fields changedSep 7, 2026

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"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4/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 the safety profile is covered. The description adds only the cardinality trait; it says nothing about pagination defaults, whether `max_items` overrides paging, or what happens on large result sets — all of which are non-obvious for this tool.

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 short sentences, front-loaded with purpose and followed by the sibling routing note. Nothing is redundant or padded.

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?

With an output schema present and full param coverage, the description needn't explain returns. What's slightly missing for a 12-parameter, nested-object tool is any hint that the listing is filterable (test case, test result, revision) rather than always a full-collection dump.

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 the 12 parameters are already documented in structured form; the baseline is 3. The description adds no parameter-level meaning beyond the vague "full collection or a batch" phrasing, and never hints that results can be narrowed by `testCaseId`/`testResultId`.

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 Records") and adds a cardinality note ("targets the full collection or a batch"). It explicitly names the sibling `getTestRecord` as the single-item alternative, 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit when-not rule: "For a single item by ID, use `getTestRecord` instead." It doesn't say anything about when to prefer this over `getTestStepResults` or `getTestRunTestParameters`, but the list-vs-single routing is clear and actionable.

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

Deploy Server