Skip to main content
Glama

get_api_schema

Retrieve a specific API schema from Postman to understand data structures and validate API responses.

Instructions

Get a specific schema from an API

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiIdYesAPI ID
schemaIdYesSchema ID
versionIdNoVersion ID (required for API viewers)
bundledNoReturn schema in bundled format
Behavior2/5

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

With no annotations, the description carries full burden but only states the action without behavioral details. It doesn't disclose if this is a read-only operation, requires authentication, has rate limits, or what the output format looks like (e.g., JSON schema, bundled data). This leaves significant gaps for a tool that likely involves API interactions.

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 a single, efficient sentence with no wasted words. It's front-loaded with the core action, making it easy to parse quickly, though this conciseness contributes to gaps in other dimensions.

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 no annotations and no output schema, the description is incomplete for a tool with 4 parameters and likely complex behavior (e.g., retrieving API schemas). It fails to explain return values, error conditions, or how parameters interact, leaving the agent under-informed for proper invocation.

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 the input schema fully documents parameters like 'apiId', 'schemaId', 'versionId', and 'bundled'. The description adds no additional meaning beyond the schema, such as explaining relationships between parameters or usage examples, meeting the baseline for high coverage.

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 'Get a specific schema from an API' clearly states the verb ('Get') and resource ('schema'), but it's vague about what 'specific schema' means compared to siblings like 'get_api_schema_files' or 'get_schema_file_contents'. It doesn't specify whether this retrieves metadata, content, or bundled formats, leaving the purpose ambiguous relative to alternatives.

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 is provided on when to use this tool versus siblings such as 'get_api_schema_files' or 'get_schema_file_contents'. The description lacks context about prerequisites, alternatives, or exclusions, leaving the agent to infer usage from the tool name alone.

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