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.

  1. Changed1 schema field changed
    • addedOutput schema / properties / scraper / properties / lanes / items / properties / fields
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
  2. 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"
      +  ]
      +}
  3. 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"
      +]
  4. 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"
      +}
  5. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the readOnlyHint/destructiveHint annotations, the description discloses meaningful behavioral caveats: latency values are nullable trailing-30-day observations, p99 is not a maximum, and heavy:true entries produce large responses requiring callers to plan how they will invoke run_api. No statement contradicts the annotations.

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 dense, purposeful sentences: the first is front-loaded with the core purpose and deliverable, the second adds a latency caveat, and the third warns about heavy responses. No filler or redundant restatement.

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 the output schema and the readOnly/destructive annotations, the description covers what the agent needs to select and invoke the tool correctly: return contents, a key statistical caveat, and handling for large responses. The remaining details, such as parameter formatting, live in the schema.

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 the schema already documents sku_id and context, including the detailed context-length and grammar rules. The description adds no new parameter-level semantics, hitting the baseline of 3.

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 opening clause 'Get the full definition of one API by SKU' names a specific verb, resource, and exact identifier, and the rest of the sentence enumerates the concrete content (schemas, pricing, latency). This is enough to distinguish it from sibling list/search/run tools, even without an explicit alternative.

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 gives actionable guidance: inspect latency before choosing a client or MCP timeout, and for heavy:true entries pass fields/max_items/summary to run_api. It stops short of explicitly stating when-not-to-use get_api or naming the preferred sibling for other cases, so it earns a 4 rather than a 5.

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.