Skip to main content
Glama

syncSpecWithCollection

Idempotent

Sync an API specification (OpenAPI 2.0, 3.0, 3.1) to its linked Postman collection. Asynchronous endpoint returns HTTP 202 accepted.

Instructions

Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response.

Note:

  • This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types.

  • This endpoint only supports the OpenAPI 2.0 and 3.0 specification types.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
specIdYesThe spec's ID.
collectionUidYesThe collection's unique ID.
Behavior2/5

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

The description adds that the endpoint is asynchronous and returns a 202 Accepted response, which is useful beyond the annotations (idempotentHint=true). However, the contradictory note (first bullet supports 3.1, second says only 2.0 and 3.0) is misleading and harms transparency. It does not clarify what happens for unsupported spec types or the exact effects of syncing.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short but marred by redundancy and contradiction. The note repeats the spec type limitation with conflicting versions, and the title in annotations repeats the description. This undermines conciseness and clarity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an asynchronous mutation tool with no output schema, the description lacks completeness. It does not explain what 'syncs' entails (e.g., which direction, whether data is overwritten), expected response structure, polling mechanism, or error scenarios. The contradictory note adds confusion instead of closure.

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?

The input schema has 100% description coverage for both parameters (specId and collectionUid), so the schema already provides sufficient meaning. The description does not add extra parameter-level details, meeting the baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Syncs an API specification linked to a collection', which is a clear verb and resource, but it fails to differentiate from the sibling tool 'syncCollectionWithSpec', leaving the direction of sync ambiguous. The contradictory note about supported versions further muddles the purpose.

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?

The description provides minimal usage guidance: it mentions the asynchronous nature and supported spec types, but does not advise when to use this tool versus the sibling, nor does it list prerequisites, error conditions, or expected outcomes.

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