Claude Code Skill¶
Apache Burr includes a comprehensive Claude Code skill that makes Claude an expert in helping you build Burr applications.
What is the Claude Code Skill?¶
The Burr Claude skill is a plugin for Claude Code, Anthropic’s official CLI tool. When active, it teaches Claude how to:
Build new Burr applications from scratch
Write properly structured actions and transitions
Follow best practices and design patterns
Debug common issues
Provide working code examples
Review your code for correctness
Installation¶
Option 1: Install from GitHub (Easiest)¶
Use the Claude CLI to install directly from GitHub:
# Install to personal skills directory
claude skill install https://github.com/apache/burr/.claude/skills/burr
# Or install to your current project
claude skill install https://github.com/apache/burr/.claude/skills/burr --project
Option 2: Manual Personal Installation¶
Copy the skill to your personal Claude skills directory:
# Clone the Burr repository
git clone https://github.com/apache/burr
# Copy skill to personal directory
cp -r burr/.claude/skills/burr ~/.claude/skills/
Option 3: Manual Project Installation¶
For team projects, copy the skill to your project’s .claude/skills/ directory:
# From your project root
cp -r /path/to/burr/.claude/skills/burr .claude/skills/
Verify Installation¶
Check that the skill is available:
# In Claude Code, try:
/burr --help
Or ask Claude naturally:
“Help me build a Burr application”
Usage¶
Manual Invocation¶
Use the /burr command to explicitly invoke the skill:
/burr How do I create a streaming action?
/burr Review this action for best practices
/burr Show me an example of parallel execution
Automatic Invocation¶
Claude automatically loads the skill when it detects you’re working with Burr:
"I'm building a chatbot with Burr"
"Why isn't my action updating the state?"
"Show me how to add persistence"
What Can It Do?¶
Code Generation¶
Ask Claude to generate complete Burr applications:
Example:
"Create a Burr application for a RAG chatbot with document retrieval and reranking"
Claude will generate:
Action functions with proper
@actiondecoratorsState machine transitions with conditions
Tracking configuration
Complete application setup
Code Review¶
Get feedback on your Burr code:
Example:
"Review this application for best practices"
Claude will check:
Correct
readsandwritesdeclarationsState immutability
Transition coverage
Error handling
Performance considerations
Learning & Examples¶
Get working examples for common patterns:
Example:
"Show me how to implement retry logic"
Claude provides:
Complete working code
Explanation of the pattern
Best practices
References to documentation
Debugging Help¶
Troubleshoot issues with Claude’s help:
Example:
"My state machine is looping infinitely"
Claude will:
Analyze transition logic
Suggest using
.visualize()Provide solutions
Reference troubleshooting docs
Skill Contents¶
The skill includes comprehensive documentation:
API Reference¶
Complete documentation of Burr’s API:
Actions and decorators
State management
ApplicationBuilder
Transitions and conditions
Persistence
Tracking and hooks
Examples¶
Working code examples for:
Basic chatbots
Streaming actions
Parallel execution
Error handling and retries
RAG patterns
State persistence
Testing
Design Patterns¶
Best practices and architectural guidance:
Single responsibility actions
State immutability
Deterministic actions
Error recovery patterns
Multi-stage pipelines
Branching decision trees
Troubleshooting¶
Solutions for common issues:
Installation problems
State machine loops
State not updating
Persistence issues
Performance optimization
Common Use Cases¶
Building a Chatbot¶
"Help me build a multi-modal chatbot with Burr"
Claude will create a complete chatbot with:
User input action
LLM response action
State management for chat history
Transitions for conversation flow
Adding Features¶
"Add streaming responses to my chatbot"
Claude will:
Show how to convert to a streaming action
Provide the generator pattern
Update the application setup
Debugging¶
"My action isn't updating state, what's wrong?"
Claude will:
Review your code
Identify the issue (likely missing
return)Provide the fix
Explain why it matters
Tips for Best Results¶
Be specific - “Help me add retry logic to my fetch action” is better than “help with errors”
Show your code - Claude works best when it can see what you’re building
Ask for examples - “Show me an example of…” gets working code
Reference the skill’s docs - Ask Claude to check the API reference or patterns guide
Use visualization - Ask Claude to suggest using
app.visualize()when debugging
Example Conversation¶
Here’s a typical interaction:
You: I want to build a Burr application that processes documents through multiple stages
Claude: I'll help you create a multi-stage document processing pipeline with Burr.
Let me create actions for each stage...
[Claude generates code with actions for validation, transformation, enrichment, and output]
You: How do I add error handling?
Claude: I'll show you how to add error recovery with retries. Here's the pattern...
[Claude adds error handling actions and transitions]
You: Can you review this code?
Claude: Let me check your application for best practices...
[Claude reviews and provides feedback]
Integration with Development¶
The skill integrates seamlessly with your development workflow:
During design - Get help planning your state machine architecture
While coding - Generate boilerplate and follow patterns
When debugging - Troubleshoot issues and understand errors
In code review - Verify best practices are followed
Customizing the Skill¶
You can customize the skill for your needs:
Edit
SKILL.mdto change instructionsAdd your own examples to
examples.mdUpdate
patterns.mdwith team-specific practicesExtend
api-reference.mdwith custom actions
Example customization:
cd ~/.claude/skills/burr
# Edit the skill files
vim examples.md
Updating the Skill¶
To get the latest version:
cd /path/to/burr
git pull
cp -r .claude/skills/burr ~/.claude/skills/
FAQ¶
Do I need Burr installed to use the skill?
No, but Claude can help you install it when needed.
Can I use this with other frameworks?
Yes! Burr integrates well with LangChain, LlamaIndex, Apache Hamilton, and others.
Will this work with older Burr versions?
The skill is designed for current Burr versions. Some APIs may differ in older releases.
How do I disable the skill?
Rename the skill directory:
mv ~/.claude/skills/burr ~/.claude/skills/burr.disabled
Can I share my customizations?
Yes! Contribute improvements back to the project via pull request.
Contributing¶
Found an issue or want to improve the skill? We welcome contributions!
Reporting Issues¶
If you find a bug or have a suggestion:
Check existing issues at https://github.com/apache/burr/issues
Open a new issue with:
Clear description of the problem or suggestion
Steps to reproduce (for bugs)
Expected vs actual behavior
Burr version and environment details
Contributing Improvements¶
We especially appreciate pull requests! To contribute:
Fork the repository
Edit the skill files in
.claude/skills/burr/Test your changes with Claude Code
Submit a PR to https://github.com/apache/burr with:
Clear description of what you changed and why
Examples showing the improvement
Any relevant issue references
Small fixes like typos, improved examples, or clearer explanations are always welcome!
The Burr community appreciates all contributions, big and small.