Skip to main content
Glama

Create a mock server (provide collection UID)

createMock

Create a mock server for an API collection in a specified workspace to simulate endpoints and test API behavior without a backend.

Instructions

Creates a mock server in a collection.

  • Pass the collection UID (ownerId-collectionId), not the bare collection ID.

  • If you only have a `collectionId`, resolve the UID first:

    1. Prefer GET `/collections/{collectionId}` and read `uid`, or

    2. Construct `{ownerId}-{collectionId}` using ownerId from GET `/me`:

    • For team-owned collections: `ownerId = me.teamId`

    • For personal collections: `ownerId = me.user.id`

  • Use the `workspace` query to place the mock in a specific workspace. Prefer explicit workspace scoping.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mockNo
workspaceYesThe workspace's ID.
Behavior4/5

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

Annotations already indicate a mutating operation (readOnlyHint=false, destructiveHint=false). The description adds valuable context about the requirement for a collection UID rather than a bare ID, and explains the resolution process, which goes beyond the structured annotations.

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 well-structured with bullets and numbered steps. It front-loads the main purpose and then provides necessary details. While a bit long, every sentence adds essential information for correct invocation.

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?

Given the nested object schema, the absence of an output schema, and the potential ambiguity around collection IDs, the description covers the critical aspects: UID resolution, workspace scoping, and default behavior. The agent has enough information to call the tool correctly.

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 description coverage is only 50%, but the description compensates by clearly explaining that the 'collection' parameter expects a UID in the ownerId-collectionId format and provides resolution steps. It also clarifies the purpose of the 'workspace' parameter.

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 'Creates a mock server in a collection' with a specific verb and resource. This distinguishes it from sibling tools like getMock, updateMock, and publishMock, which serve different actions.

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

Usage Guidelines4/5

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

Provides explicit guidance on how to obtain the collection UID and recommends explicit workspace scoping. It does not name alternative tools for when not to use this tool, but the overall context and steps make the usage clear.

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