Skip to content

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:

  1. Current instance shuts down gracefully
  2. New instance starts automatically
  3. 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:

run_agent("create_offer", '{"customer_id": "12345"}')

Use Cases

After Editing Agents

When you create or modify an agent using the Agent Builder:

  1. Changes are saved to files
  2. DeskAgent needs to restart to load them
  3. 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

get_deskagent_status()

DeskAgent Status:
- Version: 0.7.0
- Build: 5
- Status: Running

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

  1. Wait for restart: After calling restart_deskagent(), the current session ends. Open DeskAgent again after a few seconds.

  2. Background execution: Agents started with run_agent() run in the background. You can continue other work.

  3. 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