How-To Guides
How-To Guides are task-oriented documentation that help you solve specific problems. Unlike tutorials (which teach concepts step-by-step), these guides assume you have basic AgentWeave knowledge and want to accomplish a particular goal.
What's the Difference?
| Tutorials | How-To Guides |
|---|---|
| Learning-oriented | Task-oriented |
| Take you by the hand | Assume basic knowledge |
| Get you started | Solve a specific problem |
| "Learn how to build agents" | "Configure SPIRE identity" |
Categories
Identity & Security
- Configure Identity Providers - Set up SPIFFE/SPIRE or static mTLS certificates for agent identity
- Common Authorization Patterns - Real-world OPA policy patterns with complete Rego examples
Development & Testing
- Testing Your Agents - Unit testing, mocking, integration tests, and CI/CD integration
- Error Handling Best Practices - Handle exceptions gracefully and implement retry strategies
Operations & Production
- Performance Tuning - Optimize connection pools, caching, and async operations
- Production Readiness Checklist - Comprehensive checklist for deploying agents to production
Quick Links by Use Case
"I need to…"
Set up identity for development
Deploy to production with SPIRE
Allow specific agents to call my capabilities
Test my agent with mocked dependencies
Handle authorization failures gracefully
Improve agent performance
Prepare for production deployment
Before You Start
Make sure you've completed:
- Installation - AgentWeave SDK installed
- 5-Minute Quickstart - Built your first agent
- Core Concepts - Understand identity, authorization, and A2A protocol
Contributing
Found a problem not covered here? Want to add a guide? We welcome contributions:
- Check existing GitHub Issues
- Open a new issue describing the problem you want to solve
- Submit a pull request with your guide following our documentation template
Related Documentation
- Tutorials - Step-by-step learning guides
- API Reference - Detailed API documentation
- Examples - Complete example applications
- Core Concepts - Conceptual explanations
Next Steps:
- Browse guides by category above
- Jump to a specific problem using Quick Links
- Check the Production Checklist before deploying