Skip to main content
Glama
vp2437
by vp2437

swagger_get_schema

Fetch a schema or model definition from Swagger/OpenAPI documentation by name. Inspect data structures, resolve nested $refs, and limit response length as needed.

Instructions

Get a schema/model definition from Swagger documentation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxCharsNoMax characters in the returned text (0 = unlimited; defaults to config.maxResponseChars).
schemaNameYesName of the schema/model (e.g., UserDto, CreateUserRequest)
environmentNoEnvironment name (defaults to the active environment)
resolveRefsNoInline nested $ref pointers (default: true)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.1

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It indicates a read-only 'Get' operation but omits any detail about response format, truncation, $ref resolution, or environment handling. It adds little behavioral context beyond the tool 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, direct sentence with no filler or repetition. It front-loads the action and object, though it is terse enough that it sacrifices some useful context.

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?

With no output schema and no annotations, the description does not explain what the tool returns, how errors or missing schemas are handled, or when it should be preferred over sibling tools. The parameter schema carries most of the operational burden, but the overall definition is not complete for deciding and invoking correctly.

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 documents all four parameters with descriptions, giving 100% schema coverage, so the description does not need to repeat them. The description adds no extra parameter meaning beyond identifying the target as a schema/model, which maps to schemaName.

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 ('Get') and names a specific resource: a schema/model definition from Swagger documentation. This distinguishes it from sibling tools focused on endpoints or API requests, though it does not explicitly contrast itself with swagger_get_endpoint.

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 gives no guidance on when to use this tool versus alternatives like swagger_list_endpoints or swagger_get_endpoint. There are no prerequisites, exclusions, or workflow hints—only the tool name and noun phrase imply its purpose.

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