Polarion MCP Server

getLicenseSlot

Read-only

Retrieves a single Polarion license slot by ID, model, and group, returning its details for inspection or license management.

Instructions

Returns the specified License Slot. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use getLicenseSlots instead.

Input Schema

Name	Required	Description	Default
`group`	Yes
`model`	Yes
`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.
`typeId`	Yes
`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.
`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.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"
+}

Changed47 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / properties / attributes / properties / configured / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / properties / attributes / properties / configured / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / expirationDate / format
```
Removed value: -"date"
```
- changedOutput schema / properties / data / properties / attributes / properties / expirationDate / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / free / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / properties / attributes / properties / free / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / group / example
```
Removed value: -"groupName"
```
- changedOutput schema / properties / data / properties / attributes / properties / group / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / model / example
```
Removed value: -"named"
```
- changedOutput schema / properties / data / properties / attributes / properties / model / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / peak / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / properties / attributes / properties / peak / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / total / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / properties / attributes / properties / total / type
```
Previous value: -"integer"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: -"LicenseType/ModelType/GroupId"
```
- 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/license/types/LicenseType/slots/ModelType/GroupId"
```
- 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 / type / enum
```
Removed value: -[
-  "license_slots"
-]
```
- 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/license/types/LicenseType/slots/ModelType/GroupId"
```
- 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"
+]
```

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

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "configured": {
+              "format": "int32",
+              "type": "integer"
+            },
+            "expirationDate": {
+              "format": "date",
+              "type": "string"
+            },
+            "free": {
+              "format": "int32",
+              "type": "integer"
+            },
+            "group": {
+              "example": "groupName",
+              "type": "string"
+            },
+            "model": {
+              "example": "named",
+              "type": "string"
+            },
+            "peak": {
+              "format": "int32",
+              "type": "integer"
+            },
+            "total": {
+              "format": "int32",
+              "type": "integer"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "LicenseType/ModelType/GroupId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId",
+              "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"
+        },
+        "type": {
+          "enum": [
+            "license_slots"
+          ],
+          "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/license/types/LicenseType/slots/ModelType/GroupId",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

AddedSep 7, 2026

TDQS

A3.9/5.0

Behavior4/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 two things annotations cannot: the cloud/Polarion X unsupported limitation and the single-item cardinality, both of which change how an agent behaves. Auth requirements and error behavior for a missing ID are still unstated.

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

Conciseness4/5

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

Three tight sentences, no filler, and the core purpose is front-loaded. The parenthetical platform caveat is dropped mid-description where it interrupts the flow, and 'Cardinality: targets a single item by ID' partially restates the opening sentence.

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

Completeness3/5

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

The presence of an output schema means return values need no explanation, and annotations cover safety. However, for a tool whose required inputs are a three-part identifier, the absence of any explanation of `typeId`/`model`/`group` is a meaningful completeness gap that the description should have closed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50% and the three required identifiers (`typeId`, `model`, `group`) have no schema descriptions at all. The description does not explain what these mean or how they compose the slot key, leaving the agent without the information needed to construct a valid call. The well-documented optional params (`fields`, `include`, `response_format`) are covered by the schema, not the description.

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 ('Returns') plus a specific resource ('the specified License Slot') and pins the scope with a cardinality statement. It also names the sibling it is not (`getLicenseSlots`), so an agent can separate the two without opening a 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?

Explicitly frames the selection rule: single item by ID here, full collection or batch in `getLicenseSlots`. It also adds an environment exclusion ('Not supported by cloud-based Polarion X'), which is real routing guidance. No further when-not conditions, but the alternative is named and unambiguous.

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

Deploy Server