Skip to content

Use with AI agents

sqlanvil is a Dataform fork, and coding agents know Dataform — which means their instincts are mostly right and occasionally, specifically wrong (BigQuery config blocks, credential shapes, ; separators, a dataform CLI that isn’t there). Two official integrations close that gap.

The sqlanvil-engineering-fundamentals skill teaches an agent the exact deltas between Dataform/BigQuery habits and correct sqlanvil code — config blocks, credentials, DDL, statement separators, cross-warehouse connections, the MySQL inversions, and the CLI. It follows the open Agent Skills format supported by Claude Code, Codex CLI, Cursor, Gemini CLI, GitHub Copilot, and dozens of other tools.

Install it with the skills CLI, which detects your installed agents:

Terminal window
npx skills add SQLAnvil/agent-skills

Or install manually: copy skills/sqlanvil-engineering-fundamentals/ from SQLAnvil/agent-skills into your agent’s skills directory (for Claude Code, ~/.claude/skills/).

The skill is versioned with the engine — it pins the current release and marks version-gated features (e.g. ≥1.22), and is updated as part of every sqlanvil release.

Projects generated by sqlanvil init (all modes), sqlanvil migrate-dataform, and the Cloud wizard include a warehouse-tailored AGENTS.md — the repo-scoped guide in the cross-agent AGENTS.md standard — plus a one-line CLAUDE.md bridge for Claude Code. That covers agents working inside one of your project repos with zero installation; the skill below adds the fuller guide to the agent itself, across all repos. Pre-existing AGENTS.md/CLAUDE.md files are never overwritten.

The full documentation is also published in the llms.txt format for web-capable agents: /llms.txt (index), /llms-small.txt (abridged), and /llms-full.txt (complete docs in one file).

The skill covers writing projects; for operating them on SQLAnvil Cloud — inspecting runs, debugging failures, checking workflow status — connect your agent to the remote MCP server at https://app.sqlanvil.com/api/mcp. See the MCP server guide for token setup and the available tools.

You want an agent to…Use
Write or edit .sqlx models, configs, credentialsthe Agent Skill
Convert a Dataform projectthe Agent Skill + sqlanvil migrate-dataform
Investigate a failed Cloud run, check schedulesthe MCP server
Answer business questions about your data (BI copilots, text-to-SQL)warehouse-persisted metadata
All of the aboveboth — they’re complementary