Skip to main content
Glama

updateWorkspace

Idempotent

Modify workspace details like name, type, or description in Postman to manage API collaboration and organization.

Instructions

Updates a workspace.

Note:

  • There are rate limits when publishing public workspaces.

  • Public team workspace names must be unique.

Important

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

  • The endpoint does not create a clone of a collection or environment.

  • Any changes you make to a linked collection or environment changes them in all workspaces.

  • If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdYesThe workspace's ID.
workspaceNo
Behavior4/5

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

The description adds significant behavioral context beyond what annotations provide, including rate limits for public workspaces, uniqueness requirements, and detailed warnings about deprecated linking behavior. While annotations cover idempotency and non-destructive nature, the description enriches understanding of workspace-specific constraints and mutation behaviors.

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 description is front-loaded with the core purpose but becomes verbose with multiple bullet points and warnings. While all information appears relevant, the structure could be more streamlined, with some redundancy in the annotations field where the same text appears.

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 mutation tool with no output schema, the description provides substantial context about behavioral constraints, deprecations, and side effects. It compensates well for the lack of output schema by explaining what changes propagate and deletion consequences, though it could mention response format or error conditions.

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?

With 50% schema description coverage, the description doesn't mention any parameters directly, leaving the schema to document workspaceId and the workspace object properties. The description focuses on behavioral aspects rather than parameter semantics, meeting the baseline expectation when schema coverage is moderate.

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 clearly states the verb 'Updates' and resource 'a workspace', making the purpose immediately understandable. However, it doesn't specifically differentiate this tool from potential sibling update operations (like updateMock or updateSpecFile) beyond the workspace focus, which is why it doesn't reach a perfect score.

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 provides implied usage guidance through notes about rate limits, uniqueness requirements, and deprecation warnings, but doesn't explicitly state when to use this tool versus alternatives like createWorkspace or getWorkspace. The context is helpful but not comprehensive for decision-making.

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