Polarion MCP Server

getTestRunComment

Read-only

Retrieve a single Test Run comment by project, test run, and comment ID to inspect its details; use the collection tool when you need all comments.

Instructions

Returns the specified Test Run Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunComments 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.
`commentId`	Yes	The Comment ID.
`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.
`response_format`	No	Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.	detailed

Output Schema

Name	Required	Description
`data`	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."

Changed1 schema field changedv1.4.0Oct 24, 2026

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

Changed85 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / properties / attributes / properties / created / example
```
Removed value: -"1970-01-01T00:00:00Z"
```
- removedOutput schema / properties / data / properties / attributes / properties / created / format
```
Removed value: -"date-time"
```
- changedOutput schema / properties / data / properties / attributes / properties / created / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / id / example
```
Removed value: -"MyCommentId"
```
- changedOutput schema / properties / data / properties / attributes / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / resolved / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / text / properties / type / enum
```
Removed value: -[
-  "text/html",
-  "text/plain"
-]
```
- changedOutput schema / properties / data / properties / attributes / properties / text / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / text / properties / value / example
```
Removed value: -"My text value"
```
- changedOutput schema / properties / data / properties / attributes / properties / text / properties / value / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / text / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / title / example
```
Removed value: -"Title"
```
- changedOutput schema / properties / data / properties / attributes / properties / title / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MyTestRunId/MyCommentId"
```
- changedOutput schema / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / links / properties / self / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
```
- changedOutput schema / properties / data / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / 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 / properties / meta / properties / errors / items / properties / detail / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / parameter / example
```
Removed value: -"revision"
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / parameter / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / pointer / example
```
Removed value: -"$.data"
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / pointer / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / example
```
Removed value: -"MyProjectId/id"
```
- changedOutput schema / properties / data / 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 / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / example
```
Removed value: -"type"
```
- changedOutput schema / properties / data / 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 / properties / meta / properties / errors / items / properties / source / properties / resource / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / source / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / status / example
```
Removed value: -"400"
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / status / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / meta / properties / errors / items / properties / title / example
```
Removed value: -"Bad Request"
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / properties / title / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / meta / properties / errors / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / meta / properties / errors / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / id / example
```
Removed value: -"MyUserId"
```
- changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / type / enum
```
Removed value: -[
-  "users"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / author / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / id / example
```
Removed value: -"MyProjectId/MyTestRunId/MyCommentId"
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / type / enum
```
Removed value: -[
-  "testrun_comments"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / childComments / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / meta / properties / totalCount / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / childComments / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MyTestRunId/MyCommentId"
```
- changedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / type / enum
```
Removed value: -[
-  "testrun_comments"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / parentComment / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / parentComment / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / id / example
```
Removed value: -"MyProjectId"
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / type / enum
```
Removed value: -[
-  "projects"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / type / enum
```
Removed value: -[
-  "testrun_comments"
-]
```
- changedOutput schema / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "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 / self / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
```
- 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"
+]
```

Changed5 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 / projectId / description

Previous value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."

changedInput schema / properties / revision / description

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

changedInput schema / properties / testRunId / description

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

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "created": {
+              "example": "1970-01-01T00:00:00Z",
+              "format": "date-time",
+              "type": "string"
+            },
+            "id": {
+              "example": "MyCommentId",
+              "type": "string"
+            },
+            "resolved": {
+              "type": "boolean"
+            },
+            "text": {
+              "properties": {
+                "type": {
+                  "enum": [
+                    "text/html",
+                    "text/plain"
+                  ],
+                  "type": "string"
+                },
+                "value": {
+                  "example": "My text value",
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "title": {
+              "example": "Title",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyProjectId/MyTestRunId/MyCommentId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?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"
+            },
+            "childComments": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyTestRunId/MyCommentId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "testrun_comments"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "meta": {
+                  "properties": {
+                    "totalCount": {
+                      "format": "int32",
+                      "type": "integer"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "parentComment": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MyTestRunId/MyCommentId",
+                      "type": "string"
+                    },
+                    "revision": {
+                      "example": "1234",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "testrun_comments"
+                      ],
+                      "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"
+            }
+          },
+          "type": "object"
+        },
+        "revision": {
+          "example": "1234",
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "testrun_comments"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "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": {
+        "self": {
+          "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

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

First observedv1.0.0Jun 13, 2026

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 the safety profile is covered. The description adds the single-item-by-ID retrieval model but says nothing about failure behavior when the comment ID does not exist or about the effect of the revision/include parameters. Some added value, but thin beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, zero filler, with the retrieval scope front-loaded before the sibling routing. Every clause earns its place.

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 described, and required IDs are documented in the schema. What remains missing is a note on behavior for a nonexistent comment ID or invalid project scope, which would matter for an agent handling errors. Otherwise complete for a single-item read.

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% and all seven parameters (including fields, include, revision, response_format) are documented in the schema itself. The description adds no parameter-level meaning such as how commentId scopes to a testRunId, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Returns the specified Test Run Comment') and immediately clarifies cardinality ('targets a single item by ID'), which distinguishes it from the collection sibling. An agent can separate it from getTestRunComments 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?

Explicitly names the alternative ('for the full collection or a batch, use `getTestRunComments`') and gives the condition that selects it. The when-to-use-this vs. when-to-use-the-other decision is fully resolved in the description.

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

Deploy Server