Tips

Onboard your repo first: Repositories must be registered via a Blueprint construct before tasks can target them. If you get a REPO_NOT_ONBOARDED error, contact your platform administrator.
Prepare your repo: The agent works best with repositories that are agent friendly. See the Developer guide for repository preparation advice.
Add a CLAUDE.md: The agent automatically loads project-level configuration from your repository — CLAUDE.md, .claude/CLAUDE.md, .claude/rules/*.md, .claude/settings.json, .claude/agents/, and .mcp.json. Use these to provide project-specific build commands, conventions, constraints, custom subagents, and architecture notes. See the Prompt guide for details and examples.
Issue vs text: When using --issue (CLI) or issue_number (API), the agent fetches the full issue body from GitHub, including any labels, comments, and linked context. This is usually better than a short text description.
Cost: Cost depends on the model and number of turns. Use --max-turns (CLI) or max_turns (API) to cap the number of agent iterations per task (range: 1–500). If not specified, the per-repo Blueprint default applies, falling back to the platform default (100). Use --max-budget (CLI) or max_budget_usd (API) to set a hard cost limit in USD ($0.01–$100) — when the budget is reached, the agent stops regardless of remaining turns. If no budget is specified, the per-repo Blueprint default applies; if that is also absent, no cost limit is enforced. Check the task status after completion to see the reported cost.
Idempotency: Use the Idempotency-Key header when creating tasks via the API to safely retry requests without creating duplicate tasks.