Polarion MCP

Overview Schema Source Related Servers Discussions Admin

list_document_comments

Read-only

List comments from a Polarion document, including thread structure via parent and child comment IDs. Returns verbatim text, treat as untrusted when rendering.

Instructions

List a document's comments as a flat page.

Threads reconstruct via parent_comment_id (None = root) + child_comment_ids. text is verbatim, unsanitized — treat as untrusted when rendering.

Input Schema

TableJSON Schema

Name	Required	Description
`space_id`	Yes	Space ID ('_default' = default space).
`page_size`	No
`project_id`	Yes	Polarion project ID.
`page_number`	No
`document_name`	Yes	Document name within space_id.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`page`	Yes
`items`	Yes
`has_more`	No
`page_size`	Yes
`total_count`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedv2.0.0Jul 22, 2026

changedInput schema / properties / document_name / description

Previous value: -"Document name within ``space_id``."New value: +"Document name within space_id."

changedOutput schema / properties / items / items / description

Previous value: -"A single comment returned by the comment list tools."New value: +"Single comment from comment list tools."

removedOutput schema / properties / items / items / properties / author_id

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null
-}

addedOutput schema / properties / items / items / properties / author_name
```
Added value: +{
+  "default": "",
+  "type": "string"
+}
```

Changed4 schema fields changedv1.4.0Jun 26, 2026

changedInput schema / properties / document_name / description

Previous value: -"Document name within the space."New value: +"Document name within ``space_id``."

changedInput schema / properties / space_id / description

Previous value: -"Space ID containing the document (e.g. '_default')."New value: +"Space ID ('_default' = default space)."

changedOutput schema / properties / items / items / description

Previous value: -"A single document comment returned by ``list_document_comments``."New value: +"A single comment returned by the comment list tools."

addedOutput schema / properties / items / items / properties / title
```
Added value: +{
+  "default": "",
+  "type": "string"
+}
```

Changed13 schema fields changedv1.1.0Jun 9, 2026

removedInput schema / properties / page_number / description

Removed value: -"Page number to retrieve (1-based, default 1)."

removedInput schema / properties / page_size / description

Removed value: -"Number of comments per page (1-100, default 100)."

changedInput schema / properties / space_id / description

Previous value: -"Space ID that contains the document (use '_default' for the default space)."New value: +"Space ID containing the document (e.g. '_default')."

removedOutput schema / properties / has_more / description
```
Removed value: -"True if more pages follow."
```

changedOutput schema / properties / items / items / description

Previous value: -"A single document comment returned by ``list_document_comments``.\n\nComments form a tree: top-level comments have ``parent_comment_id=None``\nand replies link back via ``parent_comment_id`` while exposing their own\nreplies through ``child_comment_ids``. The list endpoint returns a flat\npage; rebuild the thread on the client side. ``text`` is returned\nverbatim with ``text_format`` indicating whether it is HTML or plain\ntext -- HTML is NOT sanitized, so it round-trips losslessly."New value: +"A single document comment returned by ``list_document_comments``."

removedOutput schema / properties / items / items / properties / author_id / description
```
Removed value: -"User ID of the author; None when unknown."
```
removedOutput schema / properties / items / items / properties / child_comment_ids / description
```
Removed value: -"Direct reply comment IDs in declaration order."
```
removedOutput schema / properties / items / items / properties / created / description
```
Removed value: -"ISO-8601 creation timestamp."
```
removedOutput schema / properties / items / items / properties / id / description
```
Removed value: -"Comment ID (e.g. 'MyCommentId')."
```
removedOutput schema / properties / items / items / properties / parent_comment_id / description
```
Removed value: -"Parent comment ID for replies; None on top-level."
```
removedOutput schema / properties / items / items / properties / resolved / description
```
Removed value: -"True when the comment is marked resolved."
```
removedOutput schema / properties / items / items / properties / text / description
```
Removed value: -"Comment body verbatim."
```
removedOutput schema / properties / items / items / properties / text_format / description
```
Removed value: -"MIME type of ``text`` as reported by Polarion."
```

First observedv0.9.0May 28, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations indicate readOnlyHint=true, consistent with listing. Description adds valuable detail: comments are returned as a flat page, threads via parent/child IDs, and text is unsanitized (security warning). Exceeds annotation info.

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?

Extremely concise: two sentences, no redundant words. Front-loaded with purpose, then threading and security warning. Every sentence adds value.

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?

For a read-only list tool with output schema present, description covers purpose, threading, and security. Sufficient for correct invocation and understanding.

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

Parameters2/5

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

Schema coverage is 60% (3/5 params described). Description does not enhance parameter understanding beyond schema; it mentions parent_comment_id but this is output behavior, not parameter detail. No compensation for missing schema descriptions.

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?

Description clearly states 'List a document's comments as a flat page.' with specific verb and resource. Explains threading via parent_comment_id and child_comment_ids, distinguishing it from sibling tools like list_work_item_comments.

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

Usage Guidelines2/5

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

No explicit guidance on when to use this tool vs. alternatives. The sibling list includes list_work_item_comments, but description does not differentiate or provide use cases.

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

Deploy Server

list_document_comments

Instructions

Input Schema

Output Schema

Schema Changelog

TDQS

Other Tools