DeskAgent System Extension¶
Control DeskAgent itself - restart the application, check status, and run agents programmatically.
Built-in
This extension is always available and requires no setup.
What You Can Do¶
Restart DeskAgent¶
Restart the application after making changes to agents or configuration.
Example requests:
- "Restart DeskAgent"
- "Reboot the assistant"
- "Apply my changes and restart"
What happens:
- Current instance shuts down gracefully
- New instance starts automatically
- All changes (new agents, config updates) are loaded
Check Status¶
Get information about the running DeskAgent instance.
Example requests:
- "What version of DeskAgent am I running?"
- "Show DeskAgent status"
- "Is DeskAgent running?"
Response includes:
- Version number
- Build number
- Running status
List Available Agents¶
See all agents that are available in DeskAgent.
Example requests:
- "What agents are available?"
- "List all agents"
- "Show me the agents I can use"
Response includes:
- Agent name
- Description
- Whether the agent requires inputs
Run Agents Programmatically¶
Start an agent from within another agent or workflow.
Example requests:
- "Run the daily check agent"
- "Start the invoice agent with customer ID 123"
With inputs:
Some agents accept input parameters. Pass them as JSON:
Use Cases¶
After Editing Agents¶
When you create or modify an agent using the Agent Builder:
- Changes are saved to files
- DeskAgent needs to restart to load them
- Use
restart_deskagent()to apply changes immediately
Automated Workflows¶
Chain multiple agents together:
1. Daily check agent finds invoices to process
2. Calls invoice processing agent for each one
3. Calls payment reminder agent if needed
Status Monitoring¶
Check if DeskAgent is running and which version:
- Useful for troubleshooting
- Verify updates were applied
- Check build number for support
Available Tools¶
| Tool | Description |
|---|---|
restart_deskagent() | Stop and restart DeskAgent |
get_deskagent_status() | Get version and status |
list_agents() | Show all available agents |
run_agent(name, inputs) | Start an agent |
Examples¶
Restart After Changes¶
Agent just modified: daily_check.md
Restarting DeskAgent to apply changes...
restart_deskagent()
SUCCESS: DeskAgent is restarting. The application will be available again in a few seconds.
Check Version¶
List and Run Agent¶
list_agents()
Available Agents:
- daily_check: Daily email and task check
- create_offer: Create offer from email
- check_payments: Match payments to invoices [with inputs]
run_agent("daily_check")
SUCCESS: Agent 'daily_check' started.
Task-ID: abc123...
The agent is now running in the background.
Tips¶
-
Wait for restart: After calling
restart_deskagent(), the current session ends. Open DeskAgent again after a few seconds. -
Background execution: Agents started with
run_agent()run in the background. You can continue other work. -
Input format: When passing inputs to
run_agent(), use valid JSON format.
Common Issues¶
| Problem | Solution |
|---|---|
| "Connection refused" | DeskAgent is not running |
| "Agent not found" | Check agent name spelling |
| "Invalid JSON" | Fix the inputs parameter format |
| Restart doesn't work | Check if start.bat exists |