Skip to main content
Glama

Create a collection request

createCollectionRequest

Creates a new request inside a Postman collection, letting you define its method, URL, headers, auth, and body for organizing API calls.

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 authorization settings.
dataNoThe request body's form or urlencoded 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.
eventsNoThe request's pre-request and test scripts.
folderNoThe folder ID in which to create the request. By default, the system creates the request at the collection level.
methodNoThe request's HTTP method.
dataModeNoThe request body's data mode.
headerDataNoThe request's headers.
dataOptionsNoAdditional options for the request body data.
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.

  1. Changed6 schema fields changedv2.12.3
    • changedInput schema / properties / auth / description
      Previous value: -"The request's authentication information."New value: +"The request's authorization settings."
    • changedInput schema / properties / data / description
      Previous value: -"The request body's form data."New value: +"The request body's form or urlencoded data."
    • changedInput schema / properties / dataOptions / description
      Previous value: -"Additional configurations and options set for the request body's various data modes."New value: +"Additional options for the request body data."
    • changedInput schema / properties / events / description
      Previous value: -"A list of scripts configured to run when specific events occur."New value: +"The request's pre-request and test scripts."
    • addedInput schema / properties / folder
      Added value: +{
      +  "description": "The folder ID in which to create the request. By default, the system creates the request at the collection level.",
      +  "type": "string"
      +}
    • removedInput schema / properties / folderId
      Removed value: -{
      -  "description": "The folder ID in which to create the request. By default, the system will create the request at the collection level.",
      -  "type": "string"
      -}
  2. 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"
  3. 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"
      +  ]
      +}
  4. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare this is not read-only, not idempotent, non-destructive, and open-world. The description adds a useful behavioral consequence: omitting `name` creates a blank-name request, but it does not cover permissions, error behavior, or return values.

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?

The description is short and front-loads the core action, then adds a docs pointer and name caveat. The name caveat duplicates the schema's `name` description, which is minor redundancy but not excessive.

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 15-parameter mutation tool with no output schema, the description covers the core action and the main naming gotcha, while the schema and annotations carry most remaining detail. It still omits return behavior, collection/folder prerequisites, and sibling alternatives.

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%, so the schema already documents all 15 parameters in detail. The description only repeats the `name` recommendation and defers the rest to external documentation, adding little beyond the structured schema.

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 description states a specific verb and resource: "Creates a request in a collection." It is clear what the tool does, but it does not explicitly differentiate it from siblings such as createCollectionResponse or updateCollectionRequest.

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

Usage Guidelines2/5

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

The description gives no explicit when-to-use guidance, no when-not-to-use guidance, and no alternatives among sibling tools. The only additional usage note is about passing `name`, not about selecting this tool.

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