Integration page template

Copy this structure when adding a new venue or integration family to the docs.

Use this template for new files under Integrations. Maintainer checklist: docs-dev certify guide.

Overview

One paragraph: what the venue provides (spot, perps, funding, vaults, …) and how Thirdfy exposes it (provider key, catalog actions).

Credential model

Document only secrets the integrator or user must supply (wallet, Thirdfy agent API key, CEX credentialRef, venue onboarding).

Do not list Thirdfy-hosted upstream keys (NANSEN_API_KEY, ALLORA_API_KEY, GMGN_API_KEY, and similar). Those stay in operator docs-dev. CLI and MCP callers use Thirdfy auth only.

Do not list prices: no USD amounts and no credit costs (per call, per tier or per credit), in tables, prose or examples. Users see the charge in Console, and the live catalog carries billingTier and credits. Link Credits and balance instead.

Discovery

  • MCP: getProviderActions { provider: "..." }
  • CLI: example thirdfy-agent actions flags
  • REST: links to Actions catalog or live GET .../actions/catalog

Use it

Every integration page shows one real call on all three surfaces, so a reader can copy it into their agent.

  1. A prompt the reader can give their agent ("Using Thirdfy, ...").
  2. A ::code-group with [MCP], [CLI] and [REST] tabs for the same action:
    • MCP: agentRun { action: "...", params: {...} }
    • CLI: thirdfy-agent run --action ... --provider ... --params '...' --json
    • REST: POST https://mcp.thirdfy.com/tool/agentRun with Authorization: Bearer $AGENT_API_KEY
  3. A trimmed real result, from a read you ran against production, with the date. Keep typed, parseIssues, freshness and attribution when the action returns them. Replace personal handles, wallet addresses and token names with placeholders.
  4. What to check before the agent uses a value.

For a write action, show getVenueReadiness and the setup steps first, mark the example "places a real order", and do not run it to fill the page. Check it with preflight only.

Readiness checklist

Bullet list: funding, approvals, onboarding, chain IDs, testnet vs mainnet.

Execution

  • Preferred runMode values
  • Example executeIntent or walletExecute shape (pseudo-params only)

Related docs