获取 AX Code · 免费文档

本页译自英文文档。命令、标识符和示例保持原样。运行时 7.24.4 · SDK 2.6.7。 英文原文

ACP(Agent Client Protocol)正常路径

状态:生效 范围:为 IDE 宿主记录的正常路径 最近审阅:2026-07-12 负责人:AX Code 运行时

AX Code 暴露一个 ACP 服务器,以便 IDE(例如 Zed)可以在没有自定义传输的情况下托管代理。

要求

  • 受支持的 CLI 安装(PATH 上的 ax-code)
  • 已配置的提供商(ax-code providers login 或环境密钥)

启动服务器

# Current directory as workspace
ax-code acp

# Explicit workspace
ax-code acp --dir /path/to/project

初始化 + 会话 + 提示(stdio)

ACP 是 stdio 上的 JSON-RPC。最小正常路径:

# One-shot style example (hosts normally keep the process open)
printf '%s\n' \
  '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":1,"clientCapabilities":{}}}' \
  | ax-code acp

典型的宿主顺序:

  1. initialize — 协商协议版本和代理能力
  2. session/new — 创建会话,并把 cwd 设为项目根
  3. session/prompt — 发送用户文本;代理运行工具并返回停止原因
  4. session/load — 恢复宿主已知的会话 id

Zed 示例

{
  "agent_servers": {
    "AX Code": {
      "command": "ax-code",
      "args": ["acp"]
    }
  }
}

目前可用的能力

能力 状态
initialize / capabilities 已支持
session/new 已支持
session/prompt 已支持(会话在响应之前完成)
session/load 对会话 id 与模式恢复已支持
客户端文件读/写 已支持
流式 session/update 部分 / 不是完整的渐进流
完整终端桥接 占位

细节与限制:packages/ax-code/src/acp/README.md。

可选的交互式提问

AX_CODE_ENABLE_QUESTION_TOOL=1 ax-code acp

只有当宿主界面能够回答提问提示时才启用。