Skip to main content

Servidor ACP de la CLI de Copilot

Obtenga información sobre el servidor del protocolo de cliente de agente de CLI de GitHub Copilot.

Nota:

La compatibilidad con ACP en CLI de GitHub Copilot está en versión preliminar pública y sujeta a cambios.

Información general

El Protocolo de cliente del agente (ACP) es un protocolo que normaliza la comunicación entre clientes (como editores de código e IDE) y agentes de codificación (como CLI de Copilot). Para obtener más información sobre este protocolo, consulte la introducción oficial.

Casos de uso

  •         **Integraciones del IDE:** Incorpora el soporte de Copilot en cualquier entorno de desarrollo o editor.
    
  •           **Canalizaciones de CI/CD:** orqueste tareas de codificación de agente en flujos de trabajo automatizados.
    
  •         **Portales personalizados:** Cree interfaces especializadas para los flujos de trabajo específicos de los desarrolladores.
    
  •         **Sistemas multiagente:** Coordinar Copilot con otros agentes de IA mediante un protocolo estándar.
    

Iniciar el servidor ACP

CLI de GitHub Copilot se puede iniciar como un servidor ACP mediante la marca --acp. El servidor admite dos modos, stdio y TCP.

De forma predeterminada, al proporcionar la bandera --acp, se inferirá el modo stdio. También se puede proporcionar la --stdio marca para la desambiguación.

copilot --acp --stdio

Modo TCP

Si la --port marca se proporciona en combinación con la --acp marca , el servidor se inicia en modo TCP.

copilot --acp --port 3000

Integración con el servidor ACP

Hay un ecosistema creciente de bibliotecas para interactuar mediante programación con los servidores ACP. Dado CLI de GitHub Copilot está instalado y autenticado correctamente, en el ejemplo siguiente se muestra el uso del cliente typescript para enviar un mensaje único e imprimir la respuesta de IA.

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;
});

Lectura adicional

  •         [Documentación oficial de ACP](https://agentclientprotocol.com/protocol/overview)