Skip to main content
Glama
Sign In
postman-mcp-server

postman-mcp-server

by delano
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

sync_collection_with_schema

Synchronize a Postman collection with its API schema to ensure requests match schema definitions.

Instructions

Sync a collection with its schema

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "apiId": "<apiId>",
      "collectionId": "<collectionId>"
    },
    "name": "sync_collection_with_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiIdYesAPI ID
collectionIdYesCollection ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations provided. The description does not disclose behavioral traits such as whether the operation is destructive, requires permissions, or modifies data. Minimal insight beyond the name.

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 a single sentence that front-loads the main action. It is concise, but more detail could be added without sacrificing structure.

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?

Given the complexity of a sync operation, the description lacks completeness. No output schema, no explanation of side effects or prerequisites. Important behavioral context is missing.

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% (both parameters have descriptions), but those descriptions are minimal ('API ID', 'Collection ID'). The tool description does not add additional meaning, so baseline 3 is appropriate.

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 uses a specific verb 'sync' and resource 'collection with its schema', clearly indicating the action. It distinguishes itself from sibling CRUD tools, but does not elaborate on what syncing entails.

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?

No guidance on when to use this tool versus alternatives, no prerequisites or exclusions mentioned. The description provides no context for appropriate usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools