read_work_item
Read-only
Retrieve a Polarion work item with its description converted to Markdown for easy reading or summarization by an LLM.
Instructions
Read a Polarion work item with its body rendered as Markdown.
Synthesis variant of get_work_item: returns the same metadata
fields plus description as Markdown (converted from Polarion
HTML via html_to_markdown()) instead of description_html.
Use this when an LLM needs to read or summarise the body. The
converter collapses Polarion-specific spans and ID anchors, so the
Markdown is read-only — do NOT feed it back to update_work_item.
For round-trip editing, pair
get_work_item(include_description_html=True) with
update_work_item(description_html=...).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Polarion project ID. | |
| work_item_id | Yes | Work Item ID (e.g. 'MCPT-001'). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Work Item ID (e.g. 'MCPT-001'). | |
| title | Yes | Work Item title. | |
| type | Yes | Work Item type (e.g. 'requirement', 'testCase'). | |
| status | Yes | Workflow status (e.g. 'draft', 'approved'). | |
| priority | No | Priority value as a string (e.g. '90.0'); empty when unset. | |
| updated | No | ISO-8601 last-modified timestamp; empty when unreported. | |
| space_id | No | Containing document's space; empty when free-floating. | |
| document_name | No | Containing document name; empty when free-floating. | |
| assignee_ids | No | Short user IDs of assignees; empty list when unassigned. | |
| description | No | Body as Markdown; read-only — do NOT feed to update_work_item. | |
| project_id | Yes | Project that contains this work item. | |
| author_id | No | Short user ID of the author; empty when unreported. | |
| created | No | ISO-8601 creation timestamp; empty when unreported. | |
| resolution | No | Resolution outcome (e.g. 'fixed'); empty when unresolved. | |
| severity | No | Severity classification (e.g. 'critical'); empty for non-defects. | |
| outline_number | No | Hierarchical position (e.g. '1.2.3'); empty outside a document. | |
| hyperlinks | No | External hyperlinks attached to this work item. | |
| custom_fields | No | Project-defined custom fields keyed by field ID. |