Polarion MCP Server

getProject

Read-only

Retrieves a single Polarion project by its ID with options for sparse fields, related resources, and historical revisions.

Instructions

Returns the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjects instead.

Input Schema

TableJSON Schema

Name	Required	Description
`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.
`projectId`	Yes	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.

Output Schema

TableJSON 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.

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

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "active": {
+              "type": "boolean"
+            },
+            "color": {
+              "example": "Color",
+              "type": "string"
+            },
+            "description": {
+              "properties": {
+                "type": {
+                  "enum": [
+                    "text/plain"
+                  ],
+                  "type": "string"
+                },
+                "value": {
+                  "example": "My text value",
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "finish": {
+              "example": "1970-01-01",
+              "format": "date",
+              "type": "string"
+            },
+            "icon": {
+              "example": "Icon",
+              "type": "string"
+            },
+            "id": {
+              "example": "MyProjectId",
+              "type": "string"
+            },
+            "lockWorkRecordsDate": {
+              "example": "1970-01-01",
+              "format": "date",
+              "type": "string"
+            },
+            "name": {
+              "example": "Name",
+              "type": "string"
+            },
+            "start": {
+              "example": "1970-01-01",
+              "format": "date",
+              "type": "string"
+            },
+            "trackerPrefix": {
+              "example": "Tracker Prefix",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyProjectId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/projects/MyProjectId?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": {
+            "lead": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyUserId",
+                      "type": "string"
+                    },
+                    "revision": {
+                      "example": "1234",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "users"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "revision": {
+          "example": "1234",
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "projects"
+          ],
+          "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?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.5/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 the cardinality constraint (targets a single item by ID), which is useful behavioral context beyond the schema.

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 sentences with no filler; the core purpose and key differentiator are stated immediately. 'Cardinality: targets a single item by ID' is an efficient, informative addition.

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?

The tool is a simple single-item read with output schema, annotations, and complete parameter descriptions; the description correctly identifies scope and the sibling alternative. Nothing needed by an agent to call it correctly is missing.

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 coverage is 100% and every parameter already has a descriptive schema entry (fields, include, revision, projectId). The description adds no parameter-level explanation, so it does not go beyond what the schema provides.

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 that it returns a specific Project and explicitly distinguishes itself from getProjects for collection/batch queries. The single-item cardinality is front and center, so an agent can tell it apart without opening the 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 (getProjects) for the full collection or batch case, giving an unambiguous when-not-to-use rule. No other exclusion is needed for this single-item read tool.

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

Deploy Server