Polarion MCP Server

getDocuments

Read-only

Lists documents within a single Polarion project, using a required project ID to scope results and optional query, fields, revision, and pagination parameters to filter and shape the response.

Instructions

Returns a list of Documents from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllDocuments instead. Examples: {"projectId":"myproject","query":"title:Plan","page[size]":20}. Selection: Use getDocuments when listing Documents in one project; use getAllDocuments to search across projects.

Input Schema

Name	Required	Description	Default
`sort`	No	Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`).
`query`	No	Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried.
`fields`	No	Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set.
`include`	No	Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource.
`revision`	No	A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision.
`max_items`	No	Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
`projectId`	Yes	The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
`page_size_`	No	Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set.
`page_number_`	No	1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page.
`response_format`	No	Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.	detailed

Output Schema

Name	Required	Description
`data`	No
`meta`	No
`links`	No
`included`	No	Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.4.4Oct 29, 2026

changedInput schema / properties / projectId / description

Previous value: -"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access."

Changed2 schema fields changedv1.4.0Oct 24, 2026

addedInput schema / properties / max_items

Added value: +{
+  "description": "Collect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.",
+  "maximum": 1000,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / response_format

Added value: +{
+  "default": "detailed",
+  "description": "Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed.",
+  "enum": [
+    "concise",
+    "detailed"
+  ],
+  "type": "string"
+}

Changed178 schema fields changedv1.3.1Oct 22, 2026
- changedOutput schema / properties / data / items / properties / attributes / properties / autoSuspect / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / branchedWithInitializedFields / items / example
```
Removed value: -"fieldId"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / branchedWithInitializedFields / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / branchedWithInitializedFields / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / branchedWithQuery / example
```
Removed value: -"Branched with Query"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / branchedWithQuery / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / created / example
```
Removed value: -"1970-01-01T00:00:00Z"
```
- removedOutput schema / properties / data / items / properties / attributes / properties / created / format
```
Removed value: -"date-time"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / created / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / derivedFields / items / example
```
Removed value: -"fieldId"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / derivedFields / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / derivedFields / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / derivedFromLinkRole / example
```
Removed value: -"relates_to"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / derivedFromLinkRole / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / type / enum
```
Removed value: -[
-  "text/html",
-  "text/plain"
-]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / value / example
```
Removed value: -"My text value"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / properties / value / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / homePageContent / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / moduleFolder / example
```
Removed value: -"MySpaceId"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / moduleFolder / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / moduleName / example
```
Removed value: -"MyDocumentId"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / moduleName / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / outlineNumbering / properties / prefix / example
```
Removed value: -"ABC"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / outlineNumbering / properties / prefix / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / outlineNumbering / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / label / example
```
Removed value: -"My label"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / label / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / layouter / example
```
Removed value: -"paragraph"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / layouter / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / key / example
```
Removed value: -"fieldsAtStart"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / key / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / value / example
```
Removed value: -"id"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / value / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / properties / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / type / example
```
Removed value: -"task"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / renderingLayouts / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / status / example
```
Removed value: -"draft"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / status / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / structureLinkRole / example
```
Removed value: -"relates_to"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / structureLinkRole / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / title / example
```
Removed value: -"Title"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / title / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / type / example
```
Removed value: -"req_specification"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / attributes / properties / updated / example
```
Removed value: -"1970-01-01T00:00:00Z"
```
- removedOutput schema / properties / data / items / properties / attributes / properties / updated / format
```
Removed value: -"date-time"
```
- changedOutput schema / properties / data / items / properties / attributes / properties / updated / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / properties / usesOutlineNumbering / type
```
Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / attributes / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
```
- changedOutput schema / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / links / properties / self / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
```
- changedOutput schema / properties / data / items / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / detail / example
```
Removed value: -"Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / detail / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / example
```
Removed value: -"revision"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / parameter / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / example
```
Removed value: -"$.data"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / pointer / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / example
```
Removed value: -"MyProjectId/id"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / example
```
Removed value: -"type"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / properties / resource / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / source / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / example
```
Removed value: -"400"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / status / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / example
```
Removed value: -"Bad Request"
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / properties / title / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / meta / properties / errors / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / type / enum
```
Removed value: -[
-  "document_attachments"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / links / properties / related / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / links / properties / related / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / meta / properties / totalCount / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / attachments / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / id / example
```
Removed value: -"MyUserId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / type / enum
```
Removed value: -[
-  "users"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / author / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / author / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / type / enum
```
Removed value: -[
-  "documents"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / branchedFrom / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / type / enum
```
Removed value: -[
-  "document_comments"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / links / properties / related / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / links / properties / related / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / meta / properties / totalCount / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / comments / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / type / enum
```
Removed value: -[
-  "documents"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / derivedFrom / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / id / example
```
Removed value: -"MyProjectId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / type / enum
```
Removed value: -[
-  "projects"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / project / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / project / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / id / example
```
Removed value: -"MyUserId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / type / enum
```
Removed value: -[
-  "users"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / updatedBy / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MyWorkItemId"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / type / enum
```
Removed value: -[
-  "workitems"
-]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / variant / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / properties / variant / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / items / properties / relationships / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / revision / example
```
Removed value: -"1234"
```
- changedOutput schema / properties / data / items / properties / revision / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / items / properties / type / enum
```
Removed value: -[
-  "documents"
-]
```
- changedOutput schema / properties / data / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / included / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / included / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / first / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1"
```
- changedOutput schema / properties / links / properties / first / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / last / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9"
```
- changedOutput schema / properties / links / properties / last / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / next / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6"
```
- changedOutput schema / properties / links / properties / next / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / prev / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4"
```
- changedOutput schema / properties / links / properties / prev / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / links / properties / self / example
```
Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5"
```
- changedOutput schema / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / meta / properties / totalCount / format
```
Removed value: -"int32"
```
- changedOutput schema / properties / meta / properties / totalCount / type
```
Previous value: -"integer"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / meta / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```

Changed8 schema fields changedv1.2.0Sep 17, 2026

changedInput schema / properties / fields / description

Previous value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set."

changedInput schema / properties / include / description

Previous value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."

changedInput schema / properties / page_number_ / description

Previous value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page."

changedInput schema / properties / page_size_ / description

Previous value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."

changedInput schema / properties / projectId / description

Previous value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."

changedInput schema / properties / query / description

Previous value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried."

changedInput schema / properties / revision / description

Previous value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."

changedInput schema / properties / sort / description

Previous value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "attributes": {
+            "properties": {
+              "autoSuspect": {
+                "type": "boolean"
+              },
+              "branchedWithInitializedFields": {
+                "items": {
+                  "example": "fieldId",
+                  "type": "string"
+                },
+                "type": "array"
+              },
+              "branchedWithQuery": {
+                "example": "Branched with Query",
+                "type": "string"
+              },
+              "created": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "derivedFields": {
+                "items": {
+                  "example": "fieldId",
+                  "type": "string"
+                },
+                "type": "array"
+              },
+              "derivedFromLinkRole": {
+                "example": "relates_to",
+                "type": "string"
+              },
+              "homePageContent": {
+                "properties": {
+                  "type": {
+                    "enum": [
+                      "text/html",
+                      "text/plain"
+                    ],
+                    "type": "string"
+                  },
+                  "value": {
+                    "example": "My text value",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "moduleFolder": {
+                "example": "MySpaceId",
+                "type": "string"
+              },
+              "moduleName": {
+                "example": "MyDocumentId",
+                "type": "string"
+              },
+              "outlineNumbering": {
+                "properties": {
+                  "prefix": {
+                    "example": "ABC",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "renderingLayouts": {
+                "items": {
+                  "properties": {
+                    "label": {
+                      "example": "My label",
+                      "type": "string"
+                    },
+                    "layouter": {
+                      "example": "paragraph",
+                      "type": "string"
+                    },
+                    "properties": {
+                      "items": {
+                        "properties": {
+                          "key": {
+                            "example": "fieldsAtStart",
+                            "type": "string"
+                          },
+                          "value": {
+                            "example": "id",
+                            "type": "string"
+                          }
+                        },
+                        "type": "object"
+                      },
+                      "type": "array"
+                    },
+                    "type": {
+                      "example": "task",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "status": {
+                "example": "draft",
+                "type": "string"
+              },
+              "structureLinkRole": {
+                "example": "relates_to",
+                "type": "string"
+              },
+              "title": {
+                "example": "Title",
+                "type": "string"
+              },
+              "type": {
+                "example": "req_specification",
+                "type": "string"
+              },
+              "updated": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "usesOutlineNumbering": {
+                "type": "boolean"
+              }
+            },
+            "type": "object"
+          },
+          "id": {
+            "example": "MyProjectId/MySpaceId/MyDocumentId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "meta": {
+            "properties": {
+              "errors": {
+                "items": {
+                  "properties": {
+                    "detail": {
+                      "description": "Human-readable explanation specific to this occurrence of the problem.",
+                      "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)",
+                      "type": "string"
+                    },
+                    "source": {
+                      "properties": {
+                        "parameter": {
+                          "description": "String indicating which URI query parameter caused the error.",
+                          "example": "revision",
+                          "type": "string"
+                        },
+                        "pointer": {
+                          "description": "JSON Pointer to the associated entity in the request document.",
+                          "example": "$.data",
+                          "type": "string"
+                        },
+                        "resource": {
+                          "description": "Resource causing the error.",
+                          "properties": {
+                            "id": {
+                              "example": "MyProjectId/id",
+                              "type": "string"
+                            },
+                            "type": {
+                              "example": "type",
+                              "type": "string"
+                            }
+                          },
+                          "type": "object"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "status": {
+                      "description": "HTTP status code applicable to this problem.",
+                      "example": "400",
+                      "type": "string"
+                    },
+                    "title": {
+                      "description": "Short, human-readable summary of the problem.",
+                      "example": "Bad Request",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              }
+            },
+            "type": "object"
+          },
+          "relationships": {
+            "properties": {
+              "attachments": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "document_attachments"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "links": {
+                    "properties": {
+                      "related": {
+                        "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234",
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "author": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyUserId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "users"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "branchedFrom": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "comments": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "document_comments"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "links": {
+                    "properties": {
+                      "related": {
+                        "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234",
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "derivedFrom": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "project": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "projects"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "updatedBy": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyUserId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "users"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "variant": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MyWorkItemId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "workitems"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "revision": {
+            "example": "1234",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "documents"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "included": {
+      "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.",
+      "items": {
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "links": {
+      "properties": {
+        "first": {
+          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1",
+          "type": "string"
+        },
+        "last": {
+          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9",
+          "type": "string"
+        },
+        "next": {
+          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6",
+          "type": "string"
+        },
+        "prev": {
+          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4",
+          "type": "string"
+        },
+        "self": {
+          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "meta": {
+      "properties": {
+        "totalCount": {
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

AddedSep 7, 2026

TDQS

A4.3/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is known; the description adds only the single-project scoping constraint and a sample call. It says nothing about pagination behavior, how max_items interacts with page_size, or what the default result set looks like — details that live in the schema rather than here.

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?

Front-loaded with the core behavior and scope, then the alternative, then an example — good ordering. The final 'Selection:' sentence mostly restates the second sentence, so a small amount of the text does not earn its place.

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

Completeness4/5

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

With a full input schema, an output schema, and read-only/open-world annotations, the description only needs to convey scope and sibling selection — which it does. The one gap is that it never mentions pagination defaults or the max_items cross-page collection behavior, though the schema covers those.

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%, so the baseline is 3; the description earns above that by supplying a concrete example ({"projectId":"myproject","query":"title:Plan","page[size]":20}) that demonstrates how the required id, a Lucene filter, and a page size combine in practice.

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?

States a specific verb and resource ('Returns a list of Documents') plus an explicit scope limit ('one project, requires a project ID'). Names the sibling it is not — getAllDocuments — so an agent can distinguish the two without opening either schema.

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?

Explicitly routes the agent: use getDocuments for one project, getAllDocuments to search across projects, with the condition spelled out twice (scope line and the 'Selection' line). No inference about alternatives is required.

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

Deploy Server