Skip to main content
Glama

postCollections

Creates Collections from supplied JSON:API resource data and returns the created resources, with optional dry-run validation before sending to Polarion.

Instructions

Creates Collections from the supplied JSON:API resource data and returns the created resources. Requires project permission to create Collections. Use getCollections to list existing ones or patchCollections to update one. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. 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.
requestBodyYesThe Collection(s) body.

Output Schema

NameRequiredDescriptionDefault
dataNo

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. Changed11 schema fields changedv1.3.1
    • removedOutput schema / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MyCollectionId"
    • 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 / portal / example
      Removed value: -"server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234"
    • changedOutput schema / properties / data / items / properties / links / properties / portal / 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/collections/MyCollectionId?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 / type / enum
      Removed value: -[
      -  "collections"
      -]
    • 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"
      +]
  3. Changed2 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."
  4. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "properties": {
      +          "id": {
      +            "example": "MyProjectId/MyCollectionId",
      +            "type": "string"
      +          },
      +          "links": {
      +            "properties": {
      +              "portal": {
      +                "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234",
      +                "type": "string"
      +              },
      +              "self": {
      +                "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": {
      +            "enum": [
      +              "collections"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  5. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true and destructiveHint=false, and the description partly restates those ("Effect: creates a new resource", non-idempotency). It earns credit for the added consequence — that repetition creates additional resources rather than failing — plus the permission prerequisite and an explanation of what dry_run actually returns. It does not cover partial-failure or rollback behavior in a batch create.

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 purpose and alternatives, and the dry_run tip is actionable. However, "Effect: creates a new resource" and the idempotency sentence are partly redundant with each other and with the annotations, and the dry_run paragraph largely repeats the schema's own dry_run description.

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?

Given an output schema exists (so return shape needn't be explained) and full schema description coverage, the description covers the remaining agent-relevant facts: permission requirement, mutation effect, non-idempotency warning, sibling alternatives, and a safe preview path. Nothing needed to invoke it correctly 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%, including a detailed dry_run description and projectId guidance, so the baseline is 3. The description adds only the framing that requestBody is JSON:API resource data; it does not explain the nested relationships (testRuns, documents, richPages, upstreamCollections) or batch-array semantics beyond what the schema shows.

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 ("Creates Collections from the supplied JSON:API resource data") and adds the return behavior. It explicitly names getCollections and patchCollections, so an agent can distinguish create from list and update without inspecting sibling schemas.

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?

Gives the precondition ("Requires project permission to create Collections") and routes to the correct alternatives by intent: getCollections to list, patchCollections to update. It also supplies a recommended pre-call workflow (run with dry_run: true to validate), which is concrete when-to-use 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