Skip to main content
Glama

getPageAttachments

Read-only

Lists attachments for a Polarion Rich Page or a batch of pages, with pagination and revision options for collection-level retrieval.

Instructions

Returns a list of Page Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageAttachment instead.

Input Schema

NameRequiredDescriptionDefault
fieldsNoSparse 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.
includeNoComma-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.
spaceIdYesThe Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
pageNameYesThe Rich Page's ID/name within its space — its stable identifier, not its display title.
revisionNoA 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_itemsNoCollect up to this many results across pages (maximum 1000). Omit to fetch only the requested page, as before.
projectIdYesThe 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_NoMaximum 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_No1-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_formatNoResponse 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

NameRequiredDescriptionDefault
dataNo
metaNo
linksNo
includedNoRelated 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.

  1. Changed1 schema field changedv1.4.4
    • 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."
  2. Changed2 schema fields changedv1.4.0
    • 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"
      +}
  3. Changed77 schema fields changedv1.3.1
    • removedOutput schema / properties / data / items / properties / attributes / properties / fileName / example
      Removed value: -"File Name"
    • changedOutput schema / properties / data / items / properties / attributes / properties / fileName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / id / example
      Removed value: -"MyAttachmentId"
    • changedOutput schema / properties / data / items / properties / attributes / properties / id / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "number",
      +  "integer",
      +  "boolean",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / attributes / properties / length / format
      Removed value: -"int32"
    • changedOutput schema / properties / data / items / properties / attributes / properties / length / type
      Previous value: -"integer"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 / 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 / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • removedOutput schema / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
    • 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 / content / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234"
    • changedOutput schema / properties / data / items / properties / links / properties / content / 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/pages/MyRichPageId/attachments/MyAttachmentId?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 / 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 / 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"
      +]
    • 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: -[
      -  "page_attachments"
      -]
    • 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/pages/MyRichPageId/attachments?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/pages/MyRichPageId/attachments?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/pages/MyRichPageId/attachments?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/pages/MyRichPageId/attachments?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/pages/MyRichPageId/attachments?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"
      +]
  4. Changed8 schema fields changedv1.2.0
    • 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 / pageName / description
      Previous value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title."
    • 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 / 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 / spaceId / description
      Previous value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
  5. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "properties": {
      +          "attributes": {
      +            "properties": {
      +              "fileName": {
      +                "example": "File Name",
      +                "type": "string"
      +              },
      +              "id": {
      +                "example": "MyAttachmentId",
      +                "type": "string"
      +              },
      +              "length": {
      +                "format": "int32",
      +                "type": "integer"
      +              },
      +              "title": {
      +                "example": "Title",
      +                "type": "string"
      +              },
      +              "updated": {
      +                "example": "1970-01-01T00:00:00Z",
      +                "format": "date-time",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "id": {
      +            "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId",
      +            "type": "string"
      +          },
      +          "links": {
      +            "properties": {
      +              "content": {
      +                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234",
      +                "type": "string"
      +              },
      +              "self": {
      +                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?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": {
      +              "author": {
      +                "properties": {
      +                  "data": {
      +                    "properties": {
      +                      "id": {
      +                        "example": "MyUserId",
      +                        "type": "string"
      +                      },
      +                      "revision": {
      +                        "example": "1234",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "enum": [
      +                          "users"
      +                        ],
      +                        "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"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "revision": {
      +            "example": "1234",
      +            "type": "string"
      +          },
      +          "type": {
      +            "enum": [
      +              "page_attachments"
      +            ],
      +            "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/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1",
      +          "type": "string"
      +        },
      +        "last": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9",
      +          "type": "string"
      +        },
      +        "next": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6",
      +          "type": "string"
      +        },
      +        "prev": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4",
      +          "type": "string"
      +        },
      +        "self": {
      +          "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "meta": {
      +      "properties": {
      +        "totalCount": {
      +          "format": "int32",
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  6. Added

TDQS

A3.8/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 covered. The description adds the collection/batch cardinality hint but says nothing about pagination behavior, large result handling, or the effect of paging parameters, leaving some behavioral gaps.

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 with the purpose and the sibling alternative front-loaded; there is no filler. The 'Cardinality: targets the full collection or a batch' phrasing is slightly jargon-heavy but still earns its place.

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?

Given a rich schema, existing output schema, and annotations, the description is adequate for selection but minimal. It omits any guidance on paging, sparse fieldsets, or embedding related resources, relying entirely on the schema for the 10-parameter surface.

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

Parameters3/5

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

Schema description coverage is 100%, so every parameter (fields, include, revision, max_items, paging, response_format) is already documented in the schema. The description adds no additional parameter meaning beyond the list-vs-single distinction, so the baseline 3 applies.

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 Page Attachments') and immediately distinguishes the tool from its single-item sibling getPageAttachment. An agent can identify its role without opening the schema.

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 names the alternative for the single-item case ('use getPageAttachment instead'), giving clear routing guidance. It does not discuss when to prefer batch vs. full collection other than the cardinality hint, so it falls just short of a 5.

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

Deploy Server

Other Tools