Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

getAllWorkItems

Read-only

Fetch work items from all Polarion projects in one call, with optional filters, sorting, and pagination to control output. Use when you need data across the entire instance without specifying a project.

Instructions

Returns a list of Work Items from all Projects. Scope: spans every project (no project filter). To act on a single project, use getWorkItems instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoComma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`).
queryNoPolarion 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.
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.
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.
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.

Output Schema

TableJSON 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. Changed7 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 / 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 / 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`)."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "attributes": {
+            "properties": {
+              "created": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "description": {
+                "properties": {
+                  "type": {
+                    "enum": [
+                      "text/html",
+                      "text/plain"
+                    ],
+                    "type": "string"
+                  },
+                  "value": {
+                    "example": "My text value",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "dueDate": {
+                "example": "1970-01-01",
+                "format": "date",
+                "type": "string"
+              },
+              "hyperlinks": {
+                "items": {
+                  "properties": {
+                    "role": {
+                      "example": "ref_ext",
+                      "type": "string"
+                    },
+                    "title": {
+                      "example": "Title",
+                      "type": "string"
+                    },
+                    "uri": {
+                      "example": "https://polarion.plm.automation.siemens.com",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "id": {
+                "example": "MyWorkItemId",
+                "type": "string"
+              },
+              "initialEstimate": {
+                "example": "5 1/2d",
+                "type": "string"
+              },
+              "outlineNumber": {
+                "example": "1.11",
+                "type": "string"
+              },
+              "plannedEnd": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "plannedStart": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "priority": {
+                "example": "90.0",
+                "type": "string"
+              },
+              "remainingEstimate": {
+                "example": "5 1/2d",
+                "type": "string"
+              },
+              "resolution": {
+                "example": "done",
+                "type": "string"
+              },
+              "resolvedOn": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              },
+              "severity": {
+                "example": "blocker",
+                "type": "string"
+              },
+              "status": {
+                "example": "open",
+                "type": "string"
+              },
+              "timeSpent": {
+                "example": "5 1/2d",
+                "type": "string"
+              },
+              "title": {
+                "example": "Title",
+                "type": "string"
+              },
+              "type": {
+                "example": "task",
+                "type": "string"
+              },
+              "updated": {
+                "example": "1970-01-01T00:00:00Z",
+                "format": "date-time",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "id": {
+            "example": "MyProjectId/MyWorkItemId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "portal": {
+                "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234",
+                "type": "string"
+              },
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?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": {
+              "approvals": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/MyUserId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "workitem_approvals"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "assignee": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyUserId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "users"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "attachments": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/MyAttachmentId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "workitem_attachments"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "links": {
+                    "properties": {
+                      "related": {
+                        "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/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"
+              },
+              "backlinkedWorkItems": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "linkedworkitems"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "categories": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyCategoryId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "categories"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "comments": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/MyCommentId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "workitem_comments"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "links": {
+                    "properties": {
+                      "related": {
+                        "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234",
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "externallyLinkedWorkItems": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "externallylinkedworkitems"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "linkedOslcResources": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "linkedoslcresources"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "linkedRevisions": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "default/1234",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "revisions"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "linkedWorkItems": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "linkedworkitems"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "links": {
+                    "properties": {
+                      "related": {
+                        "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234",
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "module": {
+                "properties": {
+                  "data": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "revision": {
+                        "example": "1234",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "plannedIn": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyPlanId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "plans"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "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"
+              },
+              "testSteps": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "teststeps"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "votes": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyUserId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "users"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "watches": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyUserId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "users"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "workRecords": {
+                "properties": {
+                  "data": {
+                    "items": {
+                      "properties": {
+                        "id": {
+                          "example": "MyProjectId/MyWorkItemId/MyWorkRecordId",
+                          "type": "string"
+                        },
+                        "revision": {
+                          "example": "1234",
+                          "type": "string"
+                        },
+                        "type": {
+                          "enum": [
+                            "workrecords"
+                          ],
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "meta": {
+                    "properties": {
+                      "totalCount": {
+                        "format": "int32",
+                        "type": "integer"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          },
+          "revision": {
+            "example": "1234",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "workitems"
+            ],
+            "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/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=1",
+          "type": "string"
+        },
+        "last": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=9",
+          "type": "string"
+        },
+        "next": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=6",
+          "type": "string"
+        },
+        "portal": {
+          "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitems",
+          "type": "string"
+        },
+        "prev": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=4",
+          "type": "string"
+        },
+        "self": {
+          "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=5",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "meta": {
+      "properties": {
+        "totalCount": {
+          "format": "int32",
+          "type": "integer"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  3. Changed6 schema fields changed
    • changedInput schema / properties / fields / description
      Previous value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New 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."
    • changedInput schema / properties / include / description
      Previous value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New 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."
    • removedInput schema / properties / page_number
      Removed value: -{
-  "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
-  "format": "int32",
-  "type": "number"
-}
    • addedInput schema / properties / page_number_
      Added value: +{
+  "description": "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.",
+  "format": "int32",
+  "type": "number"
+}
    • removedInput schema / properties / page_size
      Removed value: -{
-  "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.",
-  "format": "int32",
-  "type": "number"
-}
    • addedInput schema / properties / page_size_
      Added value: +{
+  "description": "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.",
+  "format": "int32",
+  "type": "number"
+}
  4. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

The readOnlyHint annotation already communicates safety, and the description adds a meaningful behavioral boundary: the tool spans all projects and deliberately accepts no project filter. It does not restate the annotation, and there is no contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler: the core behavior and scope are stated first, followed by a precise pointer to the alternative. Every sentence earns its place.

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

Completeness5/5

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

The description is complete for a read-only list tool: annotations cover safety, the rich input schema covers all seven parameters, an output schema exists, and the sibling distinction is explicit. Nothing needed for correct selection or invocation is missing.

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%, and every parameter already has a detailed explanation. The tool description adds no additional parameter semantics, so the baseline score of 3 is appropriate.

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

Purpose5/5

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

The description uses a specific verb and resource ('Returns a list of Work Items') and immediately distinguishes itself from 'getWorkItems' by stating the scope spans every project with no project filter. An agent can unambiguously tell this tool apart from its sibling.

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?

It explicitly states when to use this tool (when you need work items spanning all projects) and when not to, directing the agent to 'getWorkItems' for single-project scope. This is clear, actionable routing guidance.

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