npx agentspec-cli install da388895-9738-449a-a4e8-42a24776b2b7 --file-type agents-md→ .agents/
# Quick Start Guide for Agents 3-6
## System Status: ✅ READY
The Brigade core is fully operational. Here's what you need to know:
## API Base URL
```
http://localhost:8100
```
## Interactive API Documentation
```
http://localhost:8100/docs
```
## Available Endpoints
### Health Check
```bash
curl http://localhost:8100/api/v1/health
```
### System Status
```bash
curl http://localhost:8100/api/v1/system/status
```
### Execute Agent Task
```bash
curl -X POST http://localhost:8100/api/v1/agents/execute \
-H "Content-Type: application/json" \
-d '{
"agent_type": "research",
"task": "Your task here",
"user_id": "user123"
}'
```
### Streaming Execution
```bash
curl -X POST http://localhost:8100/api/v1/agents/execute/stream \
-H "Content-Type: application/json" \
-d '{
"agent_type": "code",
"task": "Generate Python code",
"user_id": "user123",
"stream": true
}'
```
### Query Memory
```bash
curl -X POST http://localhost:8100/api/v1/memory/query \
-H "Content-Type: application/json" \
-d '{
"user_id": "user123",
"query": "previous tasks",
"limit": 5
}'
```
## Available Agents
1. **research** - Research and information gathering
2. **code** - Code generation and analysis
3. **analysis** - Data analysis and insights
## Docker Commands
### Start Services
```bash
cd /home/muut/Production/UC-Cloud/Unicorn-Brigade
docker compose up -d
```
### Check Status
```bash
docker compose ps
```
### View Logs
```bash
docker compose logs -f brigade-api
```
### Restart API
```bash
docker compose restart brigade-api
```
### Stop Services
```bash
docker compose down
```
## Environment Setup
### Required Environment Variables
Create `.env` file:
```bash
OPENAI_API_KEY=your-key-here
POSTGRES_PASSWORD=secure-password
REDIS_PASSWORD=secure-password
```
See `.env.example` for full configuration.
## Project Structure
```
Unicorn-Brigade/
├── app/ # Application code
│ ├── agents/ # Agent implementations
│ ├── api/ # API routes and models
│ ├── graph/ # LangGraph workflows
│ └── memory/ # mem0 integration
├── tests/ # Test suite
├── docs/ # Documentation
├── docker-compose.yml # Service orchestration
└── README.md # Full documentation
```
## Testing
### Run All Tests
```bash
docker compose exec brigade-api pytest tests/ -v
```
### Run Specific Test File
```bash
docker compose exec brigade-api pytest tests/test_agents.py -v
```
## Integration Points
### For Agent 3 (Frontend Developer)
- Consume REST API at port 8100
- WebSocket support: Coming in Phase 2
- CORS already configured
- OpenAPI schema available at `/docs`
### For Agent 4 (Billing Integration)
- Token tracking implemented
- Usage data in response metadata
- User isolation by user_id
- Ready for Stripe integration
### For Agent 5 (Documentation)
- OpenAPI auto-generated
- Architecture documented
- Examples in README
- Need: User guides, tutorials
### For Agent 6 (Testing & QA)
- 27 test cases ready
- pytest framework configured
- Fixtures in conftest.py
- Need: E2E tests, load tests
## Common Issues
### API Not Responding
```bash
# Check if running
docker compose ps
# Restart
docker compose restart brigade-api
# Check logs
docker compose logs brigade-api
```
### mem0 Error
```bash
# Restart Qdrant
docker compose restart brigade-qdrant
# Wait 10 seconds
sleep 10
# Restart API
docker compose restart brigade-api
```
## Performance
- API response time: <100ms (health)
- Agent execution: 2-5s (with LLM)
- Memory query: <200ms
- Streaming: Real-time
## Security
- CORS enabled
- Input validation (Pydantic)
- Environment-based secrets
- Network isolation
## Next Steps
1. **Start services**: `docker compose up -d`
2. **Test health**: `curl localhost:8100/api/v1/health`
3. **Try example**: See README.md
4. **Build your integration**: Use API docs
## Support
- Full documentation: `/docs/AGENT2-COMPLETION-REPORT.md`
- API docs: `http://localhost:8100/docs`
- README: `/README.md`
## Success Indicators
✅ All services healthy
✅ API responding
✅ Agents executing
✅ Memory persisting
✅ Tests passing
**Status**: System is production-ready. Start building!
---
*Updated: October 14, 2025*
*Agent 2 - Brigade Core Developer*
AGENTS.md
Operational guide for AI agents working in this repository.
by AgentHub Crawler
AGENTS.md
This is a modern AI Agent application built with:
by AgentHub Crawler
BNB Chain AI Toolkit
> 78 AI agents, 6 MCP servers, 1,100+ tools for BNB Chain and networks.
by AgentHub Crawler
Agent Instructions
This project uses **bd** (beads) for issue tracking. Run `bd onboard` to get started.
by AgentHub Crawler
Sign in to leave a comment.