AGENTS.md@extensions/Godot-AI-Beehave git:20261016.cf84037A

Immutable. This exact content never changes and is served at /api/v1/blob/1fc516cc0b374300.

# AGENTS.md — Godot-AI-Beehave

A **Godot-MCP extension** wrapping the third-party [**Beehave**](https://github.com/bitbrain/beehave) addon:
MCP tools for authoring behaviour trees (`BeehaveTree`, composites, decorators, action/condition leaves) in
the Godot editor. Shipped as a **source-only NuGet package** (`com.IvanMurzak.Godot.MCP.Beehave`) that
compiles inside the consumer's Godot project against the consumer's own GodotSharp. Created from
[`Godot-AI-Tools-Template`](https://github.com/IvanMurzak/Godot-MCP/tree/main/templates/extension). The packaging recipe is
the load-bearing detail — read `docs/source-only-nuget-recipe.md`.

## Addon-dependent (Class B) — the load-bearing rules

Beehave is a third-party GDScript addon whose classes are NOT in GodotSharp, and the package must not depend
on it:

- **No compile-time dependency.** Reference Beehave classes **by string name only**, resolved at runtime.
  `dotnet build -c Debug` MUST exit 0 with the addon ABSENT (the no-dependency gate).
- **Resolution:** Beehave registers GDScript `class_name` types in the **global script-class list**, not
  `ClassDB`: resolve via `ProjectSettings.GetGlobalClassList()` + `GD.Load`. `ClassDB.ClassExists` returns
  `false` for a `class_name` type even when installed (the #1 trap).
- **Presence gate first.** Every editor tool's first action inside `MainThread.Instance.Run(...)` checks
  `AddonInterop.GlobalClassExists(BeehaveEnums.PresenceClass)` (`BeehaveTree`) and, when missing, returns the
  structured `installed: false` result (`AddonGateResult`) with an install hint — never a raw throw (an opaque
  HTTP 500 to the LLM).
- **Names are the contract.** Drive addon objects via `GodotObject.Set/Get/Call` with GDScript **snake_case**
  member names (not C# PascalCase); enums are plain ints. Keep these name constants centralized in
  `Runtime/Beehave/BeehaveEnums.cs` and unit-tested — there are no compile-time types to lean on.
- The addon is **never** vendored, submoduled, or downloaded by this repo; installing it is the consumer's
  job. CI installs the pinned `bitbrain/beehave` @ `v2.9.2` into `testbed/addons/beehave/` only for the e2e
  leg (`ADDON_*` in `.github/workflows/test.yml`).

## Layout

- `src/Godot-AI-Beehave/` — the source-only package (`Godot.NET.Sdk`):
  - `Runtime/Tools/` — `Tool_Beehave.cs` (the `[AiToolType]` partial class), `Tool_Beehave.Ids.cs` (all
    tool-id consts, pinned by tests), and the pure-managed `Tool_Beehave.Defaults.cs`.
  - `Runtime/Interop/` — `AddonInterop.cs` (name resolution + instantiation; entirely behind `#if TOOLS`,
    E2E-verified, never unit-tested), `AddonGate.cs` (the `AddonGateResult` shape + `NotInstalled(...)`
    factory; pure-managed, unit-tested).
  - `Runtime/Beehave/` — `BeehaveEnums` (class/member names + enum ints + `PresenceClass`),
    `BeehaveNodeKinds`, `BeehaveDefaults`, `BeehaveNodeInfo`; all unit-tested.
  - `Editor/Tools/` — one file per editor tool (`Tool_Beehave.<Name>.cs`) + shared helpers in
    `Tool_Beehave.Editor.cs`; all behind `#if TOOLS`.
  - `build/com.IvanMurzak.Godot.MCP.Beehave.props` — source-injection props, auto-imported by NuGet in the
    consumer; MUST stay named `<PackageId>.props`.
- `tests/Godot-AI-Beehave.Tests/` — xUnit specs for the pure-managed sources only (no Godot binary).
- `tests/e2e/` — live `run-tool` E2E: the tool list `e2e-tools.json`, driven by `run_tool_e2e.py`.
- `testbed/Beehave-Testbed.csproj` — consumer `Godot.NET.Sdk` project restoring the local-packed package; its
  `dotnet build` is the source-injection proof.
- `commands/` — `bump-version`, `update-core`, `init` (`.ps1` + `.py`), `get-version.ps1`.
- CI and publishing are centralized in the monorepo; see `../../docs/EXTENSION-MONOREPO.md`.

- `docs/` — `source-only-nuget-recipe.md` (the packaging recipe + consumer story); `ci.md` (workflows, version
  gate, multi-Godot matrix, NuGet publishing setup).

## Tools

Ids live in `Runtime/Tools/Tool_Beehave.Ids.cs` (the source of truth). Current tools: `beehave-defaults`
(pure-managed), `beehave-tree-create`, `beehave-add-composite`, `beehave-add-decorator`, `beehave-add-leaf`,
`beehave-get`.

The tools only **author** tree structure (the tree ticks in-game). Beehave leaves are abstract:
`beehave-add-leaf` creates a scaffold node and the user attaches the behaviour GDScript. Keep at least one
pure-managed tool (`beehave-defaults`) so the e2e is never vacuous.

## Build / test (no Godot binary, addon absent)

```bash
dotnet build src/Godot-AI-Beehave/Godot-AI-Beehave.csproj  # source-only package compiles tools
dotnet test  tests/Godot-AI-Beehave.Tests/Godot-AI-Beehave.Tests.csproj
dotnet pack  src/Godot-AI-Beehave/Godot-AI-Beehave.csproj -p:Version=0.0.0-ci -o local-nuget
dotnet build testbed/Beehave-Testbed.csproj                # consumes the local package (injection proof)
```

`Godot.NET.Sdk` supplies GodotSharp from NuGet, so build/test/pack and the source-injection proof need no
Godot install (the testbed build is a faithful proxy for `godot --build-solutions`). CI proves the recipe
across Godot 4.3 / 4.4 / 4.5 (the central monorepo SDK matrix). `dotnet pack` reuses the **global NuGet
cache** for an already-cached version: when re-packing the same `Version`, clear
`~/.nuget/packages/com.ivanmurzak.godot.mcp.beehave/<ver>` (or pack a unique version) before re-restoring the
testbed, or you silently build the stale cached source.

## Conventions

- Root namespace `com.IvanMurzak.Godot.MCP.Beehave`. Every `.cs` starts with the Apache-2.0 header.
- Pure-managed code (tool ids, the `AddonGateResult` shape, name/enum-int constants, defaults) → `Runtime/`
  (outside `#if TOOLS`, unit-testable); editor-driving tools + `AddonInterop` → `#if TOOLS` (every Godot call
  via `MainThread.Instance.Run(...)`, E2E-verified).
- The package declares ONLY the `com.IvanMurzak.McpPlugin` / `com.IvanMurzak.ReflectorNet` min-version deps;
  **GodotSharp and the Beehave addon must never become a package dependency** (CI asserts the nuspec). Keep
  the MCP pins in lockstep with the core Godot-MCP addon; bump with `commands/update-core.ps1`.
- One `[AiToolType] partial class Tool_Beehave`; one `[AiTool]` method per partial-class file. Add every new
  pure-managed source to the test csproj `<Compile Include>` list so it is unit-tested.