Skip to content

Custom Agents Setup

You can use any agent that implements the Agent Client Protocol (ACP).

Install and Configure

  1. Install your ACP-compatible agent (e.g., OpenCode, Qwen Code, Kiro).

  2. Find the installation path by running the following command in your terminal (Terminal on macOS/Linux, PowerShell on Windows):

bash
which your-agent
# Example output: /usr/local/bin/your-agent
cmd
where.exe your-agent
# Example output: C:\Users\Username\AppData\Roaming\npm\your-agent.cmd
  1. Open Settings → Agent Client and scroll to Custom Agents section.

  2. Click Add custom agent.

  3. 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=VALUE pairs, one per line (if required)

Configuration Examples

OpenCode

FieldValue
Agent IDopencode
Display nameOpenCode
Path/usr/local/bin/opencode
Argumentsacp
Environment variables(optional)

Qwen Code

FieldValue
Agent IDqwen-code
Display nameQwen Code
Path/usr/local/bin/qwen
Arguments--experimental-acp
Environment variables(optional)

Kiro

FieldValue
Agent IDkiro-cli
Display nameKiro
Path/path/to/home/.local/bin/kiro-cli
Argumentsacp
Environment variables(optional)

TIP

Replace /path/to/home with your home directory (e.g., /Users/john on macOS, /home/john on Linux). $HOME and ~ may not be supported.

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

  1. Click the robot icon in the ribbon or use the command palette: "Open agent chat"
  2. Select your custom agent from the agent dropdown in the chat header
  3. Try sending a message to verify the connection

Having issues? See Troubleshooting.

Released under the Apache 2.0 License.