Skip to main content
Glama
phillipboesger

Polarion MCP Server

getCurrentUser

Read-only

Retrieves the authenticated Polarion user. Optionally select specific fields, embed related resources, or read the user at a past revision.

Instructions

Returns the current User.

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.

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": {
      +            "avatarUrl": {
      +              "example": "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234",
      +              "type": "string"
      +            },
      +            "description": {
      +              "properties": {
      +                "type": {
      +                  "enum": [
      +                    "text/plain"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "example": "My text value",
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "disabledNotifications": {
      +              "type": "boolean"
      +            },
      +            "email": {
      +              "example": "Email",
      +              "type": "string"
      +            },
      +            "id": {
      +              "example": "MyUserId",
      +              "type": "string"
      +            },
      +            "initials": {
      +              "example": "Initials",
      +              "type": "string"
      +            },
      +            "name": {
      +              "example": "Name",
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "id": {
      +          "example": "MyUserId",
      +          "type": "string"
      +        },
      +        "links": {
      +          "properties": {
      +            "self": {
      +              "example": "server-host-name/application-path/users/MyUserId",
      +              "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": {
      +            "addOnLicenseSlots": {
      +              "properties": {
      +                "data": {
      +                  "items": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "LicenseType/ModelType/GroupId",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "license_slots"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "meta": {
      +                  "properties": {
      +                    "totalCount": {
      +                      "format": "int32",
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "baseLicenseSlot": {
      +              "properties": {
      +                "data": {
      +                  "properties": {
      +                    "id": {
      +                      "example": "LicenseType/ModelType/GroupId",
      +                      "type": "string"
      +                    },
      +                    "type": {
      +                      "enum": [
      +                        "license_slots"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "globalRoles": {
      +              "properties": {
      +                "data": {
      +                  "items": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyRoleId",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "globalroles"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "meta": {
      +                  "properties": {
      +                    "totalCount": {
      +                      "format": "int32",
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "projectRoles": {
      +              "properties": {
      +                "data": {
      +                  "items": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyProjectId/MyRoleId",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "projectroles"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "meta": {
      +                  "properties": {
      +                    "totalCount": {
      +                      "format": "int32",
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "userGroups": {
      +              "properties": {
      +                "data": {
      +                  "items": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyUserGroupId",
      +                        "type": "string"
      +                      },
      +                      "revision": {
      +                        "example": "1234",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "usergroups"
      +                        ],
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "meta": {
      +                  "properties": {
      +                    "totalCount": {
      +                      "format": "int32",
      +                      "type": "integer"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "revision": {
      +          "example": "1234",
      +          "type": "string"
      +        },
      +        "type": {
      +          "enum": [
      +            "users"
      +          ],
      +          "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/users/MyUserId",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Added

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare readOnlyHint and openWorldHint, so the read-only nature is covered. The description adds only the 'current User' scoping and does not explain authentication requirements, what 'current' means, or how the revision parameter affects the result, but it does not contradict the annotations.

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 a single sentence with no filler or redundant words. 'Returns the current User.' is appropriately front-loaded and every word earns its place.

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?

Given the readOnlyHint, complete parameter schema, and existing output schema, the description largely suffices for a simple read-only tool. It falls just short of a 5 by not explicitly differentiating from getUser/getUsers or providing authentication context.

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%, with fields, include, and revision each fully documented. The description itself adds no additional parameter semantics, so it meets the baseline without needing to repeat schema details.

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

Purpose4/5

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

The description uses a specific verb ('Returns') and names a clear resource ('current User'), so an agent knows exactly what object is being retrieved. The word 'current' distinguishes it from sibling tools like getUser/getUsers, though it does not explicitly name them.

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

Usage Guidelines3/5

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

The description provides no explicit when-to-use or when-not-to-use guidance, and it does not mention alternatives such as getUser/getUsers for retrieving other users. The phrase 'current User' is the only implied usage signal: use this when you need the current caller's identity.

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