mirror of
https://github.com/thecyberlearn/quantum-ai-v3.git
synced 2026-08-18 12:52:58 +00:00
📚 Update all markdown files to reflect modern file-based system
**Updated Files:** ✅ **agents/configs/README.md** - Removed populate_agents references, added current agent list ✅ **docs/AGENT_REQUEST_TEMPLATE.md** - Streamlined process, removed old command references **Key Changes:** - **File-based approach** - JSON file → git commit → agent appears - **Current agent inventory** - All 8 working agents listed with prices - **Simple 3-step process** - Create JSON, commit, done - **Railway auto-deployment** - No manual database commands needed - **Updated examples** - Clean, modern JSON configurations - **Consistent messaging** - All docs now reflect current system reality **Removed Outdated Content:** ❌ populate_agents command references ❌ Complex database setup procedures ❌ Old troubleshooting for obsolete issues ❌ Outdated agent lists and pricing **Result:** All documentation now consistently reflects the elegant file-based system 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
67ab31f550
commit
576e9c7183
@ -1,6 +1,6 @@
|
||||
# Agent Configuration System
|
||||
|
||||
This directory contains JSON configuration files for dynamically creating agents and categories in the Quantum Tasks AI platform.
|
||||
This directory contains JSON configuration files for the Quantum Tasks AI platform's file-based agent system.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
@ -10,31 +10,34 @@ agents/configs/
|
||||
│ └── categories.json # All agent categories
|
||||
├── agents/
|
||||
│ ├── ai-brand-strategist.json # Direct access agent
|
||||
│ ├── cybersec-career-navigator.json # Direct access agent
|
||||
│ ├── cybersec-career-navigator.json # Direct access agent
|
||||
│ ├── five-whys-analysis.json # Chat webhook agent
|
||||
│ ├── job-posting-generator.json # Form webhook agent
|
||||
│ ├── lean-six-sigma-expert.json # Direct access agent
|
||||
│ ├── pdf-summarizer.json # File upload webhook agent
|
||||
│ └── social-ads-generator.json # Form webhook agent
|
||||
│ ├── social-ads-generator.json # Form webhook agent
|
||||
│ └── swot-analysis-expert.json # Direct access agent
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
**Simple File-Based System:**
|
||||
1. **Categories** are defined in `categories/categories.json`
|
||||
2. **Agents** are defined in individual JSON files in `agents/`
|
||||
3. Run `python manage.py populate_agents` to create all agents from configs
|
||||
3. **File changes** are automatically loaded by the Django application
|
||||
4. **Adding new agents** is as simple as creating a new JSON file
|
||||
|
||||
## Adding New Agents
|
||||
|
||||
### Step 1: Create JSON Configuration File
|
||||
|
||||
Create a new file in `agents/` directory, e.g., `email-writer.json`:
|
||||
Create a new file in the `agents/` directory, e.g., `email-writer.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"slug": "email-writer",
|
||||
"name": "Email Writer",
|
||||
"name": "Email Writer",
|
||||
"short_description": "AI-powered professional email writing assistant",
|
||||
"description": "Generate professional emails for any purpose with AI assistance.",
|
||||
"category": "marketing",
|
||||
@ -61,15 +64,18 @@ Create a new file in `agents/` directory, e.g., `email-writer.json`:
|
||||
}
|
||||
```
|
||||
|
||||
### Step 2: Run Population Command
|
||||
### Step 2: Commit to Git
|
||||
|
||||
```bash
|
||||
python manage.py populate_agents
|
||||
git add agents/configs/agents/email-writer.json
|
||||
git commit -m "Add Email Writer agent"
|
||||
git push
|
||||
```
|
||||
|
||||
### Step 3: Agent Appears Automatically
|
||||
|
||||
The agent will now appear in the marketplace with the configured settings.
|
||||
- **Development:** Restart server to see the new agent
|
||||
- **Production:** Railway auto-deploys and agent appears in marketplace
|
||||
|
||||
## Agent Types
|
||||
|
||||
@ -86,28 +92,52 @@ The agent will now appear in the marketplace with the configured settings.
|
||||
- Set `access_url_name`: `"agents:direct_access_handler"`
|
||||
- Set `display_url_name`: `"agents:direct_access_display"`
|
||||
|
||||
## Current Agents (8 Total)
|
||||
|
||||
### Webhook Agents (4)
|
||||
- **Social Ads Generator** - 6.00 AED
|
||||
- **Job Posting Generator** - 10.00 AED
|
||||
- **PDF Summarizer** - 8.00 AED
|
||||
- **5 Whys Analyzer** - 15.00 AED
|
||||
|
||||
### Direct Access Agents (4)
|
||||
- **CyberSec Career Navigator** - FREE
|
||||
- **AI Brand Strategist** - FREE
|
||||
- **Lean Six Sigma Expert** - FREE
|
||||
- **SWOT Analysis Expert** - FREE
|
||||
|
||||
## Field Types for Webhook Agents
|
||||
|
||||
- `text`: Single-line text input
|
||||
- `textarea`: Multi-line text input
|
||||
- `textarea`: Multi-line text input
|
||||
- `select`: Dropdown with options array
|
||||
- `file`: File upload with drag-and-drop
|
||||
- `url`: URL input with validation
|
||||
- `checkbox`: Boolean checkbox
|
||||
|
||||
## Categories (6 Available)
|
||||
|
||||
- **`analysis`** 🧠 - Problem-solving, strategic analysis
|
||||
- **`career-education`** 🎓 - Career guidance, professional development
|
||||
- **`document-processing`** 📄 - PDF analysis, file processing
|
||||
- **`human-resources`** 💼 - Job postings, HR automation
|
||||
- **`marketing`** 📢 - Social ads, content marketing
|
||||
- **`consulting`** 💼 - Business consultation, expert advice
|
||||
|
||||
## Benefits
|
||||
|
||||
✅ **Scalable**: Add 100+ agents without code changes
|
||||
✅ **Version Controlled**: All agent definitions in git
|
||||
✅ **Consistent**: Ensures local and Railway databases match
|
||||
✅ **Simple**: Just create JSON file and run command
|
||||
✅ **Validated**: Built-in validation and error handling
|
||||
✅ **Instant Creation**: Add JSON file → agent appears automatically
|
||||
✅ **Version Controlled**: All agent definitions tracked in git
|
||||
✅ **Railway Ready**: Automatic deployment with git push
|
||||
✅ **No Database Work**: File-based system handles everything
|
||||
✅ **Scalable**: Add hundreds of agents without complexity
|
||||
|
||||
## Railway Deployment
|
||||
|
||||
On Railway, just run:
|
||||
```bash
|
||||
python manage.py populate_agents
|
||||
```
|
||||
**Automatic Process:**
|
||||
1. ✅ Git push triggers Railway deployment
|
||||
2. ✅ Agent files are processed automatically
|
||||
3. ✅ New agents appear in production marketplace
|
||||
4. ✅ No manual database commands required
|
||||
|
||||
All agents defined in JSON files will be created automatically, ensuring Railway marketplace shows all agents consistently.
|
||||
For complete documentation, see `docs/AGENT_CREATION.md`.
|
||||
@ -1,13 +1,13 @@
|
||||
# Agent Request Template
|
||||
|
||||
Use this template when requesting new agents to ensure all necessary information is provided for quick, error-free agent creation.
|
||||
Use this template when requesting new agents for quick, error-free creation using the modern file-based system.
|
||||
|
||||
## How to Use This Template
|
||||
|
||||
1. **Copy the template below**
|
||||
2. **Fill in all required fields**
|
||||
3. **Provide to Claude Code** with the request "Create agent using this template"
|
||||
4. **Claude will handle** JSON config creation, populate_agents execution, and deployment
|
||||
2. **Fill in all required fields**
|
||||
3. **Provide to Claude Code** with the request "Create agent using this template"
|
||||
4. **Claude will handle** JSON config creation and deployment
|
||||
|
||||
---
|
||||
|
||||
@ -24,9 +24,9 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
**Full Description**: [Detailed description of what the agent does and its benefits]
|
||||
|
||||
### For Webhook Agents Only:
|
||||
**Form Fields**:
|
||||
**Form Fields**:
|
||||
- Field 1: [name: field_name, type: text/textarea/select/file/url/checkbox, label: "Display Label", required: true/false]
|
||||
- Field 2: [name: field_name, type: text/textarea/select/file/url/checkbox, label: "Display Label", required: true/false]
|
||||
- Field 2: [name: field_name, type: text/textarea/select/file/url/checkbox, label: "Display Label", required: true/false]
|
||||
- [Add more fields as needed]
|
||||
|
||||
**N8N Webhook URL**: [Your N8N webhook endpoint URL]
|
||||
@ -48,8 +48,8 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
**Choose from these existing categories** (avoid creating new ones):
|
||||
|
||||
- 🧠 **`analysis`** - Problem-solving, SWOT analysis, strategic analysis tools
|
||||
- 🎓 **`career-education`** - Career guidance, educational resources, professional development
|
||||
- 📄 **`document-processing`** - PDF analysis, file processing, document tools
|
||||
- 🎓 **`career-education`** - Career guidance, educational resources, professional development
|
||||
- 📄 **`document-processing`** - PDF analysis, file processing, document tools
|
||||
- 💼 **`human-resources`** - Job postings, HR automation, talent management
|
||||
- 📢 **`marketing`** - Social ads, branding, content marketing, advertising
|
||||
- 💼 **`consulting`** - Business consultation, strategy services, expert advice
|
||||
@ -75,7 +75,7 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
|
||||
**Agent Name**: Email Campaign Optimizer
|
||||
**Type**: Webhook
|
||||
**Category**: marketing
|
||||
**Category**: marketing
|
||||
**Price**: 4.0 AED
|
||||
**Short Description**: AI-powered email campaign optimization and A/B testing
|
||||
**Full Description**: Optimize your email campaigns with AI analysis of subject lines, content, and send times. Get recommendations for better open rates and conversions.
|
||||
@ -90,9 +90,9 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
|
||||
### Example 2: Direct Access Agent
|
||||
```markdown
|
||||
## New Agent Request
|
||||
## New Agent Request
|
||||
|
||||
**Agent Name**: Financial Planning Consultant
|
||||
**Agent Name**: Financial Planning Consultant
|
||||
**Type**: Direct Access
|
||||
**Category**: consulting
|
||||
**Price**: 0.0 AED
|
||||
@ -100,7 +100,7 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
**Full Description**: Get expert financial advice tailored to your goals. Our certified financial planners provide personalized investment strategies and retirement planning.
|
||||
|
||||
### For Direct Access Agents:
|
||||
**External Form URL**: https://agent.jotform.com/financial-planning-form-id
|
||||
**External Form URL**: https://form.jotform.com/financial-planning-form-id
|
||||
**Custom Template Needed**: No
|
||||
**Custom Views Needed**: No
|
||||
```
|
||||
@ -112,23 +112,40 @@ Use this template when requesting new agents to ensure all necessary information
|
||||
After you provide the completed template:
|
||||
|
||||
1. ✅ **Claude creates JSON config** in `agents/configs/agents/`
|
||||
2. ✅ **Runs populate_agents command** to add agent to database
|
||||
3. ✅ **Agent appears in marketplace** automatically
|
||||
4. ✅ **Creates any needed templates/views** (for Direct Access agents)
|
||||
2. ✅ **Agent configuration is committed to git**
|
||||
3. ✅ **Agent appears in marketplace** automatically via file-based system
|
||||
4. ✅ **Creates any needed templates/views** (for advanced Direct Access agents)
|
||||
5. ✅ **Updates marketplace integration** if needed
|
||||
6. ✅ **Commits changes** and makes them Railway-ready
|
||||
6. ✅ **Railway deployment ready** - no manual database commands
|
||||
|
||||
**No additional work needed on your part!** 🚀
|
||||
**Simple Process:** JSON file → git commit → agent appears! 🚀
|
||||
|
||||
---
|
||||
|
||||
## Current Agents (8 Total)
|
||||
|
||||
### Webhook Agents (4)
|
||||
- **Social Ads Generator** - 6.00 AED - Social media ad creation
|
||||
- **Job Posting Generator** - 10.00 AED - Professional job postings
|
||||
- **PDF Summarizer** - 8.00 AED - Document analysis and summarization
|
||||
- **5 Whys Analyzer** - 15.00 AED - Interactive root cause analysis
|
||||
|
||||
### Direct Access Agents (4)
|
||||
- **CyberSec Career Navigator** - FREE - Career guidance
|
||||
- **AI Brand Strategist** - FREE - Brand strategy consultation
|
||||
- **Lean Six Sigma Expert** - FREE - Process improvement
|
||||
- **SWOT Analysis Expert** - FREE - Strategic analysis
|
||||
|
||||
---
|
||||
|
||||
## Tips for Better Requests
|
||||
|
||||
- ✅ **Use existing categories** - Avoid creating new ones unless absolutely necessary
|
||||
- ✅ **Be specific** - Clear descriptions help users understand the agent's value
|
||||
- ✅ **Be specific** - Clear descriptions help users understand the agent's value
|
||||
- ✅ **Test external forms** - Ensure JotForm/external URLs are working before requesting
|
||||
- ✅ **Consider pricing** - Free agents get more usage, paid agents need clear value proposition
|
||||
- ✅ **Think about fields** - For webhook agents, plan your form fields carefully
|
||||
- ✅ **Simple is better** - The file-based system makes creation effortless
|
||||
|
||||
---
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user