read_document
Synthesize a Polarion document's body into flowing Markdown, combining headings, work-item descriptions, and inline prose. For read-only retrieval, not for editing.
Instructions
Render a Polarion document end-to-end as flowing Markdown.
Paginates read_document_parts internally and interleaves heading
titles, embedded work-item descriptions, and inline prose into a
single Markdown stream — the canonical way to read a document body.
Empty placeholder paragraphs are skipped.
Output is read-only synthesis: do NOT feed it back to update_document
(the rendered Markdown collapses Polarion's ID-anchored placeholder
structure and the round-trip would orphan headings). Use
get_document(include_homepage_content_html=True) for round-trip
editing of the raw HTML source.
For metadata-only extraction (work item IDs / types / statuses /
custom fields) prefer list_work_items with a SQL:(...) query
— this tool always materializes the full body Markdown for every
part, which is wasteful when the caller only wants a filtered list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Polarion project ID. | |
| space_id | Yes | Space ID containing the document. | |
| document_name | Yes | Document name within the space. | |
| page_size | No | Number of parts per page (1-100, default 100). | |
| page_number | No | Page number to retrieve (1-based, default 1). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | Rendered Markdown for this page. | |
| part_count | Yes | Number of parts consumed on this page. | |
| page | Yes | Current page number (1-based). | |
| page_size | Yes | Maximum number of parts per page. | |
| total_parts | Yes | Total parts across the entire document. | |
| has_more | No | True when more pages of parts follow. |