Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getJob

Read-only

Retrieve a specific asynchronous job by ID to poll its completion status and inspect results for one tracked operation.

Instructions

Returns the specified Job. Cardinality: targets a single item by ID. For the full collection or a batch, use getJobs instead. Examples: {"jobId":"job-123"}.

Input Schema

NameRequiredDescriptionDefault
jobIdYesThe asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status.
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.
response_formatNoResponse 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

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. Changed1 schema field changedv1.4.0
    • 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"
+}
  2. Changed72 schema fields changedv1.3.1
    • removedOutput schema / properties / data / properties / attributes / properties / jobId / example
      Removed value: -"example"
    • changedOutput schema / properties / data / properties / attributes / properties / jobId / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / name / example
      Removed value: -"example"
    • changedOutput schema / properties / data / properties / attributes / properties / name / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / state / example
      Removed value: -"example"
    • changedOutput schema / properties / data / properties / attributes / properties / state / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / status / properties / message / example
      Removed value: -"message"
    • changedOutput schema / properties / data / properties / attributes / properties / status / properties / message / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / status / properties / type / enum
      Removed value: -[
-  "OK",
-  "CANCELLED",
-  "FAILED",
-  "UNKNOWN"
-]
    • changedOutput schema / properties / data / properties / attributes / properties / status / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / status / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / id / example
      Removed value: -"MyJobId"
    • changedOutput schema / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / links / properties / downloads / example
      Removed value: -[
-  "https://example.com/polarion/download/filename1",
-  "https://example.com/polarion/download/filename2"
-]
    • changedOutput schema / properties / data / properties / links / properties / downloads / items / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / links / properties / downloads / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / links / properties / log / example
      Removed value: -"server-host-name/application-path/polarion/job-report?jobId=MyJobId"
    • changedOutput schema / properties / data / properties / links / properties / log / 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/jobs/MyJobId"
    • 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 / document / properties / data / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / type / enum
      Removed value: -[
-  "documents"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / document / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / type / enum
      Removed value: -[
-  "documents"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / documents / properties / meta / properties / totalCount / format
      Removed value: -"int32"
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / meta / properties / totalCount / type
      Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / documents / properties / meta / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / documents / 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 / 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 / type / enum
      Removed value: -[
-  "jobs"
-]
    • 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/jobs/MyJobId"
    • 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"
+]
  3. Changed3 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 / jobId / description
      Previous value: -"The Job ID."New value: +"The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status."
  4. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "jobId": {
+              "example": "example",
+              "type": "string"
+            },
+            "name": {
+              "example": "example",
+              "type": "string"
+            },
+            "state": {
+              "example": "example",
+              "type": "string"
+            },
+            "status": {
+              "properties": {
+                "message": {
+                  "example": "message",
+                  "type": "string"
+                },
+                "type": {
+                  "enum": [
+                    "OK",
+                    "CANCELLED",
+                    "FAILED",
+                    "UNKNOWN"
+                  ],
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyJobId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "downloads": {
+              "example": [
+                "https://example.com/polarion/download/filename1",
+                "https://example.com/polarion/download/filename2"
+              ],
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "log": {
+              "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId",
+              "type": "string"
+            },
+            "self": {
+              "example": "server-host-name/application-path/jobs/MyJobId",
+              "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": {
+            "document": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MySpaceId/MyDocumentId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "documents"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "documents": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "meta": {
+                  "properties": {
+                    "totalCount": {
+                      "format": "int32",
+                      "type": "integer"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "project": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "projects"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "enum": [
+            "jobs"
+          ],
+          "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/jobs/MyJobId",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  5. 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."
  6. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

The annotations already declare this as a read-only, open-world operation, and the description adds useful cardinality context (single item by ID) plus an example. It does not add much further behavioral context about async job lifecycle or polling, though the schema's `jobId` description covers some of that.

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?

The description is three short sentences, front-loaded with the core behavior, then cardinality, then sibling routing. Every sentence adds useful information with no wasted prose.

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 and 100% parameter description coverage, the definition is mostly complete for correct invocation. The remaining gap is that it does not route the agent to log/result or job-execution siblings, which matters given the large job-related sibling set.

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 itself documents all four parameters in detail. The description contributes only a simple `jobId` example and does not add meaning for `fields`, `include`, or `response_format` beyond the schema.

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 and resource ("Returns the specified Job"), then clarifies cardinality as a single item selected by ID. It explicitly distinguishes itself from `getJobs`, so an agent can identify its role 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 Guidelines4/5

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

It gives clear routing guidance for the main sibling conflict: use `getJobs` for the full collection or a batch. However, it does not clarify when to use this versus job-related siblings such as `getJobLogContent`, `getJobResultFileContent`, or `run_job_and_wait`.

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