Files
agent-framework/ONBOARDING.md
T

2.1 KiB

Onboarding a Project

This document defines the Agent Protocol for initializing a new project. When the agent is asked to "Onboard a project," it must follow these steps.

The Exploration Ritual

The agent's first task in any project is to perform an "Initial Exploration" to establish context.

Step 1: Discovery

The agent must:

  1. Explore the project root using ls and find.
  2. Read .agent-framework/AGENT.md
  3. Read .agent-framework/RULES.md
  4. Read the global ~/.agent-framework/AGENT.md

Step 2: Reporting

The agent must report back with:

  • Confirmation that the framework files were found and read.
  • A summary of the project rules.
  • The expected workflow for this project.
  • Key observations from the project structure.

The Lifecycle of a Project

Once onboarded, the project moves through these phases. The agent should use the provided prompts to transition between them.

Phase 1: Research

Template: prompts/research.md Output: SPEC.md Trigger: "Research {task-description}"

Phase 2: Implementation

Template: prompts/implement.md Output: Code changes + test results Trigger: "Implement the {task-name} task"

Phase 3: Bug Finding

Template: prompts/bug_finder.md Output: BUG_REPORT.md Trigger: "Find bugs in the {task-name} task"

Phase 4: Adversarial Verification

Template: prompts/adversarial_bug_find.md Output: ADVERSARIAL_BUG_REPORT.md Trigger: "Perform adversarial bug find for {task-name}"

Phase 5: Referee

Template: prompts/referee.md Output: VERDICT.md Trigger: "Review the {task-name} task"

Prompt Rendering Convention

All prompts are stored as template files in ~/.agent-framework/prompts/. They use {placeholder} syntax.

Placeholders

  • {project}: Absolute path to the project root.
  • {task-name}: The task folder name (kebab-case).
  • {task-description}: A brief, clear summary of the current work.

When the agent receives a trigger command, it must:

  1. Read the corresponding template file.
  2. Replace all {placeholders} with the actual project values.
  3. Execute the rendered prompt.