Skip to main content
Glama

Server Details

Discover, pay for, execute, and publish APIs through Apiosk.

Status
Healthy
Last Tested
Transport
Streamable HTTP
URL
Repository
obcraft/apiosk-mcp
GitHub Stars
0
Server Listing
Apiosk MCP Server

Glama MCP Gateway

Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.

MCP client
Glama
MCP server

Full call logging

Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.

Tool access control

Enable or disable individual tools per connector, so you decide what your agents can and cannot do.

Managed credentials

Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.

Usage analytics

See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.

100% free. Your data is private.
Tool DescriptionsA

Average 4.2/5 across 11 of 11 tools scored. Lowest: 3.2/5.

Server CoherenceA
Disambiguation5/5

Each tool has a distinct purpose: discover vs search, execute vs fetch_paid, inspect_x402 as read-only, etc. No overlaps, agents can easily select the right tool.

Naming Consistency5/5

All tools use the consistent 'apiosk_' prefix with a verb_noun pattern in snake_case, e.g., apiosk_discover, apiosk_execute. Even publish_x402_route follows the pattern.

Tool Count5/5

11 tools cover discovery, execution, payment, wallet management, guidance, and publishing. The number is appropriate for an API marketplace with payment features, not excessive or sparse.

Completeness4/5

The tool set covers the full user workflow: discover, get details, execute, pay, manage wallets, publish. Missing are tools to manage published routes (update/delete) or create wallets, but these are minor gaps.

Available Tools

11 tools
apiosk_discoverA
Read-onlyIdempotent
Inspect

Find the best paid x402 API for a data capability across discovery sources (Apiosk catalog + federated external listings). Decompose the user's request into capability segments first, then call this once per capability. Returns a normalized, ranked list; each result's executable_via says whether to call apiosk_execute (Apiosk-settled) or apiosk_inspect_x402 + apiosk_fetch_paid (external). Use this instead of apiosk_search when the goal is 'get real paid data for X', not just browsing.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYesThe data capability to find, e.g. 'realtime USD exchange rate' or 'company registry lookup by domain'.
sourcesNoDiscovery sources to query. Default ['apiosk','bazaar']. Use ['all'] for every directly wired free REST source. Paid sources 'x402scan' and 'apify' are opt-in and return their payable endpoint for apiosk_inspect_x402 + apiosk_fetch_paid; discovery never spends automatically. Add 'wellknown' with probe_hosts for a specific host.
segmentsNoOptional: the user's request pre-decomposed into distinct data capabilities. Each is searched and merged.
max_resultsNoMaximum results to return (default 8, max 25).
probe_hostsNoFor the 'wellknown' source: explicit hostnames to probe for a /.well-known/x402 document (e.g. 'x402.example.com'). No speculative crawling — only hosts you name here are probed.
max_price_usdcNoOptional per-call price ceiling in USDC. Results above this are dropped.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint. Description adds context that discovery never spends automatically and paid sources require additional steps (apiosk_inspect_x402 + apiosk_fetch_paid). No contradiction.

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 concise, front-loaded with the main purpose, and structured in a few sentences without unnecessary information.

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?

Given the tool's complexity (6 params, output schema, annotations, sibling tools), the description covers the purpose, usage pattern, and parameter context sufficiently. It does not explain every parameter in depth, but the schema fills that gap.

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 parameters are already documented in the input schema. The description adds minor context (sources default behavior, probe_hosts purpose) but does not significantly extend meaning beyond the schema.

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 clearly states the tool discovers paid x402 APIs for a data capability, decomposes requests into segments, and returns a ranked list with execution guidance. It explicitly distinguishes from sibling tool apiosk_search for browsing vs. buying.

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?

Provides explicit instructions to decompose the user's request into capability segments and call once per capability. Contrasts with apiosk_search, states when to use (getting paid data) vs. not (browsing). Also explains return value structure with executable_via field.

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

apiosk_executeB
Destructive
Inspect

Execute any Apiosk API by slug through the uniform /execute contract.

ParametersJSON Schema
NameRequiredDescriptionDefault
slugYesApiosk API slug.
inputNoRaw JSON body for the default operation, or the envelope input field when operation is provided.
queryNoOptional query override when using the execute envelope.
operationNoOptional explicit operation id or path.
path_paramsNoOptional path parameter override when using the execute envelope.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior2/5

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

Annotations already indicate destructiveHint=true and readOnlyHint=false, so the description adds no extra behavioral context (e.g., side effects, auth, rate limits). It fails to leverage the opportunity to elaborate on the 'execute contract' semantics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence is concise but overly terse; it is front-loaded but lacks explanatory power, making it adequate but not exemplary.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema, the description is too sparse given the tool's complexity (5 params, destructive, open-world). It does not explain the '/execute contract', envelope behavior, or how operations work, leaving the agent with insufficient context.

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 the description adds no additional meaning beyond the schema's parameter descriptions. Baseline score of 3 is appropriate.

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?

Clearly states the verb 'execute' and the resource 'any Apiosk API by slug', distinguishing it from sibling discovery/exploration tools.

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?

Implies usage for executing Apiosk APIs but provides no explicit guidance on when to use versus alternatives, nor any when-not-to-use conditions.

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

apiosk_exploreA
Read-only
Inspect

Browse Apiosk listing groups and explore one group at a time before narrowing with search.

ParametersJSON Schema
NameRequiredDescriptionDefault
sortNo
limitNo
orderNo
offsetNo
searchNoOptional free-text search when listing_type is set.
listing_typeNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior3/5

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

The description adds context beyond the readOnlyHint/destructiveHint annotations by describing the browsing flow (one group at a time, narrowing with search), but does not disclose other behaviors like pagination or result grouping.

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 a single, clear sentence with no wasted words. It could be more structured but remains efficient for its length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 6 parameters and an output schema, the description provides a high-level overview of the browsing workflow but lacks details on parameter roles and usage scenarios, leaving some ambiguity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With only 17% schema description coverage, the description does little to explain individual parameters. It hints at 'listing_type' and 'search' but provides no specifics, insufficiently compensating for the low schema coverage.

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 clearly states the verb 'browse' and 'explore' with the resource 'Apiosk listing groups', and distinguishes from siblings by mentioning 'one group at a time' and 'narrowing with search'.

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 description implies usage by mentioning 'before narrowing with search', but does not explicitly state when to use this tool versus alternatives like 'apiosk_search' or 'apiosk_discover', nor provides exclusions.

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

apiosk_fetch_paidA
Destructive
Inspect

Pay an EXTERNAL x402 endpoint (one Apiosk does not host) from the connected wallet and return its data. Use this only for external results from apiosk_discover (executable_via='apiosk_fetch_paid'); for Apiosk catalog listings use apiosk_execute. REQUIRED: call apiosk_inspect_x402 on the url first, tell the user the exact price, and pass that amount as confirmed_price_usdc — the gateway refuses if the live price is higher. The gateway enforces the wallet's per-tx/daily spend limits. Base + USDC only.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesThe external x402 resource URL to pay and fetch (from a discovery result's `url`).
bodyNoOptional JSON request body for POST/PUT/PATCH.
queryNoOptional query parameters to send to the provider.
methodNoHTTP method for the provider request. Defaults to GET.
headersNoOptional extra request headers (allowlisted server-side; secrets are never accepted here).
max_price_usdcNoOptional additional per-call ceiling. The gateway also enforces the wallet's per-tx and daily limits.
idempotency_keyNoOptional. Reuse the same key to safely retry without paying twice; a fresh one is generated if omitted.
confirmed_price_usdcYesThe price you read via apiosk_inspect_x402 and confirmed with the user. The gateway refuses if the live price exceeds this.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior5/5

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

Beyond annotations (destructive, non-idempotent, open-world), it adds critical context: payment enforces wallet spend limits, gateway rejects if live price exceeds confirmed amount, and only Base + USDC. No contradictions with 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?

Every sentence earns its place. The description is front-loaded with the core action, then provides usage context, a required prerequisite, and key behavioral notes—all within a few concise lines.

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 tool's complexity (8 parameters, payment, external endpoint), the description covers prerequisites, restrictions, and wallet limits. An output schema exists, so return values are already documented. No gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage, the description adds significant value: explains how to obtain confirmed_price_usdc (from apiosk_inspect_x402), that url comes from a discovery result, and that idempotency_key allows safe retries. All parameters are contextualized.

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 clearly identifies the tool's action: paying an external x402 endpoint and returning its data. It distinguishes from sibling tool apiosk_execute by specifying this is for external results, not catalog listings.

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?

Explicitly states when to use ('only for external results from apiosk_discover') and when not to use ('for Apiosk catalog listings use apiosk_execute'). Also provides a mandatory prerequisite: call apiosk_inspect_x402 and pass the confirmed price.

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

apiosk_get_apiA
Read-only
Inspect

Fetch full listing detail and agent metadata for a specific Apiosk API slug.

ParametersJSON Schema
NameRequiredDescriptionDefault
slugYesApiosk API slug, for example 'agent-json-diff'.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior3/5

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

Annotations already mark the tool as readOnlyHint=true and destructiveHint=false. The description adds context about returning 'full listing detail and agent metadata', but does not disclose any additional behavioral traits beyond what annotations imply. With annotations present, this is adequate but not enhanced.

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 a single sentence of 12 words, directly stating the action and resource. It is front-loaded with the key purpose and contains no extraneous information.

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?

The tool is simple with one parameter, fully described in the schema, and has an output schema to document return values. The description covers the core purpose sufficiently, leaving no obvious gaps for a read operation.

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% for the single required parameter 'slug', which includes a clear description. The description adds an example value but no further semantic meaning. Hence baseline score of 3 is appropriate.

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 uses a specific verb 'fetch' and identifies the resource as 'full listing detail and agent metadata for a specific Apiosk API slug', clearly distinguishing from sibling tools like apiosk_discover (likely listing all) by focusing on a single slug.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like apiosk_discover or apiosk_search. It fails to specify context or conditions for selection, leaving the agent to infer without explicit cues.

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

apiosk_helpA
Read-only
Inspect

Explain what Apiosk MCP is, how to connect it, how auth and USDC/x402 payments work, and the recommended workflow for discovery, wallets, and publishing.

ParametersJSON Schema
NameRequiredDescriptionDefault
topicNoOptional help topic. Defaults to overview. Use 'discovery' to learn which live sources apiosk_discover searches (Apiosk catalog + Coinbase Bazaar + well-known); use 'rails' for how USDC/x402 settlement works.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior4/5

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

Annotations declare readOnlyHint=true and destructiveHint=false, which the description aligns with by stating it only explains. The description adds value by enumerating the specific topics covered (setup, auth, payments, etc.), providing context beyond 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, information-dense sentence that efficiently conveys the tool's scope. While it could be more structured (e.g., bullet points), it is not verbose and front-loads the main purpose.

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?

Given the tool's straightforward help purpose and the availability of an output schema (not shown but noted as present), the description sufficiently covers the key aspects. It could mention that the tool provides static reference information, but overall it is complete for a help tool.

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 input schema provides a comprehensive enum with descriptions for the 'topic' parameter. The tool description does not add further parameter semantics beyond what the schema already offers, so a baseline score of 3 is appropriate.

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 explicitly states the tool's purpose: 'Explain what Apiosk MCP is, how to connect it, how auth and USDC/x402 payments work, and the recommended workflow...' It uses a specific verb ('explain') and resource ('Apiosk MCP') and clearly distinguishes this instructional tool from sibling action tools like apiosk_discover or apiosk_execute.

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 description implies usage when a user needs explanatory information about Apiosk MCP, but it does not explicitly state when to use this tool versus alternatives. The topic enum in the input schema provides structure, but the description lacks guidance on exclusions or when not to use it.

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

apiosk_inspect_x402A
Read-onlyIdempotent
Inspect

Read an arbitrary URL's x402 payment terms (price, asset, network, payTo) WITHOUT paying. Use this on an external result's url from apiosk_discover before paying: it makes one unauthenticated request, parses the 402 offer, and returns the exact amount so you can confirm the price with the user. Read-only; never spends. apiosk_execute (for Apiosk catalog listings) does not need this.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesThe https:// URL of the x402 resource to inspect (e.g. a federated listing's resource URL).
methodNoHTTP method the resource charges on. Defaults to GET.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior5/5

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

Annotations already indicate read-only, idempotent, non-destructive. Description adds: 'makes one unauthenticated request, parses the 402 offer, and returns the exact amount', and 'Read-only; never spends.' No contradiction.

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?

Two sentences, no wasted words. Front-loaded with purpose and usage. Every sentence is meaningful.

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?

With output schema present and comprehensive annotations, the description covers purpose, usage, behavior, and parameter details. No gaps given the complexity.

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 covers both params with descriptions. Description adds extra value: specifies URL must be https and gives an example, clarifies method default and its role. This goes beyond schema.

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 clearly states it 'Read an arbitrary URL's x402 payment terms' and distinguishes itself from siblings like apiosk_execute which does not need this step. The verb 'inspect' matches the tool name.

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?

Explicitly tells when to use: 'Use this on an external result's `url` from apiosk_discover before paying', and when not: 'apiosk_execute (for Apiosk catalog listings) does not need this.' Provides clear context.

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

apiosk_list_walletsA
Read-onlyIdempotent
Inspect

List the signed-in user's managed Apiosk wallets. Requires an Apiosk dashboard session from local env auth or hosted MCP authorization.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior5/5

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

Beyond the annotations (readOnlyHint, idempotentHint, destructiveHint), the description adds that it returns only the signed-in user's own wallets and clarifies authentication needed. No contradictions with 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?

Two sentences, no unnecessary words. The first sentence states the core purpose, and the second provides a key prerequisite. Highly efficient.

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?

Considering zero parameters, strong annotations, and an output schema, the description is complete. It covers user scope and auth requirements, leaving no ambiguity for a simple list operation.

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?

The tool has no parameters, and the schema coverage is 100%. The description does not add parameter information because none is needed. Baseline for zero parameters is 4.

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 uses a specific verb 'List' and clearly identifies the resource as 'the signed-in user's managed Apiosk wallets'. This distinguishes it from sibling tools like apiosk_search or apiosk_fetch_paid.

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 explicitly states the authentication requirement ('Requires an Apiosk dashboard session'), providing clear context for when this tool is usable. It does not explicitly mention alternatives or when not to use it, but the context is adequate.

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

apiosk_payment_guideA
Read-only
Inspect

Explain how to pay through the Apiosk gateway. Returns a buyer guide (how an agent settles a paid API call over USDC/x402, tailored to the current auth) and a provider guide (how to publish an API and get paid). Pass slug to scope buyer guidance to one listing, or role to pick a side.

ParametersJSON Schema
NameRequiredDescriptionDefault
roleNoWhich side to explain. Defaults to both.
slugNoOptional API slug to scope buyer guidance (price, payment steps) to one listing.

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. Description adds that the tool returns guides tailored to current auth, and covers buyer and provider sides. No contradictions; good additional context.

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, front-loaded with main purpose. Every sentence adds value; no filler.

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 2 optional params, output schema present, the description adequately covers purpose and parameter usage. The agent can correctly select and invoke this tool for payment guidance.

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 covers 100% of parameters. Description adds meaning by explaining how slug scopes buyer guidance and role picks a side, beyond enum values. Helpful for invocation.

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 clearly states it explains how to pay through Apiosk, specifying buyer and provider guides. It distinguishes from sibling tools like apiosk_execute (execution) and apiosk_discover (discovery) by focusing on payment guidance.

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 explains when to pass slug (scope to one listing) and role (pick a side), but does not explicitly state when not to use this tool vs siblings like apiosk_execute or apiosk_get_api. Implicitly clear for context.

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

publish_x402_routePublish a paid x402 routeA
Idempotent
Inspect

Publish an API endpoint as a paid x402 route on the Apiosk gateway. The route gets a paid URL that returns 402 Payment Required until the caller pays in USDC, then forwards to your upstream API. New routes enter Apiosk's review queue (status pending_review) and go live on approval. Requires an Apiosk provider token (Authorization: Bearer sk_live_…).

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable API name, e.g. 'Weather API'.
pathNoPublic path under the route's gateway slug, e.g. /weather. Defaults to the last segment of upstream_url.
slugNoOptional gateway slug override (lowercase letters, numbers, hyphens). Defaults to a slug derived from name.
tagsNo
priceYesPrice per call in USDC, e.g. "0.01".
methodNoDefaults to GET.
networkNoSettlement network. Defaults to base.
currencyNoOnly USDC is supported.
descriptionNo
input_schemaNo
upstream_urlYesFull HTTPS URL of your existing endpoint the gateway forwards paid requests to.
output_schemaNo
settlement_addressYesWallet that receives 98% of each payment (Apiosk keeps a 2% platform fee).

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

Behavior4/5

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

Annotations indicate idempotentHint=true and non-destructive. The description adds behavioral traits: payment flow (402 response), forwarding to upstream, and review queue. No contradiction with annotations.

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 concise with 4 sentences, front-loading the purpose. It efficiently covers key points without unnecessary detail.

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?

Given the tool's complexity (13 parameters, many optional) and the presence of output schema in the parameters, the description covers the essential flow. It omits edge cases like slug conflicts but is sufficient for typical use.

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 69%, meaning most parameters are described in the schema. The description does not add extra semantics beyond a brief overview, so it meets the baseline for high coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool publishes an API endpoint as a paid x402 route, specifying the verb 'publish' and resource 'route'. It distinguishes the action from sibling tools like inspect_x402 but does not explicitly differentiate.

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 description provides usage context, such as requiring a provider token and mentioning the review queue. However, it does not specify when not to use this tool or suggest alternative tools.

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

Discussions

No comments yet. Be the first to start the discussion!

Related MCP Servers

View all MCP Servers

Try in Browser

Your Connectors

Sign in to create a connector for this server.