CLAUDE.md file to your project and refining it over time.
Getting Started
Prerequisites:- Active Claude subscription (Pro, Max, or API access)
- A dbt project with Buster installed
- Buster agents directory at
.github/buster/agents/
- Install Claude Code:
- Navigate to your dbt project directory.
- (Optional) Add the
CLAUDE.mdfile below to your project root. - Run
claudeto start.
CLAUDE.md Template
Save aCLAUDE.md file at the root of your project to help Claude Code understand Buster’s patterns and your project conventions. This file trains Claude Code on agent configuration standards, your dbt project structure, and workflow preferences.
See Manage Claude’s memory in the Anthropic docs for more information.
Copy this example template or customize it for your specific needs:
Content strategy for agents
Prompt writing
- Be specific about desired outcomes, not implementation steps
- Use numbered steps for sequential workflows
- Use natural language for adaptive/investigative tasks
- Include conditional logic (if-then) when needed
- Specify output formats (PR titles, comment structure, Slack messages)
- Handle success, failure, and edge cases
Our standards
[Customize this section with your team’s standards]- Documentation format: Model descriptions should include purpose, grain, row count
- PR conventions: Prefix with type (feat:, fix:, docs:, refactor:)
- Test requirements: All fact tables need unique and not_null tests on primary keys
- Naming conventions: [Your dbt naming patterns]
- Slack channels: #data-alerts for critical, #data-platform for info
Testing workflow
- Create agent YAML in .github/buster/agents/
- Validate:
buster validate agents/agent-name.yaml - Test locally:
buster test agents/agent-name.yaml - Review execution logs for files accessed, queries run, actions taken
- Refine prompt based on behavior
- Commit to main branch to deploy
Git workflow
- NEVER use —no-verify when committing
- Create feature branches for new agents or major changes
- Test agents locally before committing
- Agent configs on main branch are automatically deployed
- Include comments in YAML explaining complex logic
Common agent patterns
Documentation updater
PR code reviewer
Schema change handler
Do not
- Skip required fields (name, triggers, prompt)
- Use absolute file paths (use relative to project root)
- Include credentials or secrets in agent configs
- Make agents do too many unrelated things (keep focused)
- Forget to test before deploying
Resources
- Creating Agents guide: /guides/creating-agents
- Prompting Best Practices: /resources/prompting-best-practices
- Testing & Debugging: /guides/testing-and-debugging
Review existing agents for issues
Get suggestions to improve agent configurations and catch potential problems. Example prompt:Refine a prompt that isn’t working
Improve an agent’s prompt based on observed behavior. Example prompt:Generate test scenarios
Create comprehensive test cases for your agents. Example prompt:Convert a manual workflow to an agent
Transform a repetitive task into automation. Example prompt:Debug an agent that’s not triggering
Troubleshoot trigger configuration issues. Example prompt:Extending Claude Code
Beyond manually prompting Claude Code, you can integrate it with your workflows for Buster development.Automation with GitHub Actions
Run Claude Code automatically to generate agent drafts when certain events occur. For example, when a new data source is added to your dbt project, automatically generate a staging model documentation agent.Agent configuration reviews
Use Claude Code in your CI/CD pipeline to review agent changes in PRs:- Validate YAML syntax
- Check for common anti-patterns
- Ensure prompts include error handling
- Flag agents with overly broad permissions
Multi-instance workflows
Use separate Claude Code sessions for different tasks:- One for creating new agents from scratch
- Another for optimizing existing agent prompts
- A third for troubleshooting failed agent runs
Team collaboration
Share your refinedCLAUDE.md file with your team to ensure consistent agent development standards. Teams often develop project-specific patterns that become part of their workflow—like standard Slack channels for notifications, preferred error handling patterns, or documentation templates.
Custom commands
Create reusable slash commands in.claude/commands/ for frequently used Buster operations:
Example: .claude/commands/new-agent.md
.claude/commands/test-agent.md
Best Practices
Start with examples
When creating new agents, reference existing working agents:Iterate on prompts incrementally
Don’t try to perfect an agent prompt all at once. Start simple and add complexity:Use local testing
Always test agents locally before deploying:Document complex logic
For agents with sophisticated prompts, add comments:Version your agent changes
Track meaningful changes to agent behavior:Common Patterns
Creating agents for new data sources
Setting up monitoring agents
Batch operations
Troubleshooting with Claude Code
Agent runs but doesn’t do what you expect
Agent errors out
Agent triggers too frequently
Learn More
Creating Agents
Complete guide to agent configuration and best practices
Prompting Best Practices
Learn how to write effective agent prompts
Testing & Debugging
Test and refine agents locally with the Buster CLI