AI Assistant Help

Agent Client Protocol(ACP)

AI Assistant 支持 Agent Client Protocol(ACP) ,允许您连接外部 AI 代理并直接在 AI Chat 中使用。 ACP 定义了一个标准通信接口,因此可立即添加并使用任意兼容的代理,而无需进行自定义集成。

通过 ACP 配置代理所需的内容

要通过 ACP 连接代理,您需要:

  • 兼容 ACP 的代理可执行文件 — 通常作为二进制文件从代理开发者处下载,或从其公共仓库构建。

  • ACP 配置文件 — 此文件告知 AI Assistant 代理的位置以及如何启动它。 acp.json 文件会在您 开始配置代理时自动创建。

在哪里获取代理

作为起点,您可以在 ACP 官方网站上查看可用的兼容 ACP 代理列表。 每个代理页面都会提供下载说明和必要的配置详情。

配置兼容 ACP 的代理

要添加一个可在 AI 聊天 中使用的代理,请执行以下操作:

  1. 打开 AI 聊天 工具窗口。

  2. 点击工具窗口右上角的 按钮,然后选择 配置 ACP Agent

    配置 ACP Agent

    选择该选项将在 acp.json 中创建位于 ~/.jetbrains/acp.json 的文件,并打开用于编辑,您需要在其中提供配置详情。

  3. 在配置文件中填写您的代理信息。如有需要,您可以添加多个代理。配置必须遵循以下格式: 如有需要,您可以添加多个代理。 配置必须符合以下格式:

    { "agent_servers": { "Example Agent": { "command": "/path/to/agent", "args": [ "acp" ], "env": { "API_KEY": "your-api-key-here" } } } }
    • agent_servers — 顶层对象,包含所有已配置的代理。 该对象中的每个键是代理的显示名称,将显示在 AI 聊天 中。

    • Example Agent — 用于显示和识别的代理名称。

    • command — 代理可执行文件的路径。 AI Assistant 会作为子进程启动该文件。

    • args — 启动代理时传递的命令行参数数组。

    • env — 设置给代理进程的一组环境变量。

    配置完成后,代理将在 AI 聊天 中可供选择。

    在 AI Chat 中添加的 ACP 代理
  4. 要使用代理,请输入提示并发送。

收集 ACP 日志

要收集已配置代理的日志,请点击 按钮,该按钮位于 AI 聊天 工具窗口的右上角,然后选择 获取 ACP 日志。 这将下载一个包含日志的归档文件。

配置示例

本节展示 ACP 配置文件可能的示例:

{ "agent_servers": { "Auggie": { "command": "/Users/John.Doe/.local/bin/auggie", "args": ["--acp"] }, "OpenCode": { "command": "/Users/John.Doe/.opencode/bin/opencode", "args": ["acp"] }, "Stakpak": { "command": "/Users/John.Doe/Downloads/stakpak", "args": ["acp"] } } }

故障排查

本节包含兼容 ACP 的代理的故障排除提示。

添加的代理未显示在列表中

添加到 acp.json 文件中的代理应立即在 AI 聊天 中显示。 如果代理未出现在列表中:

  • 请检查 acp.json 文件的格式是否正确。

  • 重启 IDE。

代理启动失败

如果代理启动失败,请尝试以下操作:

  • 确保提供的所有参数具有正确的值,因为不同的代理可能需要不同的密钥或实参。

  • command 参数中使用代理可执行文件的完整路径。

  • 在 Windows 下使用 WSL 时,请按如下方式调整配置:

    { "agent_servers": { "Agent": { "command": "wsl.exe", "args": ["-e", "agent path", "..."] } } }
  • 如果代理支持控制台模式,请尝试在终端中手动运行以验证其是否正常工作。

如果问题仍然存在,请执行以下操作:

  1. 收集 日志。

  2. 复制您的 acp.json 配置(复制前请移除任何敏感信息)。

  3. 截图或录制简短视频以说明问题。

  4. YouTrack 中创建问题。

  5. 将截图、日志和配置文件附加到问题中。

最后修改日期: 2025年 12月 5日