Skip to main content

Сервер ACP Copilot CLI

Learn about GitHub Copilot CLI's Agent Client Protocol server.

Примечание.

Поддержка ACP в GitHub Copilot CLI находится в public preview и может измениться.

Обзор

Протокол агента-клиента (ACP) — это протокол, который стандартизирует коммуникацию между клиентами (такими как редакторы кода и IDE) и кодовыми агентами (например, Интерфейс командной строки Copilot). Для получения дополнительной информации об этом протоколе см. официальное введение.

Запуск сервера ACP

GitHub Copilot CLI можно запустить как ACP-сервер с помощью --acp флага. Сервер поддерживает два режима stdio , и TCP.

По умолчанию при введении --acp флага stdio будет подразумеваться режим. --stdio Флаг также может быть предоставлен для уточнения.

copilot --acp --stdio

Режим TCP

Если --port флаг предоставлен в сочетании с флагом --acp , сервер запускается в режиме TCP.

copilot --acp --port 3000

Интеграция с сервером ACP

Существует растущая экосистема библиотек для программного взаимодействия с серверами ACP. Если GitHub Copilot CLI правильно установлены и аутентифицированы, следующий пример демонстрирует использование клиента typescript для отправки одного запроса и печати ответа ИИ.

import * as acp from "@agentclientprotocol/sdk";
import { spawn } from "node:child_process";
import { Readable, Writable } from "node:stream";

async function main() {
  const executable = process.env.COPILOT_CLI_PATH ?? "copilot";

  // ACP uses standard input/output (stdin/stdout) for transport; we pipe these for the NDJSON stream.
  const copilotProcess = spawn(executable, ["--acp", "--stdio"], {
    stdio: ["pipe", "pipe", "inherit"],
  });

  if (!copilotProcess.stdin || !copilotProcess.stdout) {
    throw new Error("Failed to start Copilot ACP process with piped stdio.");
  }

  // Create ACP streams (NDJSON over stdio)
  const output = Writable.toWeb(copilotProcess.stdin) as WritableStream<Uint8Array>;
  const input = Readable.toWeb(copilotProcess.stdout) as ReadableStream<Uint8Array>;
  const stream = acp.ndJsonStream(output, input);

  const client: acp.Client = {
    async requestPermission(params) {
      // This example should not trigger tool calls; if it does, refuse.
      return { outcome: { outcome: "cancelled" } };
    },

    async sessionUpdate(params) {
      const update = params.update;

      if (update.sessionUpdate === "agent_message_chunk" && update.content.type === "text") {
        process.stdout.write(update.content.text);
      }
    },
  };

  const connection = new acp.ClientSideConnection((_agent) => client, stream);

  await connection.initialize({
    protocolVersion: acp.PROTOCOL_VERSION,
    clientCapabilities: {},
  });

  const sessionResult = await connection.newSession({
    cwd: process.cwd(),
    mcpServers: [],
  });

  process.stdout.write("Session started!\n");
  const promptText = "Hello ACP Server!";
  process.stdout.write(`Sending prompt: '${promptText}'\n`);

  const promptResult = await connection.prompt({
    sessionId: sessionResult.sessionId,
    prompt: [{ type: "text", text: promptText }],
  });

  process.stdout.write("\n");

  if (promptResult.stopReason !== "end_turn") {
    process.stderr.write(`Prompt finished with stopReason=${promptResult.stopReason}\n`);
  }

  // Best-effort cleanup
  copilotProcess.stdin.end();
  copilotProcess.kill("SIGTERM");
  await new Promise<void>((resolve) => {
    copilotProcess.once("exit", () => resolve());
    setTimeout(() => resolve(), 2000);
  });
}

main().catch((error) => {
  console.error(error);
  process.exitCode = 1;
});

Дополнительные материалы

  •         [Официальная документация ACP](https://agentclientprotocol.com/protocol/overview)