代理客户端协议 (ACP)

通过代理客户端协议 (ACP) 暴露深度代理，以集成到代码编辑器和 IDE 中。

代理客户端协议 (ACP) 标准化了编码代理与代码编辑器或 IDE 之间的通信。 通过 ACP 协议，您可以在任何兼容 ACP 的客户端中使用您的自定义深度代理，使您的代码编辑器能够提供项目上下文并接收丰富的更新。

ACP 专为代理-编辑器集成而设计。如果您希望您的代理调用由外部服务器托管的工具，请参阅 模型上下文协议 (MCP)。

快速开始

安装 ACP 集成包：

npm

npm install deepagents-acp

然后通过 ACP 暴露一个深度代理。

这将在 stdio 模式下启动一个 ACP 服务器（它从 stdin 读取请求并将响应写入 stdout）。实际上，您通常将其作为由 ACP 客户端（例如您的编辑器）启动的命令运行，然后通过 stdio 与服务器通信。

import { startServer } from "deepagents-acp";

await startServer({
  agents: {
    name: "coding-assistant",
    description: "具有文件系统访问权限的 AI 编码助手",
  },
  workspaceRoot: process.cwd(),
});

您也可以在不编写任何代码的情况下使用 CLI：

npx deepagents-acp

DeepAgents ACP on npm

deepagents-acp 包提供了 CLI 和编程 API，用于通过 ACP 暴露深度代理。

客户端

深度代理可以在任何可以运行 ACP 代理服务器的地方工作。一些值得注意的 ACP 客户端包括：

• Zed
• JetBrains IDE
• Visual Studio Code (通过 vscode-acp)
• Neovim (通过 ACP 兼容插件)

Zed

通过将您的深度代理添加到 Zed 设置（Linux 上为 ~/.config/zed/settings.json，macOS 上为 ~/Library/Application Support/Zed/settings.json）来将其注册到 Zed：

简单设置（无需代码）：

{
  "agent": {
    "profiles": {
      "deepagents": {
        "name": "DeepAgents",
        "command": "npx",
        "args": ["deepagents-acp"],
        "env": {
          "ANTHROPIC_API_KEY": "sk-ant-..."
        }
      }
    }
  }
}

使用 CLI 选项：

{
  "agent": {
    "profiles": {
      "deepagents": {
        "name": "DeepAgents",
        "command": "npx",
        "args": [
          "deepagents-acp",
          "--name", "my-assistant",
          "--skills", "./skills",
          "--debug"
        ],
        "env": {
          "ANTHROPIC_API_KEY": "sk-ant-..."
        }
      }
    }
  }
}

自定义服务器脚本：

为了获得更多控制，创建一个 TypeScript 服务器脚本：

// server.ts
import { startServer } from "deepagents-acp";

await startServer({
  agents: {
    name: "my-agent",
    description: "我的自定义编码代理",
    skills: ["./skills/"],
  },
});

然后将 Zed 指向它：

{
  "agent": {
    "profiles": {
      "my-agent": {
        "name": "My Agent",
        "command": "npx",
        "args": ["tsx", "./server.ts"]
      }
    }
  }
}

打开 Zed 的代理面板并启动一个 DeepAgents 会话。

ACP 注册表

DeepAgents 可在 ACP 代理注册表 中找到，用于在 Zed 和 JetBrains IDE 中一键安装。当 ACP 客户端支持注册表时，用户无需任何手动配置即可发现并安装深度代理。

CLI 参考

CLI 是启动 ACP 服务器最快的方式。它不需要任何代码——只需运行 npx deepagents-acp 并连接您的编辑器。

npx deepagents-acp [选项]

选项	简写	描述
--name <名称>	-n	代理名称 (默认: "deepagents")
--description <描述>	-d	代理描述
--model <模型>	-m	LLM 模型 (默认: "claude-sonnet-4-5-20250929")
--workspace <路径>	-w	工作区根目录 (默认: 当前工作目录)
--skills <路径>	-s	逗号分隔的技能路径
--memory <路径>		逗号分隔的 AGENTS.md 路径
--debug		启用调试日志输出到 stderr
--help	-h	显示帮助信息
--version	-v	显示版本

环境变量

变量	描述
ANTHROPIC_API_KEY	Anthropic/Claude 模型的 API 密钥 (必需)
OPENAI_API_KEY	OpenAI 模型的 API 密钥
DEBUG	设置为 "true" 以启用调试日志
WORKSPACE_ROOT	--workspace 标志的替代方案

编程 API

startServer

方便的函数，用于一次性创建并启动服务器：

import { startServer } from "deepagents-acp";

const server = await startServer({
  agents: {
    name: "coding-assistant",
    description: "具有文件系统访问权限的 AI 编码助手",
  },
  workspaceRoot: process.cwd(),
});

DeepAgentsServer

为了获得完全控制，直接使用 DeepAgentsServer 类：

import { DeepAgentsServer } from "deepagents-acp";

const server = new DeepAgentsServer({
  agents: [
    {
      name: "code-agent",
      description: "功能齐全的编码助手",
      model: "claude-sonnet-4-5-20250929",
      skills: ["./skills/"],
      memory: ["./.deepagents/AGENTS.md"],
    },
    {
      name: "reviewer",
      description: "代码审查专家",
      systemPrompt: "您是一个代码审查专家...",
    },
  ],
  serverName: "my-deepagents-acp",
  serverVersion: "1.0.0",
  workspaceRoot: process.cwd(),
  debug: true,
});

await server.start();

服务器选项

选项	类型	默认值	描述
agents	DeepAgentConfig | DeepAgentConfig[]	必需	代理配置（一个或多个）
serverName	string	"deepagents-acp"	用于 ACP 的服务器名称
serverVersion	string	"0.0.1"	服务器版本
workspaceRoot	string	process.cwd()	工作区根目录
debug	boolean	false	启用调试日志

代理配置

选项	类型	描述
name	string	唯一的代理名称 (必需)
description	string	代理描述
model	string	LLM 模型 (默认: "claude-sonnet-4-5-20250929")
tools	StructuredTool[]	自定义 LangChain 工具
systemPrompt	string	自定义系统提示
middleware	AgentMiddleware[]	自定义中间件
backend	BackendProtocol | BackendFactory	文件系统后端
skills	string[]	技能源路径
memory	string[]	记忆源路径 (AGENTS.md)
interruptOn	Record<string, boolean | InterruptOnConfig>	需要用户批准的工具 (HITL)
commands	Array<{ name, description, input? }>	自定义斜杠命令

自定义

多个代理

您可以从单个服务器暴露多个代理。ACP 客户端在创建会话时选择使用哪个代理：

const server = new DeepAgentsServer({
  agents: [
    { name: "code-agent", description: "通用编码" },
    { name: "reviewer", description: "代码审查" },
  ],
});

一些 ACP 客户端（如 Zed）目前没有提供用于在代理之间选择的 UI。在这种情况下，请考虑运行单独的服务器实例，每个实例只包含一个代理。

斜杠命令

服务器向 IDE 注册了内置的斜杠命令：/plan、/agent、/ask、/clear 和 /status。您还可以为每个代理定义自定义命令：

const server = new DeepAgentsServer({
  agents: {
    name: "my-agent",
    commands: [
      { name: "test", description: "运行项目的测试套件" },
      { name: "lint", description: "运行 linter 并修复问题" },
      {
        name: "deploy",
        description: "部署到暂存环境",
        input: { hint: "环境 (staging 或 production)" },
      },
    ],
  },
});

人在回路

使用 interruptOn 要求用户在 IDE 中批准，然后代理才能运行敏感工具：

const server = new DeepAgentsServer({
  agents: {
    name: "careful-agent",
    interruptOn: {
      execute: { allowedDecisions: ["approve", "edit", "reject"] },
      write_file: true,
    },
  },
});

当代理调用受保护的工具时，IDE 会提示用户允许或拒绝该操作，并提供记住该会话决策的选项。

自定义工具

import { DeepAgentsServer } from "deepagents-acp";
import { tool } from "@langchain/core/tools";
import { z } from "zod";

const searchTool = tool(
  async ({ query }) => {
    return `结果查询: ${query}`;
  },
  {
    name: "search",
    description: "搜索代码库",
    schema: z.object({ query: z.string() }),
  },
);

const server = new DeepAgentsServer({
  agents: {
    name: "search-agent",
    tools: [searchTool],
  },
});

await server.start();

自定义后端

import { DeepAgentsServer } from "deepagents-acp";
import { CompositeBackend, FilesystemBackend, StateBackend } from "deepagents";

const server = new DeepAgentsServer({
  agents: {
    name: "custom-agent",
    backend: new CompositeBackend({
      routes: [
        {
          prefix: "/workspace",
          backend: new FilesystemBackend({ rootDir: "./workspace" }),
        },
        { prefix: "/", backend: (config) => new StateBackend(config) },
      ],
    }),
  },
});

await server.start();

技能与记忆

import { startServer } from "deepagents-acp";

await startServer({
  agents: {
    name: "project-agent",
    description: "具有项目特定知识的代理",
    skills: ["./skills/", "~/.deepagents/skills/"],
    memory: ["./.deepagents/AGENTS.md"],
  },
  workspaceRoot: process.cwd(),
});

有关协议详情和编辑器支持，请参阅上游 ACP 文档：

• 介绍: https://agentclientprotocol.com/get-started/introduction
• 客户端/编辑器: https://agentclientprotocol.com/get-started/clients

---

Edit this page on GitHub or file an issue.

Connect these docs to Claude, VSCode, and more via MCP for real-time answers.