# Agent rules

Agent rules for working with SurrealDB.

We've prepared a set of agent rules to help your agents generate better code.

- [SurrealQL](https://github.com/surrealdb/docs.surrealdb.com/blob/main/public/integrations/agent-rules/surrealql.mdc)
- [Vector indexes and queries](https://github.com/surrealdb/docs.surrealdb.com/blob/main/public/integrations/agent-rules/surrealdb-vector.mdc)
- [SurrealDB Python SDK](https://github.com/surrealdb/docs.surrealdb.com/blob/main/public/integrations/agent-rules/surrealdb-python.mdc)
- [SurrealDB running embedded in Python](https://github.com/surrealdb/docs.surrealdb.com/blob/main/public/integrations/agent-rules/surrealdb-python-embedded.mdc)

Place these files in your project directory under `.cursor/rules`. If you are using a different IDE, take a look at the following instructions.

## How to configure agent rules on main IDEs:

- [Cursor rules](https://cursor.com/docs/context/rules)
- [Zed rules](https://zed.dev/docs/ai/overview)
- [OpenCode rules](https://opencode.ai/docs/rules/)

If you are working as a team, consider using the Cursor standard and configure
your specific IDE accordingly. For example, for OpenCode you can configure your
`opencode.json` like this:

```json
{
  "$schema": "https://opencode.ai/config.json",
  "instructions": [".cursor/rules/*.md"]
}
```