Skip to main content
Glama

sync_collection_with_schema

Align Postman collection with API schema to ensure requests match current API specifications and maintain consistency.

Instructions

Sync a collection with its schema

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiIdYesAPI ID
collectionIdYesCollection ID
Behavior1/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure but fails completely. 'Sync' implies a mutation operation, but there's no information about whether this is destructive, what permissions are required, whether it's reversible, what side effects occur, or what the expected outcome looks like. For a tool that likely modifies collection-schema relationships, this lack of behavioral context is critically inadequate.

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?

While technically concise with just one sentence, this is a case of under-specification rather than effective conciseness. The single sentence doesn't earn its place by providing meaningful information beyond the tool name. A truly concise description would pack more operational clarity into its limited word count rather than just restating the obvious.

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

Completeness1/5

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

Given the complexity implied by 'sync' operations (which often involve reconciliation, validation, or alignment between systems), the complete absence of annotations, no output schema, and a minimal description, this is severely incomplete. The agent cannot understand what this tool actually does, when to use it, what behavior to expect, or what results it produces. For a likely mutation tool in a rich API ecosystem, this description is fundamentally inadequate.

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 schema description coverage is 100%, with both parameters (apiId and collectionId) having basic descriptions in the schema. The tool description adds no additional parameter information beyond what's already in the structured schema. According to the scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description, which applies here.

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

Purpose2/5

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

The description 'Sync a collection with its schema' is a tautology that essentially restates the tool name 'sync_collection_with_schema'. While it indicates the general action (sync) and target (collection with schema), it lacks specificity about what 'sync' actually means operationally. It doesn't distinguish this tool from potential siblings like 'update_api_schema' or 'create_update_schema_file' that might also involve schema-related operations.

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

Usage Guidelines1/5

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

The description provides absolutely no guidance about when to use this tool versus alternatives. With numerous sibling tools involving collections, schemas, updates, and creations, there's no indication of what triggers this sync operation, what prerequisites exist, or what distinguishes it from tools like 'update_collection', 'create_update_schema_file', or 'patch_collection'. The agent receives no usage context whatsoever.

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/PostmanV3/mcp-PostmanV3'

If you have feedback or need assistance with the MCP directory API, please join our Discord server