Skip to main content
Glama

get_work_item

Read-only

Fetch full work item details by ID from Polarion, with optional raw HTML description for round-trip editing and updates.

Instructions

Get full details of one work item by ID.

include_description_html=True fills description_html with raw HTML — the required source for update_work_items description_html. Never feed back a blanked (flag=False) body.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesPolarion project ID.
work_item_idYesWork item ID (e.g. 'MCPT-001').
include_description_htmlNoFill description_html with raw HTML for round-trip editing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
typeYes
titleYes
statusYes
createdNo
updatedNo
priorityNo
severityNo
space_idNo
author_idNo
hyperlinksNo
project_idYes
resolutionNo
author_nameNo
assignee_idsNo
custom_fieldsNo
document_nameNo
assignee_namesNo
outline_numberNo
description_htmlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.0.0
    • changedInput schema / properties / include_description_html / description
      Previous value: -"Fill ``description_html`` with raw HTML for round-trip editing."New value: +"Fill description_html with raw HTML for round-trip editing."
    • changedOutput schema / description
      Previous value: -"Full work-item details returned by ``get_work_item``."New value: +"Full work-item detail from ``get_work_item``."
    • addedOutput schema / properties / assignee_names
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / author_name
      Added value: +{
      +  "default": "",
      +  "type": "string"
      +}
    • changedOutput schema / properties / hyperlinks / items / description
      Previous value: -"A single external hyperlink attached to a work item."New value: +"Single external hyperlink on a work item."
  2. Changed1 schema field changedv1.4.1
    • addedOutput schema / properties / hyperlinks / items / additionalProperties
      Added value: +false
  3. Changed2 schema fields changedv1.4.0
    • changedInput schema / properties / include_description_html / description
      Previous value: -"When True, fill ``description_html`` with raw HTML for round-trip editing."New value: +"Fill ``description_html`` with raw HTML for round-trip editing."
    • changedInput schema / properties / work_item_id / description
      Previous value: -"Work Item ID (e.g. 'MCPT-001')."New value: +"Work item ID (e.g. 'MCPT-001')."
  4. Changed22 schema fields changedv1.1.0
    • changedOutput schema / description
      Previous value: -"Full work-item details returned by ``get_work_item``.\n\nExtends ``WorkItemSummary`` with the description, project context,\nand detail-only metadata (authorship, resolution, severity, outline\nposition, external hyperlinks).\n\n``description_html`` is the round-trip pair for\n``update_work_item(description_html=...)`` and must never pass through\na Markdown converter or sanitizer — doing so strips Polarion-specific\nspans and breaks the round-trip. ``custom_fields`` keeps rich-text\nvalues as ``{'type': 'text/html', 'value': '<...>'}`` dicts so the\nshape round-trips back unchanged."New value: +"Full work-item details returned by ``get_work_item``."
    • removedOutput schema / properties / assignee_ids / description
      Removed value: -"Short user IDs of assignees; empty list when unassigned."
    • removedOutput schema / properties / author_id / description
      Removed value: -"Short user ID of the author; empty when unreported."
    • removedOutput schema / properties / created / description
      Removed value: -"ISO-8601 creation timestamp; empty when unreported."
    • removedOutput schema / properties / custom_fields / description
      Removed value: -"Project-defined custom fields keyed by field ID."
    • removedOutput schema / properties / description_html / description
      Removed value: -"Raw Polarion HTML body; empty unless the read flag was True."
    • removedOutput schema / properties / document_name / description
      Removed value: -"Containing document name; empty when free-floating."
    • removedOutput schema / properties / hyperlinks / description
      Removed value: -"External hyperlinks attached to this work item."
    • removedOutput schema / properties / hyperlinks / items / properties / role / description
      Removed value: -"Hyperlink role id (e.g. 'ref_ext')."
    • removedOutput schema / properties / hyperlinks / items / properties / title / description
      Removed value: -"Human-readable link title; empty when unset."
    • removedOutput schema / properties / hyperlinks / items / properties / uri / description
      Removed value: -"Target URI of the hyperlink."
    • removedOutput schema / properties / id / description
      Removed value: -"Work Item ID (e.g. 'MCPT-001')."
    • removedOutput schema / properties / outline_number / description
      Removed value: -"Hierarchical position (e.g. '1.2.3'); empty outside a document."
    • removedOutput schema / properties / priority / description
      Removed value: -"Priority value as a string (e.g. '90.0'); empty when unset."
    • removedOutput schema / properties / project_id / description
      Removed value: -"Project that contains this work item."
    • removedOutput schema / properties / resolution / description
      Removed value: -"Resolution outcome (e.g. 'fixed'); empty when unresolved."
    • removedOutput schema / properties / severity / description
      Removed value: -"Severity classification (e.g. 'critical'); empty for non-defects."
    • removedOutput schema / properties / space_id / description
      Removed value: -"Containing document's space; empty when free-floating."
    • removedOutput schema / properties / status / description
      Removed value: -"Workflow status (e.g. 'draft', 'approved')."
    • removedOutput schema / properties / title / description
      Removed value: -"Work Item title."
    • removedOutput schema / properties / type / description
      Removed value: -"Work Item type (e.g. 'requirement', 'testCase')."
    • removedOutput schema / properties / updated / description
      Removed value: -"ISO-8601 last-modified timestamp; empty when unreported."
  5. First observedv0.9.0

TDQS

A3.9/5.0
Behavior4/5

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

Does not contradict annotations (readOnlyHint=true). Adds behavioral context about the include_description_html parameter and the caution regarding blanked bodies, which goes beyond the annotation.

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?

Two short sentences, front-loaded with the main purpose. The second sentence, while technical, is relevant. No unnecessary filler.

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

Completeness3/5

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

Covers purpose and key parameter behavior. With an output schema, return values need not be described. However, lacking differentiation from read_work_item and no mention of error handling or permissions leaves some gaps.

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% with descriptions for all three parameters. The description adds extra meaning for include_description_html, noting it is the required source for update_work_items, enriching the schema baseline of 3.

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

Purpose4/5

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

Description clearly states the tool gets full details of one work item by ID. However, it does not differentiate from sibling 'read_work_item', which may have overlapping functionality.

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

Usage Guidelines4/5

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

Explicitly mentions that include_description_html is required for update_work_items and warns against feeding back a blanked body. Provides partial usage guidance but does not contrast with siblings like read_work_item.

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