Skip to main content
Glama

Get Spec

get_spec
Read-onlyIdempotent

Returns the full spec payload for a provider + capability, including canonical_example.ts source code. Use this to get the complete integration guide — auth pattern, endpoint, schemas, gotchas, and a TypeScript example — before writing API calls.

The response includes a "status" field:

  • "verified": tested against the provider's API, in "sandbox" or "production" (verified_in / verification.environment)

  • "deprecated": the provider is retiring it — "deprecation" gives the reason, replaced_by (the capability to use instead) and removed_after

  • anything else (e.g. "ready", "unverified"): written from the provider's documentation, NOT tested against the live API "verification" says how and when it was tested; sandbox proves the request and response shapes, not production behaviour. "open_questions", when present, lists what the provider's docs do not answer: tell the user before relying on the spec. "account", when present, says who can open the provider's account; list_providers and search_specs add its open questions (caps, conditions) and sources. "environments", when present, gives each documented environment's base URL; a missing one is undocumented — ask the user, never guess. "auth.credentials" / "signing" / "token_exchange" / "apply" and "webhook.signature", when present, describe the auth and webhook signature steps exactly: follow them. "parameters", when present, lists the path, query and header parameters; "input_schema" is the request body only. A path parameter fills the {name} placeholder of endpoint.url. "success_condition", when present, names the response field (dotted path) that says the call succeeded: a 2xx response with another value is a failure.

If status is not "verified", always warn the user before generating integration code: "This spec has not been tested against the live API yet and may contain errors."

Args:

  • provider (string): Provider slug e.g. "paycard"

  • capability (string): Capability name e.g. "create_payment"

  • variant (string[]?): Discriminator values to keep, e.g. ["mobile_money_ghs"] or ["bank", "NGN"]. In every union (oneOf) of input_schema and response_schema, only the branches pinned to one of these values are kept; a union none of them matches is left whole. Without it, all branches are returned. The response lists every value under "variants" (discriminator property → values). A large spec also carries "_mcp_size_note": if your client cut the result, call again with the variant you need.

Returns: Full Spec object with canonical_example string (plus _mcp_warning when status is not "verified"). If not found: isError, with { error, available_capabilities } when the provider exists — capability names are each provider's own, pick one from that list — and did_you_mean (closest provider slugs or capability names) when one is close. A capability removed from the registry after a provider deprecation answers isError with removed_in, reason and alternatives. Use search_specs or list_providers first to discover available providers and capabilities.

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": {
      "provider": "<provider>",
      "capability": "<capability>"
    },
    "name": "get_spec"
  }
}

Input Schema

NameRequiredDescriptionDefault
variantNoDiscriminator values to keep, e.g. ["mobile_money_ghs"] — see "variants" in search_specs
providerYesProvider slug e.g. "paycard"
capabilityYesCapability name e.g. "create_payment"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only say read-only/idempotent; the description goes far beyond by explaining the status taxonomy (verified vs deprecated vs ready/unverified), that sandbox verification does not prove production behaviour, that a missing environment must be asked about rather than guessed, and that a 2xx with the wrong success_condition value is a failure. The deprecation-removal error path (removed_in, reason, alternatives) and the _mcp_size_note truncation-recovery hint are also disclosed.

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?

Long but well structured, with the core purpose front-loaded and field semantics broken into quoted-key bullets that scan quickly. Minor redundancy: the not-verified warning is stated in the status list and again as a mandated message, and restated in the Returns block.

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

Completeness5/5

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

There is no output schema, so the description carries the burden of explaining the return shape — and it does, field by field (status, verification, open_questions, account, environments, auth/signing/token_exchange, parameters vs input_schema, success_condition). Error and truncation behaviour are covered, leaving nothing essential an agent needs to call this correctly.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds real meaning for variant: that it prunes oneOf branches in input_schema and response_schema, that non-matching unions are left whole, and that the returned "variants" map tells you the discriminator values. It also clarifies that path parameters fill {name} in endpoint.url, which the schema does not say.

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

Purpose5/5

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

Opens with a specific verb and resource ("Returns the full spec payload for a provider + capability") and names the concrete artifact included (canonical_example.ts). It is clearly distinct from the discovery siblings named later (search_specs, list_providers).

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

Usage Guidelines5/5

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

States the triggering condition explicitly: "Use this to get the complete integration guide ... before writing API calls", and routes discovery to search_specs or list_providers first. It also tells the agent what to do on a miss (pick a capability from available_capabilities, check did_you_mean) and when to re-call with a variant.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.