foxd-contract
v0.3.1
Published
The typed tool contract behind the FoxD trading API — one declaration generating the REST API, MCP server, TypeScript SDK and CLI for multi-chain memecoin trading.
Maintainers
Keywords
Readme
foxd-contract — the tool schema behind the FoxD trading API
One typed declaration of every capability in FoxD — the multi-chain memecoin trading platform covering Solana, Ethereum, BNB Chain, Base, Arbitrum and HyperEVM — shared by the REST API, the MCP server, the SDK and the CLI.
Most people want foxd-sdk (typed
client), foxd-cli (terminal) or
foxd-mcp (Claude/Cursor/Codex).
Install this directly only if you are generating your own client or need the
zod schemas and JSON Schema for the 87 tools.
npm i foxd-contractYou rarely need this package directly — install foxd-sdk to make calls. Reach
for it when you are building your own surface over FoxD: a router, a UI over the
tool list, your own agent framework binding, or type-checking a payload before
you send it.
import { TOOLS, getTool, matchRest, moduleSummary } from "foxd-contract";
getTool("market.trending")?.scopes; // ["read"]
matchRest("GET", "/tokens/base/0x532f…"); // { tool, params }
TOOLS.filter((t) => t.mutates); // everything that changes stateEach tool declares its name, description, module, required scopes, weighted cost, zod input and output schemas, REST binding and worked examples. The REST routes, the OpenAPI 3.1 document, the MCP tool list, the SDK methods and their types, and the CLI subcommands are all derived from it, so nothing about a tool is written twice and no surface can drift from another.
Schemas are zod v4, so z.toJSONSchema() gives you
draft-2020-12 directly — which is what OpenAPI 3.1 and MCP inputSchema both
want, with no converter in between.
import { z } from "zod";
import { getTool } from "foxd-contract";
const tool = getTool("trade.quote")!;
const parsed = tool.input.safeParse(userSupplied); // validate before sending
const schema = z.toJSONSchema(tool.input, { io: "input" });Also exported: the scope list and what each grants, the tier and quota tables,
the cost-unit constants, and coerceArgs — the schema-directed query-string
coercion the gateway uses, so a hosted copy behaves identically.
Links
- Documentation: https://foxd.xyz/docs
- REST API: https://foxd.xyz/api/v1 · OpenAPI 3.1
- MCP: https://foxd.xyz/api/mcp ·
foxd-mcp
MIT
