Configure coding agent

Now that you’ve walked through TypeDB by hand, set up your AI coding agent so it can write and verify TypeQL on your behalf. This step is optional - skip it if you’d rather keep writing TypeQL by hand.

Two pieces make vibe querying with TypeDB reliable:

  1. typeql-check - a CLI that statically validates TypeQL syntax, so the agent can self-correct.

  2. typedb-skills/typeql.md - a skill file that teaches your coding agent the TypeQL language and TypeDB’s data model.

In our benchmarks, adding both raises Claude’s TypeQL pass rate from 23-43% (no tools) to 86-96% - the difference between AI-generated TypeQL being unreliable and being something you can build on.

Install typeql-check

See Install TypeQL Syntax Checker for install instructions across macOS, Linux, and Windows.

Add the TypeQL skill to your coding agent

The typedb-skills repository contains skill files that teach AI coding agents how to write TypeQL. The relevant file is typeql.md.

  1. Clone the repository:

    git clone https://github.com/typedb/typedb-skills.git

  2. Register typedb-skills/typeql.md with your coding agent:

    • Claude Code

    • Cursor

    • GitHub Copilot

    • Other agents

    Copy typeql.md into ~/.claude/skills/typeql.md (user-level) or .claude/skills/typeql.md inside your project (project-level). Claude Code will load it automatically the next time you start a session.

    Copy the contents of typeql.md into .cursor/rules/typeql.mdc at the root of your project.

    Copy the contents of typeql.md into .github/copilot-instructions.md at the root of your project.

    Most coding agents accept a Markdown rules or instructions file. Point your agent at typedb-skills/typeql.md using whatever mechanism it provides for custom instructions.

With the skill loaded, your coding agent will know TypeQL syntax, the TypeDB data model, and that it can call typeql-check to validate the queries it writes.

What next?

You’re ready to start vibe querying with TypeQL. Ask your agent to draft schemas and queries against your TypeDB databases, and have it run typeql-check to validate the output before sending it to TypeDB.