Skip to main content
Glama

add_postman_collection_event

Adds an event script (pre-request or test) to a Postman collection file, enabling custom automation for API testing.

Instructions

Add an event to the Postman collection

Args:
    file_path: The path to the Postman collection file (string)
    event: The event dictionary with keys like listen, script, etc. (dict)
          Example: {
              "listen": "prerequest",
              "script": {
                  "type": "text/javascript",
                  "exec": ["console.log('This runs before each request');"]
              }
          }
Returns:
    The updated Postman collection data (dict)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_pathYes
eventYes
Behavior3/5

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

No annotations provided, so description carries full burden. It discloses that it returns updated collection data, but does not mention side effects like file modification, potential errors, or whether events are appended or overwritten.

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?

Concise docstring format with Args and Returns. The example adds length but is helpful. Could be slightly tighter by omitting example or clarifying it's illustrative.

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?

Covers both parameters and return value, but lacks context on behavioral details like whether the event is appended to existing events or replaces them, and does not explain the collection modification workflow.

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?

Both parameters are explained with descriptions and an example for the event dict, adding significant meaning beyond the bare schema. However, no constraints or specific valid keys are detailed.

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?

Clear verb and resource ('add an event to Postman collection'), but does not distinguish from sibling tools like add_postman_collection_item or add_postman_collection_variable. The example helps clarify what an event is.

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?

No guidance on when to use this tool versus alternatives, no prerequisites or conditions mentioned. Only states what it does.

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/marioToribi0/code2postman-mcp'

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