Skip to main content
Glama
postmanlabs

Postman

Official
by postmanlabs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Replace a collection's data

putCollection
Idempotent

Replaces the contents of a Postman collection using the Postman Collection v2.1.0 schema, preserving item IDs to update or omitting them to recreate.

Instructions

Replaces the contents of a collection using the Postman Collection v2.1.0 schema format. Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items and creates new items.

Note:

  • The maximum collection size this endpoint accepts cannot exceed 100 MB.

  • Use the GET `/collection-updates-tasks/{taskId}` endpoint to get the collection's update status when performing an asynchronous update.

  • If you don't include the collection items' ID values from the request body, the endpoint removes the existing items and recreates the items with new ID values.

  • To copy another collection's contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id` values.

Input Schema

NameRequiredDescriptionDefault
PreferNoThe `respond-async` header to perform the update asynchronously.
collectionNoThe new collection contents that replace the existing collection.
collectionIdYesThe collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv2.14.0
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / collection / properties / item / items / properties / item / items / properties / event
      Added value: +{
+  "description": "A list of scripts configured to run when specific events occur. Include this on requests inside folders to keep their pre-request (`prerequest`) and post-response (`test`) scripts — scripts you omit here are not carried over from the stored item.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "id": {
+        "description": "The event's ID.",
+        "type": "string"
+      },
+      "listen": {
+        "description": "The `prerequest` (pre-request) or `test` (post-response) value.",
+        "enum": [
+          "test",
+          "prerequest"
+        ],
+        "type": "string"
+      },
+      "script": {
+        "additionalProperties": false,
+        "description": "Information about the Javascript code that runs when the event fires.",
+        "properties": {
+          "exec": {
+            "description": "A list of script strings, where each line represents a line of code.",
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "id": {
+            "description": "The script's ID.",
+            "type": "string"
+          },
+          "type": {
+            "description": "The type of script. For example, `text/javascript`.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "required": [
+      "listen"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / event
      Added value: +{
+  "description": "A list of scripts configured to run when specific events occur. Include this on requests inside folders to keep their pre-request (`prerequest`) and post-response (`test`) scripts — scripts you omit here are not carried over from the stored item.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "id": {
+        "description": "The event's ID.",
+        "type": "string"
+      },
+      "listen": {
+        "description": "The `prerequest` (pre-request) or `test` (post-response) value.",
+        "enum": [
+          "test",
+          "prerequest"
+        ],
+        "type": "string"
+      },
+      "script": {
+        "additionalProperties": false,
+        "description": "Information about the Javascript code that runs when the event fires.",
+        "properties": {
+          "exec": {
+            "description": "A list of script strings, where each line represents a line of code.",
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "id": {
+            "description": "The script's ID.",
+            "type": "string"
+          },
+          "type": {
+            "description": "The type of script. For example, `text/javascript`.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "required": [
+      "listen"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / item / items / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / item / items / properties / event
      Added value: +{
+  "description": "A list of scripts configured to run when specific events occur. Include this on requests inside folders to keep their pre-request (`prerequest`) and post-response (`test`) scripts — scripts you omit here are not carried over from the stored item.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "id": {
+        "description": "The event's ID.",
+        "type": "string"
+      },
+      "listen": {
+        "description": "The `prerequest` (pre-request) or `test` (post-response) value.",
+        "enum": [
+          "test",
+          "prerequest"
+        ],
+        "type": "string"
+      },
+      "script": {
+        "additionalProperties": false,
+        "description": "Information about the Javascript code that runs when the event fires.",
+        "properties": {
+          "exec": {
+            "description": "A list of script strings, where each line represents a line of code.",
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "id": {
+            "description": "The script's ID.",
+            "type": "string"
+          },
+          "type": {
+            "description": "The type of script. For example, `text/javascript`.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "required": [
+      "listen"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / item / items / properties / request / additionalProperties
      Previous value: -falseNew value: +{}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / request / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / collection / properties / item / items / properties / item / items / properties / item / items / properties / request / properties / auth
      Added value: +{
+  "additionalProperties": {},
+  "description": "The request's authentication. Set `type` and include the matching credential array, for example `{ \"type\": \"bearer\", \"bearer\": [{ \"key\": \"token\", \"value\": \"...\" }] }`.",
+  "properties": {
+    "type": {
+      "enum": [
+        "noauth",
+        "basic",
+        "bearer",
+        "apikey",
+        "digest",
+        "oauth1",
+        "oauth2",
+        "hawk",
+        "awsv4",
+        "ntlm",
+        "edgegrid"
+      ],
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / request / additionalProperties
      Previous value: -falseNew value: +{}
    • changedInput schema / properties / collection / properties / item / items / properties / item / items / properties / request / properties / auth / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / collection / properties / item / items / properties / item / items / properties / request / properties / auth / description
      Added value: +"The request's authentication. Set `type` and include the matching credential array, for example `{ \"type\": \"bearer\", \"bearer\": [{ \"key\": \"token\", \"value\": \"...\" }] }`."
  2. Changed3 schema fields changedv2.12.3
    • addedInput schema / properties / collection / description
      Added value: +"The new collection contents that replace the existing collection."
    • addedInput schema / properties / collection / properties / info / properties / createdAt
      Added value: +{
+  "description": "The date and time when the collection was created.",
+  "format": "date-time",
+  "type": "string"
+}
    • removedInput schema / properties / collection / properties / info / properties / createdat
      Removed value: -{
-  "description": "The date and time when the collection was created.",
-  "format": "date-time",
-  "type": "string"
-}
  3. Changed13 schema fields changedv2.12.0
    • removedInput schema / properties / collection / properties / info / properties / schema / const
      Removed value: -"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    • changedInput schema / properties / collection / properties / info / properties / schema / description
      Previous value: -"The \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\" Postman Collection Format v2.1.0 schema."New value: +"The \"https://schema.postman.com/json/collection/v2.1.0/collection.json\" Postman Collection Format v2.1.0 schema."
    • addedInput schema / properties / collection / properties / info / properties / schema / enum
      Added value: +[
+  "https://schema.postman.com/json/collection/v2.1.0/collection.json",
+  "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+]
    • removedInput schema / properties / collection / properties / item / items / properties / variable / items / additionalProperties
      Removed value: -false
    • addedInput schema / properties / collection / properties / item / items / properties / variable / items / anyOf
      Added value: +[
+  {
+    "additionalProperties": false,
+    "description": "Information about the variable.",
+    "properties": {
+      "description": {
+        "description": "The variable's description.",
+        "maxLength": 512,
+        "type": "string"
+      },
+      "disabled": {
+        "default": false,
+        "description": "If true, the variable is not enabled. Doesn't apply to path parameter variables.",
+        "type": "boolean"
+      },
+      "enabled": {
+        "default": true,
+        "description": "If true, the variable is enabled.",
+        "type": "boolean"
+      },
+      "id": {
+        "description": "The variable's ID. Doesn't apply to collection-level variables.",
+        "type": "string"
+      },
+      "key": {
+        "description": "The variable's key (name).",
+        "type": "string"
+      },
+      "value": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "integer"
+          }
+        ],
+        "description": "The key's value."
+      }
+    },
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "description": "Information about the secret variable.",
+    "properties": {
+      "description": {
+        "description": "The variable's description.",
+        "maxLength": 512,
+        "type": "string"
+      },
+      "enabled": {
+        "default": true,
+        "description": "If true, the variable is enabled.",
+        "type": "boolean"
+      },
+      "id": {
+        "description": "The variable's ID. Doesn't apply to collection-level variables.",
+        "type": "string"
+      },
+      "key": {
+        "description": "The variable's key (name).",
+        "type": "string"
+      },
+      "secret": {
+        "description": "If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field.",
+        "type": "boolean"
+      },
+      "source": {
+        "additionalProperties": false,
+        "description": "Information about the source of the variable's value.",
+        "properties": {
+          "postman": {
+            "additionalProperties": false,
+            "description": "Information about the Postman-specific source of the variable's value.",
+            "properties": {
+              "secretId": {
+                "description": "The variable's secret ID.",
+                "type": "string"
+              },
+              "type": {
+                "const": "cloud",
+                "description": "The variable's type:\n- `cloud` — The variable value is synced and stored in the Postman Cloud.\n",
+                "type": "string"
+              },
+              "vaultId": {
+                "description": "The variable's ID in the Postman Vault.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "provider": {
+            "const": "postman",
+            "description": "The secret's provider.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "type": "object"
+  }
+]
    • removedInput schema / properties / collection / properties / item / items / properties / variable / items / description
      Removed value: -"Information about the variable."
    • removedInput schema / properties / collection / properties / item / items / properties / variable / items / properties
      Removed value: -{
-  "description": {
-    "description": "The variable's description.",
-    "maxLength": 512,
-    "type": "string"
-  },
-  "disabled": {
-    "default": false,
-    "description": "If true, the variable is not enabled. Doesn't apply to path parameter variables.",
-    "type": "boolean"
-  },
-  "id": {
-    "description": "The variable's ID. Doesn't apply to collection-level variables.",
-    "type": "string"
-  },
-  "key": {
-    "description": "The variable's key (name).",
-    "type": "string"
-  },
-  "value": {
-    "anyOf": [
-      {
-        "type": "string"
-      },
-      {
-        "type": "boolean"
-      },
-      {
-        "type": "integer"
-      }
-    ],
-    "description": "The key's value."
-  }
-}
    • removedInput schema / properties / collection / properties / item / items / properties / variable / items / type
      Removed value: -"object"
    • removedInput schema / properties / collection / properties / variable / items / additionalProperties
      Removed value: -false
    • addedInput schema / properties / collection / properties / variable / items / anyOf
      Added value: +[
+  {
+    "additionalProperties": false,
+    "description": "Information about a collection-level variable. Collection variables don't support `id`, `description`, or `enabled` fields. Use `disabled` to control whether a variable is active.",
+    "properties": {
+      "disabled": {
+        "default": false,
+        "description": "If true, the variable is not enabled.",
+        "type": "boolean"
+      },
+      "key": {
+        "description": "The variable's key (name).",
+        "type": "string"
+      },
+      "value": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "integer"
+          }
+        ],
+        "description": "The key's value."
+      }
+    },
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "description": "Information about a collection-level secret variable. Collection variables don't have an `id` field.",
+    "properties": {
+      "description": {
+        "description": "The variable's description.",
+        "maxLength": 512,
+        "type": "string"
+      },
+      "enabled": {
+        "default": true,
+        "description": "If true, the variable is enabled.",
+        "type": "boolean"
+      },
+      "key": {
+        "description": "The variable's key (name).",
+        "type": "string"
+      },
+      "secret": {
+        "description": "If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field.",
+        "type": "boolean"
+      },
+      "source": {
+        "additionalProperties": false,
+        "description": "Information about the source of the variable's value.",
+        "properties": {
+          "postman": {
+            "additionalProperties": false,
+            "description": "Information about the Postman-specific source of the variable's value.",
+            "properties": {
+              "secretId": {
+                "description": "The variable's secret ID.",
+                "type": "string"
+              },
+              "type": {
+                "const": "cloud",
+                "description": "The variable's type:\n- `cloud` — The variable value is synced and stored in the Postman Cloud.\n",
+                "type": "string"
+              },
+              "vaultId": {
+                "description": "The variable's ID in the Postman Vault.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "provider": {
+            "const": "postman",
+            "description": "The secret's provider.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "type": "object"
+  }
+]
    • removedInput schema / properties / collection / properties / variable / items / description
      Removed value: -"Information about the variable."
    • removedInput schema / properties / collection / properties / variable / items / properties
      Removed value: -{
-  "description": {
-    "description": "The variable's description.",
-    "maxLength": 512,
-    "type": "string"
-  },
-  "disabled": {
-    "default": false,
-    "description": "If true, the variable is not enabled. Doesn't apply to path parameter variables.",
-    "type": "boolean"
-  },
-  "id": {
-    "description": "The variable's ID. Doesn't apply to collection-level variables.",
-    "type": "string"
-  },
-  "key": {
-    "description": "The variable's key (name).",
-    "type": "string"
-  },
-  "value": {
-    "anyOf": [
-      {
-        "type": "string"
-      },
-      {
-        "type": "boolean"
-      },
-      {
-        "type": "integer"
-      }
-    ],
-    "description": "The key's value."
-  }
-}
    • removedInput schema / properties / collection / properties / variable / items / type
      Removed value: -"object"
  4. Changed1 schema field changedv2.9.0
    • changedInput schema / properties / collection / properties / auth / properties / type / enum
      Previous value: -[
-  "basic",
-  "bearer",
-  "apikey",
-  "digest",
-  "oauth1",
-  "oauth2",
-  "hawk",
-  "awsv4",
-  "ntlm",
-  "edgegrid",
-  "jwt",
-  "asap"
-]New value: +[
+  "basic",
+  "bearer",
+  "apikey",
+  "digest",
+  "oauth1",
+  "oauth2",
+  "hawk",
+  "awsv4",
+  "ntlm",
+  "edgegrid",
+  "jwt",
+  "asap",
+  "noauth"
+]
  5. Changed2 schema fields changedv2.8.9
    • addedInput schema / properties / collection / properties / item / items / properties / item
      Added value: +{
+  "description": "A list of items contained in this folder. Use this property to create folder structures within the collection. Each item can be a request (with a 'request' property) or a nested folder (with its own 'item' property). Omit the 'request' property for folder items.",
+  "items": {
+    "additionalProperties": false,
+    "description": "A nested collection item — either a request (has 'request') or a folder (has 'item').",
+    "properties": {
+      "description": {
+        "description": "The item's description.",
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "id": {
+        "description": "The collection item's ID.",
+        "type": "string"
+      },
+      "item": {
+        "description": "Nested folder items for deeper folder structures.",
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "description": {
+              "description": "The item's description.",
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "id": {
+              "description": "The collection item's ID.",
+              "type": "string"
+            },
+            "item": {
+              "description": "Further nested folder items.",
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "request": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "method": {
+                        "type": "string"
+                      },
+                      "url": {
+                        "anyOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "additionalProperties": false,
+                            "properties": {
+                              "raw": {
+                                "type": "string"
+                              }
+                            },
+                            "type": "object"
+                          }
+                        ]
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "name": {
+              "description": "The item's name.",
+              "type": "string"
+            },
+            "request": {
+              "additionalProperties": false,
+              "description": "The request definition.",
+              "properties": {
+                "body": {
+                  "additionalProperties": false,
+                  "properties": {
+                    "mode": {
+                      "type": "string"
+                    },
+                    "raw": {
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                },
+                "header": {
+                  "items": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "key": {
+                        "type": "string"
+                      },
+                      "value": {
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "method": {
+                  "enum": [
+                    "GET",
+                    "PUT",
+                    "POST",
+                    "PATCH",
+                    "DELETE",
+                    "COPY",
+                    "HEAD",
+                    "OPTIONS",
+                    "LINK",
+                    "UNLINK",
+                    "PURGE",
+                    "LOCK",
+                    "UNLOCK",
+                    "PROPFIND",
+                    "VIEW"
+                  ],
+                  "type": "string"
+                },
+                "url": {
+                  "anyOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "additionalProperties": false,
+                      "properties": {
+                        "raw": {
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "name": {
+        "description": "The item's name.",
+        "type": "string"
+      },
+      "request": {
+        "additionalProperties": false,
+        "description": "The request definition. Include for request items, omit for folder items.",
+        "properties": {
+          "auth": {
+            "additionalProperties": false,
+            "properties": {
+              "type": {
+                "enum": [
+                  "noauth",
+                  "basic",
+                  "bearer",
+                  "apikey",
+                  "digest",
+                  "oauth1",
+                  "oauth2",
+                  "hawk",
+                  "awsv4",
+                  "ntlm",
+                  "edgegrid"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "body": {
+            "additionalProperties": false,
+            "properties": {
+              "mode": {
+                "enum": [
+                  "raw",
+                  "urlencoded",
+                  "formdata",
+                  "file",
+                  "graphql"
+                ],
+                "type": "string"
+              },
+              "options": {
+                "additionalProperties": false,
+                "properties": {
+                  "raw": {
+                    "additionalProperties": false,
+                    "properties": {
+                      "language": {
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  }
+                },
+                "type": "object"
+              },
+              "raw": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "header": {
+            "items": {
+              "additionalProperties": false,
+              "properties": {
+                "description": {
+                  "type": "string"
+                },
+                "key": {
+                  "type": "string"
+                },
+                "value": {
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "type": "array"
+          },
+          "method": {
+            "description": "The HTTP method.",
+            "enum": [
+              "GET",
+              "PUT",
+              "POST",
+              "PATCH",
+              "DELETE",
+              "COPY",
+              "HEAD",
+              "OPTIONS",
+              "LINK",
+              "UNLINK",
+              "PURGE",
+              "LOCK",
+              "UNLOCK",
+              "PROPFIND",
+              "VIEW"
+            ],
+            "type": "string"
+          },
+          "url": {
+            "anyOf": [
+              {
+                "description": "The request's URL string.",
+                "type": "string"
+              },
+              {
+                "additionalProperties": false,
+                "properties": {
+                  "host": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "path": {
+                    "items": {
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "protocol": {
+                    "type": "string"
+                  },
+                  "query": {
+                    "items": {
+                      "additionalProperties": false,
+                      "properties": {
+                        "key": {
+                          "type": "string"
+                        },
+                        "value": {
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "raw": {
+                    "description": "The request's raw URL.",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
    • changedInput schema / properties / collection / properties / item / items / properties / request / properties / auth / properties / type / enum
      Previous value: -[
-  "basic",
-  "bearer",
-  "apikey",
-  "digest",
-  "oauth1",
-  "oauth2",
-  "hawk",
-  "awsv4",
-  "ntlm",
-  "edgegrid",
-  "jwt",
-  "asap"
-]New value: +[
+  "basic",
+  "bearer",
+  "apikey",
+  "digest",
+  "oauth1",
+  "oauth2",
+  "hawk",
+  "awsv4",
+  "ntlm",
+  "edgegrid",
+  "jwt",
+  "asap",
+  "noauth"
+]
  6. Changed2 schema fields changedv2.8.7
    • addedInput schema / properties / collection / properties / item / items / properties / createdAt
      Added value: +{
+  "description": "The date and time at which the collection item was created.",
+  "format": "date-time",
+  "type": "string"
+}
    • addedInput schema / properties / collection / properties / item / items / properties / updatedAt
      Added value: +{
+  "description": "The date and time at which the collection item was updated.",
+  "format": "date-time",
+  "type": "string"
+}
  7. First observed

TDQS

A3.5/5.0
Behavior2/5

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

The description supplies genuinely useful behavioral detail beyond the annotations: a 100 MB size cap, a 202 Accepted async path, and the consequence that omitting item IDs removes and recreates items with new IDs. However, that same text sits in tension with the structured hints — 'removes the existing items' is not an additive update (destructiveHint: false) and recreating items with fresh ID values makes repeat calls observably non-identical (idempotentHint: true). Because the description conflicts with the annotations on those points, it cannot be scored at or above baseline, though the conflict is narrower than a flat read/write reversal, so 2 rather than 1.

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

Conciseness3/5

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

The core operation is front-loaded and the bulleted structure is scannable, but there is real redundancy: the ID-removal warning appears in the opening paragraph and again as a Note bullet, and the same Collection Format docs URL is linked twice. Trimming the duplicated warning and link would tighten it without losing information.

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?

For a complex nested-payload mutation with no output schema or annotation coverage of the payload, the description covers size limits, the async flow and its status endpoint, ID-preservation semantics, and the cross-collection copy pitfall. It still omits permission/auth prerequisites and whether the replacement is atomic on failure, which would matter to an agent deciding whether to call it.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3, and the description earns more by explaining semantics the schema does not: the body must follow the Postman Collection v2.1.0 schema, collection ID values must be carried in the body, and which ID fields (id, uid, postman_id) must be stripped before reusing another collection's payload. It adds real meaning on top of the structural schema rather than restating it.

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

Purpose4/5

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

The first sentence gives a specific verb and resource ('Replaces the contents of a collection') plus the required payload format (Postman Collection v2.1.0). An agent can tell this apart from createCollection or updateCollectionRequest by the plain-language 'replace the contents' framing. It stops short of naming a sibling explicitly, so it does not reach the top of the scale.

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?

It gives actionable conditional guidance: send the Prefer: respond-async header for async updates, poll GET /collection-updates-tasks/{taskId} for status, and strip id/uid/postman_id values when copying another collection or the call errors. What is missing is explicit routing away from siblings (e.g. when to call updateCollectionRequest or createCollection instead), so it is clear context rather than full when/when-not 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