Skip to content

AGENTS.md

Latest commit

 

History

History
102 lines (85 loc) · 2.91 KB

AGENTS.md

File metadata and controls

102 lines (85 loc) · 2.91 KB

AGENTS Instructions

goose is an AI agent framework in Rust with CLI and Electron desktop interfaces.

Setup

source bin/activate-hermit
cargo build

Commands

Build

cargo build                   # debug
cargo build --release         # release  
just release-binary           # release + openapi

Test

cargo test                   # all tests
cargo test -p goose          # specific crate
cargo test --package goose --test mcp_integration_test
just record-mcp-tests        # record MCP

Lint/Format

cargo fmt
./scripts/clippy-lint.sh
cargo clippy --fix

UI

just generate-openapi        # after server changes
just run-ui                  # start desktop
cd ui/desktop && npm test    # test UI

Structure

crates/
├── goose             # core logic
├── goose-bench       # benchmarking
├── goose-cli         # CLI entry
├── goose-server      # backend (binary: goosed)
├── goose-mcp         # MCP extensions
├── goose-test        # test utilities
├── mcp-client        # MCP client
├── mcp-core          # MCP shared
└── mcp-server        # MCP server

temporal-service/     # Go scheduler
ui/desktop/           # Electron app

Development Loop

# 1. source bin/activate-hermit
# 2. Make changes
# 3. cargo fmt
# 4. cargo build
# 5. cargo test -p <crate>
# 6. ./scripts/clippy-lint.sh
# 7. [if server] just generate-openapi

Rules

Test: Prefer tests/ folder, e.g. crates/goose/tests/ Test: When adding features, update goose-self-test.yaml, rebuild, then run goose run --recipe goose-self-test.yaml to validate Error: Use anyhow::Result Provider: Implement Provider trait see providers/base.rs MCP: Extensions in crates/goose-mcp/ Server: Changes need just generate-openapi

Code Quality

Comments: Write self-documenting code - prefer clear names over comments Comments: Never add comments that restate what code does Comments: Only comment for complex algorithms, non-obvious business logic, or "why" not "what" Simplicity: Don't make things optional that don't need to be - the compiler will enforce Simplicity: Booleans should default to false, not be optional Errors: Don't add error context that doesn't add useful information (e.g., .context("Failed to X") when error already says it failed) Simplicity: Avoid overly defensive code - trust Rust's type system Logging: Clean up existing logs, don't add more unless for errors or security events

Never

Never: Edit ui/desktop/openapi.json manually Never: Edit Cargo.toml use cargo add Never: Skip cargo fmt Never: Merge without ./scripts/clippy-lint.sh Never: Comment self-evident operations (// Initialize, // Return result), getters/setters, constructors, or standard Rust idioms

Entry Points

  • CLI: crates/goose-cli/src/main.rs
  • Server: crates/goose-server/src/main.rs
  • UI: ui/desktop/src/main.ts
  • Agent: crates/goose/src/agents/agent.rs