Skip to main content
Glama

Apiosk Connect

by io.github.obcraft

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

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

Annotations already flag destructiveHint=true, but the description adds the critical behavioral context: the call settles from the connected balance, is refused if the real price exceeds max_price_usdc, the token pins endpoint+price with a one-hour lifetime, and an approval_required status with approval_id may be returned. It also discloses the re-entry pattern after approval, which goes well beyond what annotations provide.

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?

The description is longer than minimal but every sentence carries a constraint or workflow requirement relevant to a money-moving operation. The token/price sentence is slightly convoluted and partially redundant with the schema descriptions, which keeps it from a perfect conciseness score.

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 9-parameter, financially destructive tool with an output schema, the description covers the full lifecycle: user consent precondition, exact parameter provenance, price ceiling behavior, token expiry handling, and approval re-entry. The output schema handles return-value details, so nothing an agent needs to call this correctly 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 description coverage is 100% and the parameter descriptions already explain offer_token opacity, the one-hour validity, and max_price_usdc refusal semantics. The tool description restates these workflow rules in prose but does not add meaningful new parameter-level information beyond the input schema, so it stays at the baseline.

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+resource ('Run the offer the user chose and return the result') and immediately clarifies this is the paid settlement step, distinct from discovery and approval siblings. It explicitly references apiosk_discover and apiosk_approval_status, so the agent can tell it apart from the other tools without opening their schemas.

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?

The description gives explicit when-to-use and when-not-to-use rules: only after stating the exact price and getting the user's choice, never to explore, and never to pick for the user. It also explains the alternative paths for an expired token (rerun apiosk_discover) and for human approval (poll apiosk_approval_status, then call again), which is explicit router guidance rather than implied context.

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

All Apiosk Connect toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.6/5.0
Disambiguation5/5

Each tool maps to a clear stage in the workflow: discovery, comparison, offer selection, execution, approval polling, plan creation, plan execution, job status, resolution, and cancellation. Even the discovery-stage tools (discover, compare, apiosk) are explicitly chained so an agent can tell them apart by purpose and output.

Naming Consistency4/5

Most tools follow a consistent apiosk_ prefix with snake_case and verb-led names like apiosk_discover, apiosk_execute, and apiosk_cancel_job. The bare apiosk tool and noun-style status tools (job_status, approval_status) are minor deviations from an otherwise predictable pattern.

Tool Count5/5

Eleven tools is well within the ideal range and each tool earns its place by covering a distinct user or agent action in the buying, planning, executing, and job-management lifecycle. There is no redundancy or padding.

Completeness5/5

The surface covers the full lifecycle: connect, discover, compare, quote, approve, execute single calls, create plans, execute plans, monitor jobs, resolve ambiguities, and cancel running jobs. There are no obvious dead ends or missing required operations for the stated purpose.

Resources