Skip to main content
Glama

putEnvironment

Replace an entire Postman environment's variables with new values in a single request.

Instructions

Replaces all environment contents. Max size 30MB.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
environmentIdYesEnvironment ID
environmentNoEnvironment object with name and values

Implementation Reference

  • The PutEnvironmentTool class (handler) for the 'putEnvironment' tool. The run_tool method extracts environmentId and environment from args, then calls the Postman API with a PUT request to /environments/{env_id} to replace all environment contents.
    class PutEnvironmentTool(ToolHandler):
        """Replace environment contents"""
        
        def __init__(self):
            super().__init__("putEnvironment")
        
        def get_tool_description(self) -> Tool:
            return Tool(
                name=self.name,
                description="Replaces all environment contents. Max size 30MB.",
                inputSchema={
                    "type": "object",
                    "properties": {
                        "environmentId": {
                            "type": "string",
                            "description": "Environment ID"
                        },
                        "environment": {
                            "type": "object",
                            "description": "Environment object with name and values"
                        }
                    },
                    "required": ["environmentId"]
                },
            )
        
        async def run_tool(self, args: dict) -> list[TextContent]:
            env_id = args["environmentId"]
            body = {"environment": args.get("environment", {})}
            
            result = await postman_api_call("PUT", f"/environments/{env_id}", body=body)
            return [TextContent(type="text", text=json.dumps(result, indent=2))]
  • Input schema definition for putEnvironment tool. Requires environmentId (string), accepts optional environment object with name and values.
    def get_tool_description(self) -> Tool:
        return Tool(
            name=self.name,
            description="Replaces all environment contents. Max size 30MB.",
            inputSchema={
                "type": "object",
                "properties": {
                    "environmentId": {
                        "type": "string",
                        "description": "Environment ID"
                    },
                    "environment": {
                        "type": "object",
                        "description": "Environment object with name and values"
                    }
                },
                "required": ["environmentId"]
            },
        )
  • Registration of PutEnvironmentTool() in the register_all_tools() function, which returns all tool handlers as a list.
    PutEnvironmentTool(),
  • Test file listing 'putEnvironment' among the expected tool names that must be registered.
    "putEnvironment",
  • The ToolHandler abstract base class that PutEnvironmentTool (and all tools) extend. Provides the interface for get_tool_description() and run_tool().
    class ToolHandler(ABC):
        """Base class for all Postman tool handlers"""
        
        def __init__(self, name: str):
            self.name = name
        
        @abstractmethod
        def get_tool_description(self) -> Tool:
            """Return the MCP Tool description for this handler"""
            pass
        
        @abstractmethod
        async def run_tool(self, arguments: dict) -> list[TextContent | ImageContent | EmbeddedResource]:
            """Execute the tool with the given arguments"""
            pass
Behavior4/5

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

No annotations provided, so description carries burden. It discloses the destructive nature (replaces all) and a key constraint (max 30MB). Does not cover permissions, error handling, or side effects, but the given info is valuable.

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?

Two short sentences, front-loaded with the main action. No redundant information. Every word is necessary.

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?

No output schema, so return value is undefined. Description does not mention success/failure, side effects, or prerequisites. While the core action is clear, additional context about behavior would improve completeness.

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 coverage is 100% with descriptions for both parameters. Description adds the size limit but does not elaborate on the environment object structure beyond schema. Baseline 3 with some additional value from size constraint.

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 'Replaces all environment contents' clearly states the action (replaces), resource (environment), and scope (all contents). The size constraint adds specificity. Sibling tools include createEnvironment, so the description distinguishes this as an overwrite operation.

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?

No explicit guidance on when to use vs alternatives like createEnvironment or partial updates. The phrase 'replaces all' implies full overwrite, but no usage or exclusion cases are mentioned.

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/Sourav4670/postman-mcp'

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