Skip to main content
Glama

deleteWorkItemsRelationship

DestructiveIdempotent

Removes a named JSON:API relationship from a Work Item to update linkage without deleting related items. Use dry_run first to validate and preview the irreversible request.

Instructions

Removes one named JSON:API relationship from a Work Item; this edits linkage and does not delete related Work Items. Use getWorkItemsRelationships to inspect raw linkage or linked-work-item tools for link roles and related item details. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Input Schema

NameRequiredDescriptionDefault
dry_runNoIf true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it.
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.
workItemIdYesThe Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads.
requestBodyYesThe Relationship body.
relationshipIdYesThe relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry.

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. Changed1 schema field changedv1.2.2
    • changedInput schema / properties / relationshipId / description
      Previous value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
  3. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / dry_run / description
      Previous value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
    • 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 / relationshipId / description
      Previous value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
    • changedInput schema / properties / workItemId / description
      Previous value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
  4. Changed2 schema fields changed
    • addedInput schema / properties / dry_run
      Added value: +{
      +  "description": "If true, validate and return the request that would be sent without calling Polarion.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / requestBody / properties / data / items / properties / type / enum
      Previous value: -[
      -  "categories",
      -  "documents",
      -  "document_attachments",
      -  "document_comments",
      -  "document_parts",
      -  "enumerations",
      -  "globalroles",
      -  "icons",
      -  "jobs",
      -  "linkedworkitems",
      -  "externallylinkedworkitems",
      -  "linkedoslcresources",
      -  "pages",
      -  "page_attachments",
      -  "plans",
      -  "projectroles",
      -  "projectgroups",
      -  "projects",
      -  "projecttemplates",
      -  "spaces",
      -  "testparameters",
      -  "testparameter_definitions",
      -  "testrecords",
      -  "teststep_results",
      -  "testruns",
      -  "testrun_attachments",
      -  "teststepresult_attachments",
      -  "testrun_comments",
      -  "usergroups",
      -  "users",
      -  "workitems",
      -  "workitem_attachments",
      -  "workitem_approvals",
      -  "workitem_comments",
      -  "featureselections",
      -  "teststeps",
      -  "workrecords",
      -  "revisions",
      -  "testrecord_attachments"
      -]New value: +[
      +  "collections",
      +  "categories",
      +  "documents",
      +  "document_attachments",
      +  "document_comments",
      +  "document_parts",
      +  "enumerations",
      +  "globalroles",
      +  "icons",
      +  "jobs",
      +  "linkedworkitems",
      +  "externallylinkedworkitems",
      +  "linkedoslcresources",
      +  "llms",
      +  "pages",
      +  "page_attachments",
      +  "page_comments",
      +  "plans",
      +  "projectroles",
      +  "projectgroups",
      +  "projects",
      +  "projecttemplates",
      +  "spaces",
      +  "testparameters",
      +  "testparameter_definitions",
      +  "testrecords",
      +  "teststep_results",
      +  "testruns",
      +  "testrun_attachments",
      +  "teststepresult_attachments",
      +  "testrun_comments",
      +  "usergroups",
      +  "users",
      +  "workitems",
      +  "workitem_attachments",
      +  "workitem_approvals",
      +  "workitem_comments",
      +  "featureselections",
      +  "teststeps",
      +  "workrecords",
      +  "revisions",
      +  "testrecord_attachments",
      +  "license_slots",
      +  "license_types",
      +  "license",
      +  "metadata",
      +  "license_assignments",
      +  "customfields"
      +]
  5. First observedv1.0.0

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond destructiveHint: true by spelling out that the effect is irreversible and that removed data cannot be recovered through the API. It also discloses exactly what dry_run does and how the preview is returned, which an agent cannot infer from annotations.

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-loads the distinction and irreversibility in the first two clauses, then groups alternatives and the dry_run tip in a clear order. Slightly padded by the closing sentence explaining text vs structured preview output, which is only marginally actionable.

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?

Covers the risk profile, alternatives, and safe-preview workflow for a destructive nested-body tool with no output schema. The one gap is that the description never explains why a DELETE-style relationship removal requires a requestBody object with a data array, which is the most likely source of a malformed call.

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 coverage is 100%, so the baseline is 3; the description reinforces 'one named relationship' and the dry_run-first tip, but adds no new detail about relationshipId naming, projectId scoping, or what the required requestBody must contain.

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 ('Removes one named JSON:API relationship from a Work Item') and immediately disambiguates the most dangerous confusion: 'this edits linkage and does not delete related Work Items.' That single clause separates it from deleteWorkItems and deleteLinkedWorkItem in a crowded sibling list.

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?

Names inspection alternative getWorkItemsRelationships and points to 'linked-work-item tools' for roles and related-item detail, plus a recommended dry_run-first workflow. The reference to linked-work-item tools is collective rather than naming a specific sibling, and no explicit 'do not use when' exclusion is given for patchWorkItemRelationships.

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