Skip to Content
DocsAGENTS.md

Custom AI Instructions – AGENTS.md

AGENTS.md is a Markdown file where you write instructions for the Ziva agent. Anything you put in it applies automatically to every chat in that project — no need to repeat yourself.

Where Ziva looks

Ziva reads AGENTS.md from the following locations. All files that exist are loaded; project files take priority over home-directory files.

LocationScope
<project>/AGENTS.mdThis project (check into version control to share with your team)
<project>/.ziva/AGENTS.mdThis project, alternative location
<project>/.agents/AGENTS.mdThis project, alternative location
~/.ziva/AGENTS.mdAll projects on this machine
~/.agents/AGENTS.mdAll projects on this machine, alternative location

<project> is the folder containing your project.godot file.

What to write

Good things to capture:

  • Conventions — “Typed GDScript everywhere. Never use untyped var.”
  • File boundaries — “C# is only allowed in addons/integrations/.”
  • Workflow rules — “Run GUT tests after any change under tests/.”
  • Anti-patterns — “Never call get_node() in _process. Cache references in _ready.”

Keep rules short and direct. The more specific they are, the more reliably the agent follows them.

Example

# Project conventions - Typed GDScript only. No untyped `var`. - 2D scenes in `scenes/2d/`, 3D in `scenes/3d/`. - Tests live in `tests/` and run with GUT. ## Anti-patterns - No `get_node()` in `_process` — cache references in `_ready`. - No global singletons except `Globals.gd`. Use signal buses instead.

When changes take effect

AGENTS.md is read when a chat starts. After editing it, start a new chat (/new) for the changes to apply.

See also

  • Slash commands — on-demand prompt shortcuts
  • Skills — reusable capability packs the agent loads automatically
Last updated on