Skip to main content
Glama

generateSpecFromCollection

Generate an API specification from a Postman collection by specifying the collection ID, name, type, and format. Returns a polling link to track task progress.

Instructions

Generates an API specification for the given collection. The response contains a polling link to the task status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionUidYesThe collection's unique ID.
elementTypeYesThe `spec` value.
nameYesThe API specification's name.
typeYesThe specification's type.
formatYesThe format of the API specification.
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false. The description adds that the response contains a polling link, indicating an asynchronous task. This is valuable behavioral context beyond annotations, though it does not elaborate on side effects or idempotency.

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?

The description is two sentences with no wasted words. The first sentence states the core purpose, and the second adds a critical detail about the response. Every sentence earns its place.

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 tool has 5 required parameters and no output schema, the description covers the essential aspects: generating a spec and polling for status. It could be more explicit about the asynchronous nature and how to retrieve the result, but it is adequate for an agent to understand the tool.

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 baseline is 3. The description does not add any parameter-specific details beyond what the schema already provides. It does not explain how parameters affect behavior.

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 it generates an API specification from a collection, using specific verb 'generates' and resource 'API specification'. It mentions the polling link in the response, adding valuable detail. This distinguishes it from siblings like createSpec (which creates a spec directly) and syncSpecWithCollection (which syncs).

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?

There is no guidance on when to use this tool versus alternatives. No exclusions or context provided. The description does not mention when not to use it or suggest alternatives like syncSpecWithCollection for existing specs.

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