Skip to main content
Glama

read_document_parts

Read-only

Retrieve structured parts of a document in order, including headings and work items with descriptions as Markdown, to support navigation and reorganization.

Instructions

List the structural parts of a document in order.

Use this when you need part IDs for move_work_item_to_document, heading levels, or per-work-item type/status. Each workitem part already carries its description as Markdown, so a follow-up get_work_item is unnecessary when scanning bodies. For plain reading prefer read_document.

If you only need work items filtered by type/status/title/custom-field or a subset of the document (e.g. "non-heading work items only"), prefer list_work_items with a SQL:(...) query — see that tool's docstring for a recipe gallery. Smaller payload than this tool, no per-part pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesPolarion project ID.
space_idYesSpace ID containing the document.
document_nameYesDocument name within the space.
page_sizeNoNumber of parts per page (1-100, default 100).
page_numberNoPage number to retrieve (1-based, default 1).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
total_countYes
pageYes
page_sizeYes
has_moreNoTrue if more pages follow.
Behavior4/5

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

Annotations provide readOnlyHint=true, which the description supports. The description adds that parts are in order, each workitem part carries its description as Markdown, and pagination is available via page_size/page_number. No contradictions. Minor gap: does not mention rate limits or auth requirements, but these are standard for the project.

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 concise (~120 words) and well-structured: purpose first, then usage guidelines, then alternatives. Every sentence adds value without redundancy. It is front-loaded with the core action.

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 complexity (5 params, output schema present), the description is complete. It covers purpose, when to use, alternatives, and a helpful detail about workitem descriptions. The output schema handles return documentation, so no further explanation is needed.

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?

All 5 parameters are described in the schema (100% coverage), so baseline is 3. The description adds value by explaining why part IDs are needed and how parameters like page_size relate to pagination. However, it doesn't add detailed semantics beyond schema descriptions, only use-case context.

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 clearly states the tool's purpose: 'List the structural parts of a document in order.' It uses a specific verb and resource. It distinguishes from siblings like read_document (plain reading) and list_work_items (filtered queries), making the intent unambiguous.

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 the tool (need part IDs for move_work_item, heading levels, per-work-item type/status) and when to prefer alternatives (read_document for plain reading, list_work_items for filtered subsets). It also advises against unnecessary get_work_item calls because descriptions are included.

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