Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getPageAttachmentContent

Read-only

Retrieve the raw file content of a Rich Page attachment as UTF-8 text, making plain-text files (TXT, CSV, XML, JSON, HTML) readable. For binary files (images, PDF, Office), use metadata endpoints instead.

Instructions

Downloads the raw file content of one Rich Page attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getPageAttachment, and to discover attachment IDs call getPageAttachments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spaceIdYesThe Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
pageNameYesThe Rich Page's ID/name within its space — its stable identifier, not its display title.
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.
projectIdYesThe 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.
attachmentIdYesThe attachment's ID, as returned by the corresponding list- or get-attachments call for this resource.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.2.0
    • changedInput schema / properties / attachmentId / description
      Previous value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource."
    • changedInput schema / properties / pageName / description
      Previous value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title."
    • 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."
    • changedInput schema / properties / spaceId / description
      Previous value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
  2. 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 is not burdened with establishing read-only safety. It adds valuable behavioral detail beyond annotations: the file body is returned as UTF-8 text, plain-text formats are readable, and binary formats arrive garbled. This gives the agent realistic expectations about output quality.

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 sentences with no filler. The core action is stated first, the critical encoding limitation follows, and the routing guidance to sibling tools closes it. Every sentence earns its place and the structure is easy to scan.

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?

Given no output schema, the description compensates by explaining the return format and its limitations. It also covers how to obtain both metadata and attachment IDs, which are the obvious prerequisite lookup steps. For a read-only download tool with five well-documented parameters, nothing essential 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 description coverage is 100%, so the schema already documents all parameters including projectId, spaceId, pageName, attachmentId, and revision. The description adds only modest value by explaining the attachmentId origin indirectly via getPageAttachments, but it does not need to because the schema is complete.

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 uses a specific verb ('Downloads the raw file content') and names the exact resource ('one Rich Page attachment'). It clearly distinguishes itself from sibling tools by contrasting with getPageAttachment for metadata and getPageAttachments for discovering IDs, so an agent can disambiguate at a glance.

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 explicitly states when to use this tool ('only when you need the file's bytes') and names the alternatives with their purposes (getPageAttachment for metadata, getPageAttachments for attachment IDs). It also warns about binary-file limitations, which helps the agent decide whether this tool is appropriate for the task.

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