Skip to main content
Glama
phillipboesger

Polarion MCP Server

getRevision

Read-only

Retrieve a single repository revision by its number to view author, timestamp, and commit message. Use this to identify who changed data at a known revision.

Instructions

Returns one repository revision (commit) by its number: author, timestamp, and commit message. Use it to see who changed data at a known revision, e.g. a revision value seen on a resource; to search or page through revision history use getRevisions. Cardinality: targets a single item by ID. For the full collection or a batch, use getRevisions 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.
revisionYesA 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.
repositoryNameYesThe Repository Name.

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. 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 / 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."
  2. Changed1 schema field changedv1.1.0
    • 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": {
      +              "type": "string"
      +            },
      +            "internalCommit": {
      +              "type": "boolean"
      +            },
      +            "message": {
      +              "example": "Message",
      +              "type": "string"
      +            },
      +            "repositoryName": {
      +              "example": "Repository name",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "id": {
      +          "example": "default/1234",
      +          "type": "string"
      +        },
      +        "links": {
      +          "properties": {
      +            "self": {
      +              "example": "server-host-name/application-path/revisions/default/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"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "revision": {
      +          "example": "1234",
      +          "type": "string"
      +        },
      +        "type": {
      +          "enum": [
      +            "revisions"
      +          ],
      +          "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/revisions/default/1234",
      +          "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.5/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=true and openWorldHint=true, so the description does not need to re-establish safety. It adds useful behavior beyond annotations: singleton cardinality, targeting by revision number, and the returned fields. This is meaningful context for an agent deciding how to handle the result.

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 front-loaded with the core operation, then provides a concrete use case, then routes to the sibling tool. Every sentence earns its place, and the formal 'Cardinality' marker succinctly summarizes the singleton behavior.

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 read-only singleton accessor with an output schema, annotations, and full parameter documentation, the description is complete. An agent knows what the tool returns, when to use it, how it differs from getRevisions, and which parameters matter for 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 baseline is 3. The description clarifies that the revision parameter is the target commit identifier, but it does not add substantive syntax or format details beyond the already-complete schema. The fields and include parameters are left to the schema, which is acceptable.

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 one repository revision (commit) by its number', and names the returned content (author, timestamp, commit message). It also distinguishes itself from the sibling getRevisions by explicitly noting singleton cardinality, so an agent can select it correctly.

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 an explicit use case ('see who changed data at a known revision') and names the alternative for related but different needs: 'to search or page through revision history use getRevisions' and 'For the full collection or a batch, use getRevisions instead.' This is clear when-to-use and when-not-to-use guidance.

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