Apiosk Connect

io.github.obcraftPublished by GitHub account obcraftv1.7.0Updated Oct 24, 2026

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

VerifiedStreamable HTTPWeb executableFinanceData & AnalyticsBusiness & Commerce

Overview

AI-generated overview

Apiosk Connect lets an assistant ask a question, compare paid API sources, approve a quoted total, and run the purchase to get cited results.

What you can do
  • Ask a question and inspect matching sources with their inputs and prices
  • Prepare selected sources into one reviewed maximum total and explicitly approve that quote
  • Check progress, requote, supply missing inputs, retry discovery and adjust task options
  • Read saved answers, evidence, result pages, downloads and conversations, and follow up on purchased evidence
  • Review connected app actions and hand off recurring checks to the host scheduler
When to use it
Useful when you want an assistant to answer questions by buying access to specific third-party API endpoints rather than relying on general knowledge, with an explicit approval step before any spend. Also suited to reviewing saved evidence and following up on data already purchased.
Requirements
A remote endpoint at mcp.apiosk.com with OAuth, or a local npm or PyPI package run with Node.js 22.16 or newer. An authorized Apiosk connection is required; the stdio path uses APIOSK_CONNECT_TOKEN, and APIOSK_PRIVATE_KEY is optional for automatic x402 payments. A workspace ID and network access to the Apiosk Gateway are also needed.
Before you install
Approving a quote authorizes real spending up to the quoted maximum across providers, so check currency, total, sources, gaps and expiry first. APIOSK_PRIVATE_KEY is a wallet private key that can move funds; keep it and APIOSK_CONNECT_TOKEN in private configuration, never in committed files. The local journal stores conversations and approval records on disk, and hosted operation needs a persistent volume.

Installation

In SourceWeft

  1. Open Apiosk Connect in the dashboard and add it to a workspace.
  2. Connect the required credentials. They are stored privately and never shown on public pages.
  3. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/io.github.obcraft%2Fapiosk-mcp/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config. The client completes OAuth sign-in on first connect.

{
  "mcpServers": {
    "apiosk-connect": {
      "type": "http",
      "url": "https://mcp.apiosk.com/mcp"
    }
  }
}

README

Apiosk MCP

@apiosk/mcp 3.0.0 brings the Apiosk Ask workflow to Claude, Codex and other MCP hosts: ask a question, compare matching sources, review inputs and one total, approve that request, and inspect saved results. It uses the existing Gateway for discovery, planning, prices, execution and evidence.

MCP1 card URLs, connection identity, token formats and cached Ask tool signatures remain compatible. Compatibility operations stay private to cards; new model connections continue to see Ask first. Both old and new approval calls share the same durable approval record.

The default is question-scoped source discovery. There is no global “browse the catalog” flow. For example, “What does ASML do?” should first call apiosk_ask with that question and display its matching sources; a model's general knowledge is not an Apiosk result.

This repository is the canonical obcraft/apiosk-mcp implementation. Versioned source and manifests do not establish that this version has been deployed, published or installed in a host.

Ask interactions and embedded components

The server exposes 36 public tools and six private component operations, saved-request resources and an Ask prompt. The actual App Ask React components and design tokens are vendored in src/ask-page/ and compiled into the self-contained embedded resource. The local tester loads that same resource. src/ask-ui/ retains the original MCP transport and compatibility renderers; every operation still uses the durable saved-request and approval journal.

Source discovery uses the App’s filtering, deduplication and provider ordering. Offered endpoint descriptors enrich matching sources without adding unrelated catalog entries. Account display currency comes from Gateway’s read-only /v2/display-context; quoted atomic amounts remain unchanged. Rebuild the embedded bundle with npm run build:ask-page after editing its sources.

Manual source selection prepares each chosen native endpoint with the App’s exact input values. Connected clients use /v2/ask/source/prepare, which requires explicit approval even when the connection has a standing spending rule. The MCP combines those saved quotes into one reviewed maximum; preparation does not purchase data.

MCP Apps and ChatGPT-compatible metadata identify the embedded resources. Model-visible results carry compact source identifiers, status, input needs and the exact approval. Full component data travels separately in _meta.apiosk_card_data, so large source schemas and raw response trees do not flood the model context. Saved evidence remains available through the result and evidence tools.

Hosts that support embedded components can show the interactive cards. Text-only hosts receive structured results and use the public tools. Support and rendering still depend on the host; passing local tests does not establish installed Claude, Codex or ChatGPT acceptance. Read-only HTML exports are separate from interactive cards.

InteractionTools
Ask and inspect matching sourcesapiosk_ask, apiosk_sources
Edit source inputs and prepare one totalapiosk_prepare
Review and explicitly approve the exact quoteapiosk_approve
Read progress, refresh prices, supply choices or missing inputapiosk_status, apiosk_requote, apiosk_continue
Retry interrupted discovery and adjust task optionsapiosk_retry_search, apiosk_task_options, apiosk_source_selection, apiosk_analysis_quote
Saved answers, evidence, pages, downloads and conversationsapiosk_result, apiosk_evidence, apiosk_result_page, apiosk_artifact, apiosk_chats
Follow up using purchased evidenceapiosk_follow_up
Connected app actions and recurring checksIntegration/action review tools, native recurring tools and apiosk_schedule_handoff

apiosk_ask defaults to mode: "sources". Automatic planning is available with mode: "automatic". Preparation never approves a purchase. Review the returned currency, maximum total, sources, gaps, expiry and approval ID before authorizing execution. The visible choices use the same purchasability filter as the Ask page; discovery metadata and source options are not purchased findings.

Results retain source dates, citations, coverage and gaps, including meaningful 0 and false values. Local filters, sorting, chart/table views, saved pages and exports reuse saved data. Follow-ups use purchased evidence where possible; a need for new data creates a separately reviewed request.

Run from this checkout

Requires Node.js 22.16 or newer and an authorized Apiosk connection. In this workspace the canonical directory is /Users/olivier/Documents/Apiosk/Production/Main/mcp.

sh
cd /Users/olivier/Documents/Apiosk/Production/Main/mcpnpm cinpm run checknpm test

Use the existing Apiosk credentials in your private environment or local .env; do not put credentials in committed examples. Runtime entry points read environment variables. To load .env explicitly, use Node's --env-file option.

Entry pointPurpose
node index.mjs / npm run start:stdioLocal stdio MCP; uses the configured connection token. The apiosk, apiosk-mcp and apiosk-mcp-server package commands use this entry.
node server.mjs / npm startCanonical hosted HTTP server, default port 3000, with OAuth metadata, registration, authorization and token routes. Also retains authenticated legacy SSE endpoints.
node bin/mcp-2.mjs --http --host 127.0.0.1 --port 3012Minimal bearer-token HTTP transport for local testing. This compatibility filename remains internal; this entry does not provide the hosted OAuth flow.

For stdio with a private .env:

sh
node --env-file=.env index.mjs

The hosted server preserves the existing OAuth identity and secret configuration. Starting it requires those settings, including its signing secret; use node --env-file=.env server.mjs when they are in a local file. HTTP clients authenticate each request themselves. A server-wide token is never lent to HTTP callers. /health reports process health, not Gateway or source readiness.

Local tester

The tester runs at http://127.0.0.1:3013 and defaults to an MCP endpoint at http://127.0.0.1:3012/mcp. Start the minimal local MCP transport in one terminal:

sh
node --env-file=.env bin/mcp-2.mjs --http --host 127.0.0.1 --port 3012

Start the tester in another:

sh
npm run dev:chat

To test the canonical hosted server on port 3000 instead:

sh
MCP_DEV_URL=http://127.0.0.1:3000/mcp npm run dev:chat

The tester reads this checkout's .env, .env.v2.local and .env.dev.local, with inherited environment values taking precedence. It reuses an existing MCP_DEV_TOKEN and OPENROUTER_API_KEY. If no local OpenRouter key is set, it reads only the provider key from the sibling gateway/.env (OPENROUTER_API_KEY, then INTENT_API_KEY). It does not inherit Gateway execution flags or change those credentials. MCP_DEV_PORT, MCP_DEV_URL and MCP_DEV_MODEL override the tester defaults. Set MCP_DEV_GATEWAY_URL for a custom Gateway event origin; the embedded card and tester use the same fixed origin policy for live status updates.

Connect the intended account before asking a question. The tester calls apiosk_ask for the first question and renders the same embedded components served to other hosts. An initial discovery stops at the authoritative Ask card without an extra model-written answer. Later model continuations receive a bounded projection of tool results; full card data stays available to the component. Model API usage and approved source purchases are separate operations.

Connect Claude or Codex

Use examples/codex.toml, examples/claude-code.mcp.json or examples/claude-desktop.json, preserving other configured servers. Adjust absolute paths for your installation and keep tokens in private configuration or environment variables. These files are examples, not an installed connection.

The hosted connector address remains https://mcp.apiosk.com/mcp; local source changes do not update that deployment. The Apiosk plugin supplies Ask-first instructions and the hosted connection definition. server.json, manifest.json and dxt.json describe the canonical package; a desktop manifest is not a built or installed bundle.

Configuration and backend boundaries

VariableMeaning
APIOSK_GATEWAY_V2_URLData/execution Gateway; defaults to https://gateway.apiosk.com. Use loopback HTTP only for a local Gateway.
APIOSK_GATEWAY_URLExisting OAuth agent gateway setting; it does not select the data/execution Gateway.
APIOSK_CONNECT_TOKENApiosk agent connection credential for stdio.
APIOSK_TOKENOverrides the connection token. A valid personal App session JWT enables account-only routes; this server does not refresh that App session.
APIOSK_WORKSPACE_IDStdio workspace. HTTP callers use x-apiosk-workspace-id.
APIOSK_MCP_STATE_DIRPersistent private journal directory; defaults to .local/state in the package.
APIOSK_MCP_PORT / PORTHTTP port; defaults to 3000.
APIOSK_MCP_HOST / APIOSK_MCP_BIND_HOSTListener address. The hosted entry defaults to 0.0.0.0; use loopback for local-only access.
APIOSK_MCP_ALLOWED_HOSTS, APIOSK_MCP_ALLOWED_ORIGINSExplicit host/origin controls for the HTTP listener.

Gateway scope, budget, workspace and feature restrictions remain authoritative. Organization API keys are not substitutes for agent connection tokens in the raw task/approval protocol. Account-only integrations and native recurring operations may require a valid App session and backend enablement; an app_only or public_api_required response is not bypassed.

Connection tokens use /v2/ask/page, which applies the Ask page's interpreter, validation and source searches. App sessions use the original App routes. Both use the same source filtering, grouping, input values and display currency. Connected discovery preserves the App's matches without the older public API's interpretation repairs or extra source expansion; signed searches remain bound to the account, connection and workspace. Source refresh reuses the saved parse, and automatic planning adopts that displayed search without parsing the question again.

Recurring execution needs its own explicit review of the workflow, schedule, destination and cost limits. apiosk_schedule_handoff supplies instructions for the host scheduler and reports schedule_created: false; it does not create a scheduled job. External app actions likewise require their own reviewed execution.

Saved state, recovery and deployment

The journal stores private conversations, evidence and approval intent with private file permissions, without storing credentials. Conversations are separate from the web app's chat-history table; authorized Gateway tasks can be imported by ID. State scopes include the Gateway and workspace. Raw bearer callers are token-scoped; hosted OAuth sessions retain their verified grant scope across token refresh.

Atomic writes and per-request locks record approval intent before dispatch. An uncertain purchase is not blindly replayed: read saved status and use the returned recovery path. The quoted total is a spending ceiling across providers, not an all-or-nothing transaction. Local disk failures stop money-moving actions.

Hosted operation requires a persistent journal. The Fly configuration preserves the existing app identity and expects an existing mcp_state volume mounted at /data; run one machine until shared state and distributed locking are implemented. Provision and review that volume before deploying. See deployment and release instructions.

Pushing the repository runs checks only. Deployment and publication are separate manual workflows. Tests use controlled fixtures and do not purchase source data; local success is not proof of production retrieval, message delivery, a running schedule or an installed host connection.

Source: README.md at commit 66b402c

Tools

0
This server asks you to sign in, so SourceWeft could not read its tools without an account and has not indexed them. What a connected account sees can depend on that account and its permissions.

Version history

1
  1. v1.7.0LatestSep 16, 2026

Score

85% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts