Skip to main content
Glama

Get API details

get_api
Read-only

Get the full definition of one API by API slug, including its normalized input/output JSON schemas, per-request and per-1,000-request USD pricing on every source, and nullable trailing-30-day latency p50/p95/p99 with the successful sample count. Latency percentiles describe observed successful requests; p99 is an observation, not a maximum or a client timeout guarantee. Entries with heavy:true produce large API responses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sku_idYesthe API SKU slug to describe
contextYesBrief purpose of this tool call within the requested task, used for analytics and user-intent tracking.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
scraperYesthe API definition with input/output schemas

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / context / description
      Previous value: -"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.\""New value: +"Brief purpose of this tool call within the requested task, used for analytics and user-intent tracking."
  2. Changed1 schema field changed
    • addedOutput schema / properties / scraper / properties / lanes / items / properties / health / properties / blockedPct
      Added value: +{
      +  "type": [
      +    "null",
      +    "number"
      +  ]
      +}
  3. Changed1 schema field changed
    • addedOutput schema / properties / scraper / properties / lanes / items / properties / fields
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
  4. Changed2 schema fields changed
    • addedOutput schema / properties / scraper / properties / lanes / items / properties / pricing / properties / addons
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "field": {
      +        "type": "string"
      +      },
      +      "id": {
      +        "type": "string"
      +      },
      +      "label": {
      +        "type": "string"
      +      },
      +      "usd": {
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "label",
      +      "field",
      +      "usd"
      +    ],
      +    "type": "object"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
    • addedOutput schema / properties / scraper / properties / pricing / properties / from / properties / addons
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "field": {
      +        "type": "string"
      +      },
      +      "id": {
      +        "type": "string"
      +      },
      +      "label": {
      +        "type": "string"
      +      },
      +      "usd": {
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "label",
      +      "field",
      +      "usd"
      +    ],
      +    "type": "object"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
  5. 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"
      +]
  6. 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"
      +}
  7. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive), yet the description adds genuinely non-obvious context: latency fields are nullable and describe observed successful requests, p99 is an observation not a timeout guarantee, and entries with heavy:true produce large responses. The p99 caveat and the response-size warning are exactly the kind of disclosure an agent can't derive from structured fields.

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?

Front-loads the returned payload in the first sentence, then appends caveats about latency semantics and heavy responses. Dense but every clause carries information; the heavy:true note is slightly tacked on at the end rather than integrated.

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?

An output schema exists, so return values need not be fully explained, yet the description still enumerates payload contents plus latency nullability and response-size warnings. It is complete for a single-resource lookup; only explicit sibling routing (vs list_apis/search_apis) is missing.

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 coverage is 100% and both parameters are documented there, so the schema does the heavy lifting. The description's 'by API slug' loosely maps to sku_id, though the schema calls it an 'API SKU slug' while the description says 'API slug' – a minor terminology drift, but no added syntax or format detail. Baseline 3 applies.

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?

States a specific verb ('Get') and resource ('the full definition of one API by API slug') and enumerates the returned payload: normalized input/output JSON schemas, per-request and per-1,000-request USD pricing, and latency percentiles. This clearly separates it from siblings like list_apis, search_apis, run_api, and quote_api, which an agent can distinguish without opening a schema.

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

Usage Guidelines3/5

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

The 'one API by API slug' scoping implies lookup-by-identifier usage, but the description never states when to pick this over list_apis, search_apis, or quote_api, nor any prerequisites. Usage is inferable rather than explicit.

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.

Resources