mirror of
https://github.com/thecyberlearn/quantum-ai-v3.git
synced 2026-08-18 08:52:58 +00:00
**Complete Rewrite:** ✅ **Simplified Process** - 3 steps: JSON file → git commit → done ✅ **Current Examples** - Clean, working examples for both agent types ✅ **Modern Architecture** - References new modular view structure ✅ **Current Agent List** - Updated with all 8 working agents ✅ **Focused Content** - Removed outdated complexity and old patterns **Removed:** ❌ Old database commands and complex setup procedures ❌ Outdated populate_agents references and troubleshooting ❌ Complex template creation steps that are no longer needed ❌ References to old view structure patterns **Added:** ✅ Clean JSON examples that actually work ✅ Current category list with descriptions ✅ New modular view architecture guidance ✅ Railway auto-deployment process ✅ Simple 3-step creation workflow **Result:** Documentation now matches the elegant simplicity of the current system 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
5.8 KiB
5.8 KiB
Agent Creation Guide
Modern guide for adding new agents to the Quantum Tasks AI platform using the streamlined file-based system.
Overview
Quantum Tasks AI uses a simple file-based agent system:
- Create JSON configuration file
- Commit to git
- Agent appears in marketplace automatically
Two Agent Types:
- Webhook Agents - N8N integrations with dynamic forms
- Direct Access Agents - External forms (JotForm, etc.) with payment processing
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
Categories (6 Available)
Use existing categories first to avoid proliferation:
analysis🧠 - Problem-solving, strategic analysiscareer-education🎓 - Career guidance, professional developmentdocument-processing📄 - PDF analysis, file processinghuman-resources💼 - Job postings, HR automationmarketing📢 - Social ads, content marketingconsulting💼 - Business consultation, expert advice
Creating New Agents
Step 1: Create JSON Configuration
Add new file in agents/configs/agents/your-agent-name.json:
Webhook Agent Example:
{
"slug": "content-optimizer",
"name": "Content Optimizer",
"short_description": "AI-powered content optimization and enhancement",
"description": "Enhance your content with AI-powered optimization suggestions, tone analysis, and improvement recommendations.",
"category": "marketing",
"price": 5.0,
"agent_type": "form",
"system_type": "webhook",
"form_schema": {
"fields": [
{
"name": "content",
"type": "textarea",
"label": "Content to Optimize",
"required": true
},
{
"name": "content_type",
"type": "select",
"label": "Content Type",
"required": true,
"options": [
{"value": "blog", "label": "Blog Post"},
{"value": "social", "label": "Social Media"},
{"value": "email", "label": "Email Marketing"}
]
}
]
},
"webhook_url": "http://localhost:5678/webhook/content-optimizer",
"access_url_name": "",
"display_url_name": ""
}
Direct Access Agent Example:
{
"slug": "business-coach",
"name": "Business Coach",
"short_description": "Expert business coaching consultation",
"description": "Get professional business coaching insights and strategic guidance from experienced consultants.",
"category": "consulting",
"price": 0.0,
"agent_type": "form",
"system_type": "direct_access",
"form_schema": {"fields": []},
"webhook_url": "https://form.jotform.com/your-form-id",
"access_url_name": "agents:direct_access_handler",
"display_url_name": "agents:direct_access_display"
}
Step 2: Commit to Git
git add agents/configs/agents/your-agent-name.json
git commit -m "Add new agent: Your Agent Name"
git push
Step 3: Done!
- Development: Restart server to see new agent
- Production: Railway auto-deploys and agent appears in marketplace
JSON Configuration Reference
Required Fields:
slug- URL identifier (kebab-case)name- Display nameshort_description- Brief marketplace descriptiondescription- Full descriptioncategory- Must match existing categoryprice- Price in AED (0.0 for free)agent_type- Always "form"system_type- "webhook" or "direct_access"
System-Specific Fields:
Webhook Agents:
form_schema- Form field definitionswebhook_url- N8N webhook endpointaccess_url_name- Empty ""display_url_name- Empty ""
Direct Access Agents:
form_schema- Usually{"fields": []}webhook_url- External form URLaccess_url_name- "agents:direct_access_handler"display_url_name- "agents:direct_access_display"
Form Field Types (Webhook Agents)
text- Single-line text inputtextarea- Multi-line text inputselect- Dropdown with options arrayfile- File upload with drag-and-dropurl- URL input with validationcheckbox- Boolean checkbox
Custom Integration (Advanced)
For agents needing custom behavior, add views to appropriate modules:
- API endpoints:
agents/api_views.py - Chat functionality:
agents/chat_views.py - Web interfaces:
agents/web_views.py - Direct access handlers:
agents/direct_access_views.py - Utilities:
agents/utils.py
Then add URL routes in agents/urls.py and update marketplace template if needed.
External Services
For Webhook Agents:
- Create N8N workflow at webhook URL
- Configure to accept JSON payload with
sessionId,message, etc.
For Direct Access Agents:
- Create external form (JotForm, Google Forms, etc.)
- Ensure form URL is publicly accessible
Railway Deployment
Automatic Process:
- ✅ Git push triggers Railway deployment
- ✅ Agent files are processed automatically
- ✅ New agents appear in production marketplace
- ✅ No manual database work required
Quick Tips
- Use existing categories - Avoid creating unnecessary new categories
- Keep descriptions clear - Users should understand what the agent does
- Test webhook URLs - Ensure N8N endpoints are accessible
- Free vs Paid - Set price to 0.0 for free agents
- Consistent naming - Use kebab-case for slugs, Title Case for names
Last updated: 2025-01-14