Skip to main content
Glama

Get a schema

get_schema

Retrieve a named API component JSON schema with inlined $refs to inspect payload structures and integration contracts.

Instructions

One JSON schema from the API components, with $refs inlined. Names: Address, ClassifiedEmail, Customer, CustomerBulkResult, CustomerBulkRow, CustomerListResponse, CustomerProduct, CustomerProductBulkResult, CustomerProductBulkRow, CustomerProductListResponse, CustomerProductUpsert, CustomerSearchResponse, CustomerUpsert, EmailClassificationResponse, ErpAddress, ErpCustomer, ErpOrderItem, ErpPurchaseOrder, ErpReceiveRequest, ErpReceiveResponse, ErpRecipient, ErpSendResponse, ErpShippingDetails, ErrorResponse, FetchAllEmailsResponse, HTTPValidationError, OrderCustomer, OrderFile, OrderGroup, OrderItem, OrderListResponse, OrderRef, OrderRetryBody, OrderStatus, OrderStatusValue, OrderUploadBody, OrderUploadResponse, ProcessingWebhookRequest, Product, ProductBulkResult, ProductBulkRow, ProductListResponse, ProductUpsert, PurchaseOrder, RawEmailClassifyBody, RawEmailUploadBody, RawUploadRejection, RejectedEmailListResponse, ReprocessResponse, ShippingDetails, ShippingRecipient, SkippedMapping, Supplier, SystemStatus, ValidationError.

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>"
    },
    "name": "get_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.6/5.0
Behavior3/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, and it does disclose one real behavioral trait: $refs are inlined in the returned schema. The imperative 'get' implies a read-only, side-effect-free operation. However, it does not state what happens for an unrecognized name (error type), what the response format is (JSON object vs. serialized text), or any retrieval constraints — meaningful gaps for a tool with zero annotation coverage.

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 prose portion is a single waste-free sentence with the purpose front-loaded, and the long name list earns its place because the schema contains no enum. Structure could be slightly improved by labeling the list (e.g., 'Valid names:') rather than embedding it in the sentence, but nothing is redundant.

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

Completeness4/5

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

For a one-parameter lookup tool with no annotations and no output schema, the description covers both what is retrieved and the complete set of valid inputs, which is most of what an agent needs. Missing are the response format and unknown-name behavior, which are minor for a straightforward retrieval tool but not trivial given the absence of an output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% — the single 'name' parameter is only constrained to a 1–80 character string with no documentation. The description compensates fully by enumerating all 55 accepted values, effectively supplying the enum the schema omits. This is exactly the kind of added meaning the parameter semantics dimension rewards.

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 states the resource precisely — 'One JSON schema from the API components, with $refs inlined' — and enumerates the exact schema names available, which makes it unmistakably distinct from data-fetching siblings like get_customer or get_product. It lacks an explicit verb-and-scope sentence (e.g., 'retrieves a single component schema by name'), which keeps it just short of a 5.

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?

There is no when-to-use or when-not-to-use guidance, and no alternatives are named. The agent is not told, for example, to call this before upsert_customer to learn required fields, or that it should not be used to fetch actual records. The enumerated name list implies scope but not usage conditions.

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