Skip to main content
Glama
postmanlabs

Postman

Official
by postmanlabs
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Create a request

createCollectionRequest

Add a request to a specific Postman collection by providing collection ID, URL, method, headers, body, and auth. Use for programmatic API testing and collection automation.

Instructions

Creates a request in a collection. For a complete list of properties, refer to the Request entry in the Postman Collection Format documentation.

Note:

It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoThe request's URL.
authNoThe request's authentication information.
dataNoThe request body's form data.
nameNoThe request's name. It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.
eventsNoA list of scripts configured to run when specific events occur.
methodNoThe request's HTTP method.
dataModeNoThe request body's data mode.
folderIdNoThe folder ID in which to create the request. By default, the system will create the request at the collection level.
headerDataNoThe request's headers.
dataOptionsNoAdditional configurations and options set for the request body's various data modes.
descriptionNoThe request's description.
queryParamsNoThe request's query parameters.
rawModeDataNoThe request body's raw mode data.
collectionIdYesThe collection's ID.
graphqlModeDataNoThe request body's GraphQL mode data.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed3 schema fields changedv2.12.0
    • removedInput schema / properties / events / anyOf
      Removed value: -[
-  {
-    "items": {
-      "additionalProperties": false,
-      "properties": {
-        "listen": {
-          "description": "The event type.",
-          "enum": [
-            "test",
-            "prerequest"
-          ],
-          "type": "string"
-        },
-        "script": {
-          "additionalProperties": false,
-          "description": "Information about the Javascript code that can be used to to perform setup or teardown operations in a response.",
-          "properties": {
-            "exec": {
-              "description": "A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes.",
-              "items": {
-                "type": [
-                  "string",
-                  "null"
-                ]
-              },
-              "type": "array"
-            },
-            "id": {
-              "description": "The script's ID.",
-              "type": "string"
-            },
-            "type": {
-              "description": "The type of script. For example, `text/javascript`.",
-              "type": "string"
-            }
-          },
-          "type": "object"
-        }
-      },
-      "type": "object"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedInput schema / properties / events / items
      Added value: +{
+  "additionalProperties": false,
+  "properties": {
+    "listen": {
+      "description": "The event type.",
+      "enum": [
+        "test",
+        "prerequest"
+      ],
+      "type": "string"
+    },
+    "script": {
+      "additionalProperties": false,
+      "description": "Information about the Javascript code that can be used to to perform setup or teardown operations in a response.",
+      "properties": {
+        "exec": {
+          "description": "A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes.",
+          "items": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "type": "array"
+        },
+        "id": {
+          "description": "The script's ID.",
+          "type": "string"
+        },
+        "type": {
+          "description": "The type of script. For example, `text/javascript`.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
    • addedInput schema / properties / events / type
      Added value: +"array"
  2. Changed12 schema fields changedv2.8.7
    • addedInput schema / properties / auth
      Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "apikey": {
+          "description": "The API key's authentication information.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "asap": {
+          "description": "The attributes for ASAP authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "awsv4": {
+          "description": "The attributes for AWS Signature authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "basic": {
+          "description": "The attributes for Basic Auth.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "bearer": {
+          "description": "The attributes for Bearer Token authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "digest": {
+          "description": "The attributes for Digest access authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "edgegrid": {
+          "description": "The attributes for Akamai Edgegrid authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "hawk": {
+          "description": "The attributes for Hawk authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "jwt": {
+          "description": "The attributes for JWT authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "ntlm": {
+          "description": "The attributes for NTLM authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "oauth1": {
+          "description": "The attributes for OAuth1 authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "oauth2": {
+          "description": "The attributes for OAuth2 authentication.",
+          "items": {
+            "additionalProperties": false,
+            "description": "Information about the supported Postman [authorization type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).",
+            "properties": {
+              "key": {
+                "description": "The auth method's key value.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The value's type.",
+                "enum": [
+                  "string",
+                  "boolean",
+                  "number",
+                  "array",
+                  "object",
+                  "any"
+                ],
+                "type": "string"
+              },
+              "value": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "items": {
+                      "additionalProperties": {},
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                ],
+                "description": "The key's value."
+              }
+            },
+            "required": [
+              "key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "type": {
+          "description": "The authorization type.",
+          "enum": [
+            "basic",
+            "bearer",
+            "apikey",
+            "digest",
+            "oauth1",
+            "oauth2",
+            "hawk",
+            "awsv4",
+            "ntlm",
+            "edgegrid",
+            "jwt",
+            "asap",
+            "noauth"
+          ],
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The request's authentication information."
+}
    • addedInput schema / properties / data
      Added value: +{
+  "anyOf": [
+    {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": {
+            "description": "The form data's description.",
+            "type": "string"
+          },
+          "enabled": {
+            "description": "If true, the form data entry is enabled.",
+            "type": "boolean"
+          },
+          "key": {
+            "description": "The form data's key.",
+            "type": "string"
+          },
+          "type": {
+            "description": "The form data's type.",
+            "enum": [
+              "text",
+              "file"
+            ],
+            "type": "string"
+          },
+          "uuid": {
+            "description": "The form data entry's unique identifier.",
+            "type": "string"
+          },
+          "value": {
+            "description": "The form data's value.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The request body's form data."
+}
    • addedInput schema / properties / dataMode
      Added value: +{
+  "description": "The request body's data mode.",
+  "enum": [
+    "raw",
+    "urlencoded",
+    "formdata",
+    "binary",
+    "graphql"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / dataOptions
      Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "binary": {
+          "additionalProperties": {},
+          "description": "Options for the `binary` data mode.",
+          "type": "object"
+        },
+        "graphql": {
+          "additionalProperties": {},
+          "description": "Options for the `graphql` data mode.",
+          "type": "object"
+        },
+        "params": {
+          "additionalProperties": {},
+          "description": "Options for the `params` data mode.",
+          "type": "object"
+        },
+        "raw": {
+          "additionalProperties": false,
+          "description": "Options for the `raw` data mode.",
+          "properties": {
+            "language": {
+              "description": "The raw mode data's language type.",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "urlencoded": {
+          "additionalProperties": {},
+          "description": "Options for the `urlencoded` data mode.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Additional configurations and options set for the request body's various data modes."
+}
    • addedInput schema / properties / description
      Added value: +{
+  "description": "The request's description.",
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / events
      Added value: +{
+  "anyOf": [
+    {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "listen": {
+            "description": "The event type.",
+            "enum": [
+              "test",
+              "prerequest"
+            ],
+            "type": "string"
+          },
+          "script": {
+            "additionalProperties": false,
+            "description": "Information about the Javascript code that can be used to to perform setup or teardown operations in a response.",
+            "properties": {
+              "exec": {
+                "description": "A list of script strings, where each line represents a line of code. Separate lines makes it easy to track script changes.",
+                "items": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "type": "array"
+              },
+              "id": {
+                "description": "The script's ID.",
+                "type": "string"
+              },
+              "type": {
+                "description": "The type of script. For example, `text/javascript`.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "A list of scripts configured to run when specific events occur."
+}
    • addedInput schema / properties / graphqlModeData
      Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "query": {
+          "description": "The GraphQL query.",
+          "type": "string"
+        },
+        "variables": {
+          "description": "The GraphQL query variables, in JSON format.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The request body's GraphQL mode data."
+}
    • addedInput schema / properties / headerData
      Added value: +{
+  "description": "The request's headers.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "description": {
+        "description": "The header's description.",
+        "type": "string"
+      },
+      "key": {
+        "description": "The header's key.",
+        "type": "string"
+      },
+      "value": {
+        "description": "The header's value.",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / method
      Added value: +{
+  "description": "The request's HTTP method.",
+  "enum": [
+    "GET",
+    "PUT",
+    "POST",
+    "PATCH",
+    "DELETE",
+    "COPY",
+    "HEAD",
+    "OPTIONS",
+    "LINK",
+    "UNLINK",
+    "PURGE",
+    "LOCK",
+    "UNLOCK",
+    "PROPFIND",
+    "VIEW"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / queryParams
      Added value: +{
+  "description": "The request's query parameters.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "description": {
+        "description": "The query parameter's description.",
+        "type": "string"
+      },
+      "enabled": {
+        "description": "If true, the query parameter is enabled.",
+        "type": "boolean"
+      },
+      "key": {
+        "description": "The query parameter's key.",
+        "type": "string"
+      },
+      "value": {
+        "description": "The query parameter's value.",
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / rawModeData
      Added value: +{
+  "description": "The request body's raw mode data.",
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / url
      Added value: +{
+  "description": "The request's URL.",
+  "type": [
+    "string",
+    "null"
+  ]
+}
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

The description adds a valuable behavioral caveat about the `name` property resulting in a blank name if omitted, which is not in annotations. It also directs to comprehensive documentation. However, it doesn't disclose other behaviors like authentication requirements or response content, but annotations already cover mutation and non-destructiveness, so the added context is sufficient.

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?

The description is extremely concise: two short paragraphs. The first provides the core purpose and a useful link to documentation, while the second is a focused note on the `name` pitfall. No unnecessary words or repetition.

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

Completeness3/5

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

For a create tool with 15 parameters and no output schema, the description does not explain what the response will be (e.g., created request object) or common use cases beyond creation. It does point to docs and highlights the name issue, but given the tool's complexity, it could be more complete. The schema is thorough, so this is acceptable but not excellent.

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 coverage is 100%, so baseline is 3. The description adds extra semantic value by emphasizing the `name` parameter recommendation and its consequence, and it links to the full property list in documentation. This goes beyond the schema descriptions, earning a 4.

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 clearly states the tool's purpose: 'Creates a request in a collection.' This is a specific verb and resource, and it distinguishes from sibling tools like updateCollectionRequest (updates) and createCollection (creates collections). No ambiguity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool is for creating requests but provides no explicit guidance on when to use it versus alternatives (e.g., updateCollectionRequest). It does not mention exclusion criteria or alternative tools, so usage context is only implied.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/postmanlabs/postman-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server