Custom Agents Setup
You can use any agent that implements the Agent Client Protocol (ACP).
Install and Configure
bash
which your-agent
# Example output: /usr/local/bin/your-agentcmd
where.exe your-agent
# Example output: C:\Users\Username\AppData\Roaming\npm\your-agent.cmdOpen Settings → Agent Client and scroll to Custom Agents section.
Click Add custom agent.
Configure the agent:
- Agent ID: Unique identifier (e.g.,
my-agent) - Display name: Name shown in menus (e.g.,
My Agent) - Path: Absolute path to the agent executable
- Arguments: Command-line arguments, one per line (if required)
- Environment variables:
KEY=VALUEpairs, one per line (if required)
- Agent ID: Unique identifier (e.g.,
Authentication
Authentication depends on the specific agent. Common patterns:
- API Key: Add to Environment variables (e.g.,
MY_API_KEY=xxx) - Account Login: Run the agent's CLI to authenticate, then leave environment variables empty
Refer to your agent's documentation for specific authentication instructions.
Verify Setup
- Click the robot icon in the ribbon or use the command palette: "Open agent chat"
- Select your custom agent from the agent dropdown in the chat header
- Try sending a message to verify the connection
Having issues? See Troubleshooting.