Skip to main content
Glama

Get API details

get_api
Read-only

Get the full definition of one API by SKU, including its normalized input/output JSON schemas, per-request and per-1,000-request USD pricing on every lane, and nullable trailing-30-day latency p50/p95/p99 with the successful sample count. Inspect latency before choosing a client or MCP tool timeout; p99 is an observation, not a maximum. Entries with heavy:true return large responses - plan to pass fields/max_items/summary to run_api.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sku_idYesthe API SKU slug to describe
contextYesExplain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization."

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
scraperYesthe API definition with input/output schemas

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed22 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "sku_id"
      -]New value: +[
      +  "sku_id",
      +  "context"
      +]
    • removedOutput schema / properties / scraper / properties / baseUsd
      Removed value: -{
      -  "description": "fixed cost per request in USD, charged regardless of count",
      -  "type": "number"
      -}
    • addedOutput schema / properties / scraper / properties / excludesCallerDelay
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / scraper / properties / execution
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "mode": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "mode"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / scraper / properties / failover
      Added value: +{
      +  "type": "boolean"
      +}
    • removedOutput schema / properties / scraper / properties / heavy / description
      Removed value: -"true when this API's responses are typically large; pass fields, max_items, or summary to run_api (and a small limit in the input) to keep the result out of your context"
    • changedOutput schema / properties / scraper / properties / inputSchema
      Previous value: -{
      -  "description": "normalized input JSON Schema"
      -}New value: +true
    • addedOutput schema / properties / scraper / properties / lanes
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "health": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "latencyP50Ms": {
      +            "type": "integer"
      +          },
      +          "latencySample": {
      +            "type": "integer"
      +          },
      +          "requests": {
      +            "type": "integer"
      +          },
      +          "servedRequests": {
      +            "type": "integer"
      +          },
      +          "uptimePct": {
      +            "type": "number"
      +          },
      +          "uptimeSample": {
      +            "type": "integer"
      +          },
      +          "window": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "window",
      +          "uptimePct",
      +          "latencyP50Ms",
      +          "uptimeSample",
      +          "latencySample",
      +          "requests",
      +          "servedRequests"
      +        ],
      +        "type": [
      +          "null",
      +          "object"
      +        ]
      +      },
      +      "pricing": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "baseUsd": {
      +            "type": [
      +              "null",
      +              "number"
      +            ]
      +          },
      +          "maxPer1kUsd": {
      +            "type": "number"
      +          },
      +          "maxUsd": {
      +            "type": "number"
      +          },
      +          "model": {
      +            "type": "string"
      +          },
      +          "perUnitUsd": {
      +            "type": [
      +              "null",
      +              "number"
      +            ]
      +          },
      +          "unit": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "model",
      +          "unit",
      +          "maxUsd",
      +          "maxPer1kUsd"
      +        ],
      +        "type": "object"
      +      },
      +      "source": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "artworkKey": {
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "kind": {
      +            "type": "string"
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "name",
      +          "kind",
      +          "artworkKey"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "pricing",
      +      "source"
      +    ],
      +    "type": "object"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
    • addedOutput schema / properties / scraper / properties / latency
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "basis": {
      +      "type": "string"
      +    },
      +    "p50Ms": {
      +      "type": "integer"
      +    },
      +    "p95Ms": {
      +      "type": "integer"
      +    },
      +    "p99Ms": {
      +      "type": "integer"
      +    },
      +    "sample": {
      +      "type": "integer"
      +    },
      +    "window": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "window",
      +    "p50Ms",
      +    "p95Ms",
      +    "p99Ms",
      +    "sample",
      +    "basis"
      +  ],
      +  "type": [
      +    "null",
      +    "object"
      +  ]
      +}
    • addedOutput schema / properties / scraper / properties / method
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / scraper / properties / outputSchema
      Previous value: -{
      -  "description": "normalized output JSON Schema"
      -}New value: +true
    • addedOutput schema / properties / scraper / properties / path
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / properties / scraper / properties / perItemUnit
      Removed value: -{
      -  "description": "the unit perItemUsd is charged per: 'result' (default) or an input unit like 'username' for input-priced SKUs",
      -  "type": "string"
      -}
    • removedOutput schema / properties / scraper / properties / perItemUsd
      Removed value: -{
      -  "description": "marginal cost in USD per billable unit (see perItemUnit); total = baseUsd + perItemUsd × unitCount, capped at priceUsd",
      -  "type": "number"
      -}
    • removedOutput schema / properties / scraper / properties / priceUsd
      Removed value: -{
      -  "description": "maximum price per request in USD (the reserved ceiling at the default limit)",
      -  "type": "number"
      -}
    • addedOutput schema / properties / scraper / properties / pricing
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "failoverMaxPer1kUsd": {
      +      "type": "number"
      +    },
      +    "failoverMaxUsd": {
      +      "type": "number"
      +    },
      +    "from": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "baseUsd": {
      +          "type": [
      +            "null",
      +            "number"
      +          ]
      +        },
      +        "maxPer1kUsd": {
      +          "type": "number"
      +        },
      +        "maxUsd": {
      +          "type": "number"
      +        },
      +        "model": {
      +          "type": "string"
      +        },
      +        "perUnitUsd": {
      +          "type": [
      +            "null",
      +            "number"
      +          ]
      +        },
      +        "unit": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "model",
      +        "unit",
      +        "maxUsd",
      +        "maxPer1kUsd"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "from",
      +    "failoverMaxUsd",
      +    "failoverMaxPer1kUsd"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / scraper / properties / provider
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / scraper / properties / tryEligible
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / scraper / properties / tryMaxItems
      Added value: +{
      +  "type": [
      +    "null",
      +    "integer"
      +  ]
      +}
    • changedOutput schema / properties / scraper / required
      Previous value: -[
      -  "id",
      -  "slug",
      -  "category",
      -  "name",
      -  "description",
      -  "priceUsd",
      -  "baseUsd",
      -  "perItemUsd"
      -]New value: +[
      +  "id",
      +  "slug",
      +  "category",
      +  "name",
      +  "method",
      +  "path",
      +  "provider",
      +  "execution",
      +  "pricing",
      +  "failover",
      +  "description",
      +  "lanes",
      +  "latency",
      +  "tryEligible"
      +]
  2. Changed1 schema field changed
    • addedOutput schema / properties / scraper / properties / heavy
      Added value: +{
      +  "description": "true when this API's responses are typically large; pass fields, max_items, or summary to run_api (and a small limit in the input) to keep the result out of your context",
      +  "type": "boolean"
      +}
  3. First observed

TDQS

A4.5/5.0
Behavior5/5

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

The description adds valuable behavioral context beyond the read-only annotations: latency metrics are nullable observations ('p99 is an observation, not a maximum'), and heavy:true entries can produce large responses requiring follow-up planning. This level of disclosure helps the agent anticipate response characteristics and downstream actions.

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?

Three sentences with front-loaded purpose and details, followed by actionable caveats. There is no redundant phrasing, and every sentence contributes either to what the tool returns or how to use the result safely.

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?

Given an output schema and comprehensive annotations, the description covers the essential operational nuance: heavy responses, latency interpretation, and next-step planning. An agent has enough information to call this tool correctly and act on the returned data.

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 both sku_id and context are already well documented in the schema. The description reinforces that lookup is by SKU and mentions heavy:true response entries, but it does not add substantial meaning to the tool's own parameters beyond what the schema provides.

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?

The description opens with a specific verb and resource: 'Get the full definition of one API by SKU,' and distinguishes this from list/search-style siblings by clearly enumerating the detailed contents (schemas, pricing, latency). An agent can immediately differentiate this from list_apis and search_apis.

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

Usage Guidelines4/5

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

The description provides a concrete use case: 'Inspect latency before choosing a client or MCP tool timeout,' and gives actionable guidance for heavy:true entries. It does not explicitly name alternatives or state when not to use the tool, but the context is clear enough for correct selection.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool has a clearly distinct role: discovery (list_apis, search_apis, get_api), pricing (quote_api), execution (run_api), request/result inspection (get_request, read_result), account status (get_balance), and feedback (report_bug, send_feedback). Even the two feedback tools are cleanly separated by defect vs. non-defect.

Naming Consistency5/5

Names consistently follow a snake_case verb_noun pattern: get_api, get_balance, get_request, list_apis, quote_api, read_result, report_bug, run_api, search_apis, send_feedback. There is no mixing of conventions or vague single-word verbs.

Tool Count5/5

Ten tools is well-scoped for an API gateway/aggregator. Each tool covers a necessary phase of the workflow—discovery, schema/pricing inspection, execution, result retrieval, account balance, and user feedback—without redundancy or bloat.

Completeness4/5

The lifecycle from discovering APIs through quoting, executing, checking request status, and reading cached results is well covered. Minor gaps such as no explicit way to cancel a queued/running request or list past requests are workable but not fully closed.

Resources