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

postman-mcp-server

by delano
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

create_api

Create a new API in a target workspace by providing its name, summary, and Markdown description.

Instructions

Create a new API

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": {
      "name": "<name>",
      "workspaceId": "<workspaceId>"
    },
    "name": "create_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesAPI name
summaryNoBrief description
descriptionNoDetailed description (supports Markdown)
workspaceIdYesTarget workspace ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.5/5.0
Behavior2/5

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It only states the generic action without revealing if the operation is idempotent, destructive, requires specific permissions, or has side effects.

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

Conciseness3/5

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

The description is concise at one sentence, but it is under-specified for a creation tool with multiple parameters and likely complex behavior. It lacks structure (e.g., sections or examples) that could aid usability.

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 absence of an output schema and annotations, the description should explain return values, side effects, or success indicators. It does not cover these, leaving the agent without crucial context for a four-parameter creation 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 coverage is 100%, with all four parameters described adequately. The description adds no additional meaning beyond what is already in the input schema, so it meets 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 'Create a new API' clearly states the verb and resource, but it lacks differentiation from sibling tools like create_api_version or add_api_collection. It does not specify what 'API' means in this context or any scope details.

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. There is no mention of prerequisites, required workspace configurations, or which sibling tools might be more appropriate for different scenarios.

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