Skip to main content
Glama
phillipboesger

Polarion MCP Server

getDocumentPart

Retrieves a specific document part by its ID from a Polarion project space, with options to filter fields and include related entities.

Instructions

Returns the specified Document Part.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesThe Project ID.
spaceIdYesThe Space ID. (Use '_default' without quotes to address the default Space.)
documentNameYesThe Document name.
partIdYesThe Document Part ID.
fieldsNoFilter 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.
includeNoInclude 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.
revisionNoThe revision ID.
Behavior2/5

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

With no annotations, the description carries full burden. It only says 'Returns', implying read-only, but does not disclose any behavioral traits like authentication needs, rate limits, or idempotency concerns. Minimal value beyond the structured fields.

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?

The description is extremely concise with one clear sentence. It is front-loaded, but could optionally include more context without becoming overly long.

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

Completeness2/5

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

Given 7 parameters including nested objects, and no output schema, the description does not explain return values, pagination, or behavior when fields are omitted. It is inadequate for a tool of this complexity.

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%, so parameters are well-documented in the schema. The description adds no additional meaning beyond the schema, so baseline of 3 is appropriate.

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

Purpose3/5

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

The description states it returns a specified Document Part, which is clear but does not differentiate from sibling tools like getDocumentParts. It lacks specificity about what a 'Document Part' is in relation to other documents.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives such as getDocument, getDocumentParts, or getDocumentAttachment. There are no exclusions or context for appropriate use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/phillipboesger/polarion-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server