Skip to main content
Glama

get_document

Read-only

Retrieve a document's metadata from Polarion, including title, type, status, and custom fields. Optionally fetch its raw HTML body for round-trip editing.

Instructions

Get a document's metadata (and optionally its raw body source).

Returns title/type/status/custom fields. With include_homepage_content_html=True, content_html carries homePageContent as raw HTML — the round-trip shape for update_document. homePageContent is inline prose only (headings and embedded work items are separate); use read_document end-to-end. Feed content_html back only when the flag was True (False blanks it; "" rejected on write).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesPolarion project ID.
space_idYesSpace ID containing the document (e.g. '_default').
document_nameYesDocument name within the space (spaces handled automatically).
include_homepage_content_htmlNoWhen True, fill ``content_html`` with raw HTML for round-trip editing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
typeNo
statusNo
content_htmlNo
custom_fieldsNo
Behavior5/5

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

Discloses behavior beyond readOnlyHint: details what include_homepage_content_html does, the nature of homePageContent (inline prose only), and constraints on feeding back content_html. No contradiction with 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?

Three sentences with front-loaded purpose. Every sentence adds value; no wasted words. Efficiently structured for quick understanding.

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 the presence of an output schema, the description covers all necessary behavioral and usage context for an agent. Includes caveats about content_html usage and differentiation from related tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. Description adds value by explaining that include_homepage_content_html fills content_html for round-trip editing and that feeding back should be conditional. Other parameters are adequately covered by 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?

Clearly states the verb 'Get' and resource 'document's metadata (and optionally its raw body source)'. Differentiates from siblings like read_document and update_document by specifying the scope.

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?

Explicitly describes when to use this tool vs alternatives: recommends read_document for end-to-end reading, and warns about feeding back content_html only when the flag was True. Provides clear context for usage.

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/devemberx/mcp-server-polarion'

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