Skip to main content
Glama
phillipboesger

Polarion MCP Server

getTestRunTestParameterDefinition

Read-only

Retrieve a specific test parameter definition from a test run by its ID. Use to fetch a single definition when you know the project, test run, and parameter IDs, instead of the full collection.

Instructions

Returns the specified Test Parameter Definition for the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunTestParameterDefinitions instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
projectIdYesThe 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.
testRunIdYesThe Test Run's ID within its project.
testParamIdYesThe Test Parameter.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
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. Changed5 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 / 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."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "properties": {
      +        "attributes": {
      +          "properties": {
      +            "name": {
      +              "example": "Test Parameter Definition example",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "id": {
      +          "example": "MyProjectId/MyTestParamDefinition",
      +          "type": "string"
      +        },
      +        "links": {
      +          "properties": {
      +            "self": {
      +              "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition",
      +              "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"
      +        },
      +        "revision": {
      +          "example": "1234",
      +          "type": "string"
      +        },
      +        "type": {
      +          "enum": [
      +            "testparameter_definitions"
      +          ],
      +          "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/testparameterdefinitions/MyTestParamDefinition",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed2 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."
  4. First observedv1.0.0

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already communicate readOnlyHint and openWorldHint, so the bar is lower. The description adds the cardinality constraint but not deeper behavioral context such as error behavior, revision handling, or sparse-field effects. It does not contradict the annotations, so a mid score is appropriate.

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 carry all essential information with no filler. The purpose is front-loaded, and the cardinality plus sibling alternative appear immediately after, making it easy to scan and act on.

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

Completeness5/5

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

For a single-item getter, the description is complete: purpose, cardinality, and the alternative for batch retrieval are covered, and the output schema plus annotations fill in the remaining context. The rich parameter descriptions in the schema mean nothing critical is missing for correct invocation.

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 schema already documents all six parameters, including the required projectId, testRunId, and testParamId. The description does not add parameter-level meaning beyond the schema, which matches the baseline expectation.

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

Purpose5/5

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

The description states a specific verb-resource pair: returns the specified Test Parameter Definition for a specified Test Run. It also disambiguates cardinality (single item by ID) and explicitly names the sibling `getTestRunTestParameterDefinitions` for the collection or batch case, so the agent can distinguish the tools without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

The description gives explicit routing guidance: use this tool for a single definition by ID, and use `getTestRunTestParameterDefinitions` for the full collection or a batch. This directly tells the agent when to select this tool versus its alternative.

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