Skip to main content
Glama

Apiosk run

apiosk_execute
Destructive

Run the offer the user chose and return the result. Apiosk settles the call from the connected balance, at the price that was shown. Pass offer_token exactly as apiosk_discover returned it for the row the user picked, prompt set to the job you searched for, and max_price_usdc set to the price you showed — the call is refused rather than settled if the real price is above it. The token pins the endpoint and the price together, so there is nothing else to state and no price for you to restate. Before calling: say the exact price to the user and have them choose; never pick for them and never call this to explore. A token is good for an hour — if the user takes longer, run apiosk_discover again and use the fresh one. If the buyer's rules require a human to approve, this returns status: approval_required with an approval_id: poll apiosk_approval_status, then call this again with the same offer_token once approved. If it returns status: payment_required, the balance is empty or over its limit: call apiosk_connect to see which, and do not retry.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
inputNoThe request body, in the provider's own schema.
queryNoOptional query-string parameters.
promptYesThe job you searched for, in the user's own words. Recorded with the pick so the purchase reads back as an answer to a question rather than a bare charge.
operationNoOptional explicit operation id or path.
approval_idNoOptional approval id returned by apiosk_execute after an approval_required hold.
input_partsNoOptional exact split of provider inputs by path, query and body. The Apiosk approval card supplies this automatically.
offer_tokenYesThe row the user chose, as `offer_token` from apiosk_discover. Opaque: pass it back exactly as given. It pins the endpoint AND the price the user was shown, and is good for one hour.
path_paramsNoOptional path parameters.
max_price_usdcYesThe price ceiling — the exact price you showed the user. The call is refused, not paid, if the real price exceeds it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

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

  1. Changed3 schema fields changed
    • addedInput schema / properties / approval_id
      Added value: +{
      +  "description": "Optional approval id returned by apiosk_execute after an approval_required hold.",
      +  "type": "string"
      +}
    • addedInput schema / properties / input_parts
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Optional exact split of provider inputs by path, query and body. The Apiosk approval card supplies this automatically.",
      +  "properties": {
      +    "body": {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    "path": {
      +      "additionalProperties": true,
      +      "type": "object"
      +    },
      +    "query": {
      +      "additionalProperties": true,
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / required
      Added value: +[
      +  "offer_token",
      +  "prompt",
      +  "max_price_usdc"
      +]
  2. Changed7 schema fields changed
    • removedInput schema / properties / confirmed_price_usdc
      Removed value: -{
      -  "description": "External endpoints only: the PROVIDER's own price you showed the user (`list_price_usdc`), not the total. The gateway refuses rather than pays if the live 402 asks for more than this.",
      -  "type": "number"
      -}
    • removedInput schema / properties / method
      Removed value: -{
      -  "description": "External endpoints only: the HTTP method the row publishes (`method`). Defaults to GET.",
      -  "type": "string"
      -}
    • removedInput schema / properties / offer_id
      Removed value: -{
      -  "description": "The offer the user chose, as returned by apiosk_compare. Preferred over slug.",
      -  "type": "string"
      -}
    • addedInput schema / properties / offer_token
      Added value: +{
      +  "description": "The row the user chose, as `offer_token` from apiosk_discover. Opaque: pass it back exactly as given. It pins the endpoint AND the price the user was shown, and is good for one hour.",
      +  "type": "string"
      +}
    • addedInput schema / properties / prompt
      Added value: +{
      +  "description": "The job you searched for, in the user's own words. Recorded with the pick so the purchase reads back as an answer to a question rather than a bare charge.",
      +  "type": "string"
      +}
    • removedInput schema / properties / slug
      Removed value: -{
      -  "description": "An Apiosk catalogue slug, when you already know the listing and have no offer_id.",
      -  "type": "string"
      -}
    • removedInput schema / properties / url
      Removed value: -{
      -  "description": "An external x402 endpoint to run and settle through Apiosk — the `url` of a row apiosk_compare or apiosk_discover marked `settlement: \"apiosk\"`. Requires confirmed_price_usdc.",
      -  "type": "string"
      -}
  3. Changed3 schema fields changed
    • addedInput schema / properties / confirmed_price_usdc
      Added value: +{
      +  "description": "External endpoints only: the PROVIDER's own price you showed the user (`list_price_usdc`), not the total. The gateway refuses rather than pays if the live 402 asks for more than this.",
      +  "type": "number"
      +}
    • addedInput schema / properties / method
      Added value: +{
      +  "description": "External endpoints only: the HTTP method the row publishes (`method`). Defaults to GET.",
      +  "type": "string"
      +}
    • addedInput schema / properties / url
      Added value: +{
      +  "description": "An external x402 endpoint to run and settle through Apiosk — the `url` of a row apiosk_compare or apiosk_discover marked `settlement: \"apiosk\"`. Requires confirmed_price_usdc.",
      +  "type": "string"
      +}
  4. Changed1 schema field changed
    • changedInput schema / properties / max_price_usdc / description
      Previous value: -"The price ceiling in USDC — the exact price you showed the user. The call is refused, not paid, if the real price exceeds it."New value: +"The price ceiling — the exact price you showed the user. The call is refused, not paid, if the real price exceeds it."
  5. Added
  6. Removed
  7. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "description": "Structured JSON result of the tool call. Mirrors the human-readable text content; the exact fields depend on the tool (an `error` field is present when the call fails).",
      +  "type": "object"
      +}
  8. First observed

TDQS

A4.9/5.0
Behavior5/5

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

The description far exceeds the annotations' coverage: it discloses real-money settlement from the connected balance, refusal (not settlement) when the real price exceeds max_price_usdc, a one-hour token validity window, and the two distinct status outcomes with their follow-up actions. The annotations (destructiveHint=true, openWorldHint=true, readOnlyHint=false) are consistent with and reinforced by the text — nothing contradicts them.

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?

The description is long but every sentence carries load-bearing information for a money-moving tool: settlement behavior, price ceiling, consent precondition, token TTL, and both failure paths with sibling routing. It is front-loaded with the core action and safety-critical constraints, with no filler or repetition of the schema's optional-parameter details.

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?

For a high-stakes tool with 9 parameters and nested objects, the description covers everything an agent needs: the required call shape, the user-consent precondition, the freshness requirement, and complete recovery procedures for both status outcomes. Since an output schema exists, return-value structure does not need to be spelled out, and the optional advanced parameters are already fully documented in the input schema.

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 the baseline is 3, and the description goes beyond by explaining the interlocking relationship between the three required parameters: offer_token pins endpoint AND price, max_price_usdc is the price ceiling that triggers refusal, and prompt ties the charge back to the user's question. It also clarifies that the optional params need not be touched ("there is nothing else to state"), which is genuinely useful invocation guidance.

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 — "Run the offer the user chose and return the result" — and immediately marks this as the execution step in a purchase flow. It is clearly distinguished from siblings: apiosk_discover finds offers, apiosk_connect checks balance, apiosk_approval_status polls approval. An agent can tell exactly what this tool does and what it is not.

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?

Usage guidance is explicit and conditional: call only after the user has chosen and heard the exact price; "never pick for them and never call this to explore." It also routes to alternatives in concrete failure cases — run apiosk_discover again for a stale token, call apiosk_connect on payment_required, poll apiosk_approval_status and retry on approval_required. This is the strongest possible when-to-use/when-not-to-use guidance.

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.6/5.0
Disambiguation4/5

Most tools map to distinct lifecycle stages—discover, compare, execute, plan, monitor, cancel, and resolve—so an agent can usually tell them apart. The main ambiguity is between the bare `apiosk` tool and `apiosk_discover`/`apiosk_compare`, since all three take a plain-words job and return offer-related data.

Naming Consistency4/5

The `apiosk_` prefix and snake_case convention are consistent, and pairs like `apiosk_plan`/`apiosk_execute_plan` and `apiosk_cancel_job`/`apiosk_resolve_job` are predictable. The single outlier is the tool named exactly `apiosk`, which breaks the otherwise regular verb-oriented naming pattern.

Tool Count5/5

Eleven tools is well within the well-scoped range and each tool supports a distinct part of the paid-API workflow: connection checks, discovery, comparison, execution, planning, approval polling, job status, resolution, and cancellation. The count feels appropriate for the complexity of the domain without bloating the surface.

Completeness5/5

The tool set covers the full lifecycle from connectivity and discovery through single execution, multi-step planning, approval handling, monitoring, ambiguity resolution, and cancellation. There are no obvious dead ends: every state an agent could hit has a follow-up tool, such as `apiosk_approval_status` for approvals and `apiosk_connect` for payment failures.

Resources