# Configure coding agent

Set up your AI coding agent so it can write and verify TypeQL on your behalf, instead of writing every query 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` - skill files that teach your coding agent the TypeQL language and TypeDB’s data model (`typeql.md`), and how to design good schemas (`modeling.md`).
    

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)Install typeql-check

See [Install TypeQL Syntax Checker](../install/typeql-check/index.md) for install instructions across macOS, Linux, and Windows.

## [](#add_skill)Add the TypeDB skills to your coding agent

The [`typedb-skills`](https://github.com/typedb/typedb-skills) repository contains skill files that teach AI coding agents how to work with TypeDB:

*   [`typeql.md`](https://github.com/typedb/typedb-skills/blob/master/typeql.md) - the TypeQL language and TypeDB’s data model.
    
*   [`modeling.md`](https://github.com/typedb/typedb-skills/blob/master/modeling.md) - schema-modeling guidance: naming, entities vs relations vs attributes, composition, type safety, cardinality, and constraints.
    
    1.  Clone the repository:
        
        ```shell
        git clone https://github.com/typedb/typedb-skills.git
        ```
        
    2.  Register the skill files with your coding agent:
        
        *   Claude Code
            
        *   Cursor
            
        *   GitHub Copilot
            
        *   Other agents
            
        
        Copy `typeql.md` and `modeling.md` into `~/.claude/skills/` (user-level) or `.claude/skills/` inside your project (project-level). Claude Code will load them automatically the next time you start a session.
        
        Copy the contents of `typeql.md` into `.cursor/rules/typeql.mdc` and `modeling.md` into `.cursor/rules/modeling.mdc` at the root of your project.
        
        Append the contents of `typeql.md` and `modeling.md` to `.github/copilot-instructions.md` at the root of your project.
        
        Most coding agents accept Markdown rules or instructions files. Point your agent at `typedb-skills/typeql.md` and `typedb-skills/modeling.md` using whatever mechanism it provides for custom instructions.
        
    

With the skills loaded, your coding agent will know TypeQL syntax, the TypeDB data model, schema-modeling best practices, and that it can call `typeql-check` to validate the queries it writes.

## [](#_what_next)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.

[TypeDB Drivers](../install/drivers/index.md) [Learn TypeDB](../../learn-typedb/index.md)

[Edit on GitHub](https://github.com/typedb/typedb-docs/edit/3.x-development/home/modules/ROOT/pages/configure-coding-agent.adoc) Edit this page on GitHub.