buda-mcp AGENTS.md

AGENTS.md — buda-mcp

MCP server exposing Buda.com public REST API v2 as tools and resources for AI assistants. No API key required (v2.0.0+).

Layout

src/index.ts          stdio MCP server entrypoint
src/http.ts           HTTP/SSE MCP server entrypoint (Express, stateless)
src/client.ts         BudaClient — fetch wrapper, 429 retry, error sanitization
src/cache.ts          In-memory TTL cache with in-flight deduplication
src/validation.ts     validateMarketId(), validateCurrency()
src/utils.ts          flattenAmount(), aggregateTradesToCandles(), etc.
src/format.ts         Shared markdown formatting helpers (liquidityBadge, fmtSlippage, fmtTimestamp)
src/version.ts        Version string (reads package.json)
src/types.ts          TypeScript types for Buda API responses
src/tools/            One file per tool — each exports register(), toolSchema, handler
test/unit.ts          Unit tests (no network)
test/run-all.ts       Integration tests (live API, skips if unreachable)
marketplace/          Listing artifacts (openapi.yaml, gemini-tools.json, claude-listing.md)
scripts/              sync-version.mjs

Commands

• Install: npm install
• Dev (stdio): npm run dev
• Dev (HTTP): npm run dev:http
• Build: npm run build
• Test (all): npm test
• Test (unit only): npm run test:unit
• Test (integration): npm run test:integration
• Sync version: npm run sync-version
• Publish: npm publish --access public --provenance

Invariants

NEVER violate without an ADR amendment.

• Public-only API. No authenticated/private tools exist since v2.0.0. NEVER accept or require API keys. The with-auth branch preserves legacy auth code.
• Tool output is markdown. Every tool MUST return pre-formatted markdown via content: [{ type: "text", text }]. Use src/format.ts helpers. NEVER return raw JSON.stringify.
• Agent passthrough. Downstream agents MUST relay tool output verbatim — no re-summary, re-table, or paraphrase unless the user asks.
• Input validation before URL interpolation. MUST call validateMarketId() or validateCurrency() before building API paths. Validation errors MUST use static strings — NEVER embed user input.
• Error sanitization. Internal details (paths, stack traces) go to stderr only. Callers see generic messages via formatApiError().
• Dual entrypoint registration. New tools MUST be registered in both src/index.ts (stdio) and src/http.ts (HTTP).
• Version in package.json only. Run npm run sync-version after bumping. NEVER hardcode version strings.