Inicio rápido para extensiones de GitHub Copilot usando agentes

Compila y prueba la extensión Blackbeard de GitHub para conocer el proceso de desarrollo de GitHub Copilot Extensions.

En este artículo

La extensión Blackbeard es una GitHub Copilot Extension creada con un agente simple que responde a solicitudes como un pirata, usando la API del modelo de lenguaje grande (LLM) de Copilot e indicaciones del sistema especiales. En esta guía se usa una implementación de agente simple, pero el proceso es similar para los conjuntos de aptitudes.

Este inicio rápido está diseñado para ayudarte a compilar y chatear con la extensión Blackbeard lo más rápido posible, para que puedas desarrollarla y probarla sin implementar la infraestructura. En producción, deberás hospedar la aplicación para los puntos de conexión del agente o del conjunto de aptitudes en un servidor accesible públicamente. Para obtener información sobre cómo crear una nueva GitHub Copilot Extension, consulta Configuración de extensiones de Copilot.

1. Creación e instalación de una GitHub App

En la configuración del desarrollador de la cuenta de GitHub, crea una GitHub App. Tu GitHub App debe tener:

  • Un nombre
  • Una dirección URL de la página principal
  • Webhooks sin seleccionar

Después de crear la aplicación, haz clic en Install App en la barra lateral y, a continuación, instala la aplicación en tu cuenta.

Para obtener instrucciones detalladas, consulta Creación de una aplicación de GitHub para la extensión de Copilot.

2. Clonación y hospedaje del agente de Blackbeard localmente

En lugar de implementar el agente Blackbeard como una aplicación web, puedes hospedar el agente localmente para acelerar considerablemente el proceso de compilación.

  1. Con el terminal integrado en VS Code, clona el repositorio copilot-extensions/blackbeard-extension.
  2. En el mismo terminal, ejecuta npm install para instalar las dependencias necesarias y, a continuación, ejecuta npm start para iniciar el agente Blackbeard en el puerto 3000.
  3. En la pestaña "Ports" del panel de VS Code, haz clic en Forward a port o Add port y, a continuación, agrega el puerto 3000.
  4. Haz clic con el botón derecho en el puerto, establece la visibilidad en "Public" y, a continuación, copia la dirección local.

3. Integración y prueba de la extensión Blackbeard

Después de configurar la GitHub App y el agente Blackbeard, puedes integrar el agente con la aplicación y probar la extensión Blackbeard. Debes realizar los siguientes cambios en la configuración de la GitHub App:

  • En la configuración "General", en el campo "Callback URL", pega la dirección local del agente.
  • En la configuración de "Permissions & events", concede permisos de solo lectura a Copilot Chat.
  • En la configuración de "Copilot", establece el tipo de aplicación en "Agent" y rellena los campos restantes.

Después de actualizar la configuración de GitHub App, puedes empezar a chatear con la extensión; para ello, escribe @YOUR-EXTENSION-NAME en la ventana Copilot Chat y, a continuación, envía una indicación de la manera habitual.

Para obtener instrucciones más detalladas, consulta Configuración de la aplicación de GitHub para el agente de Copilot.

2. Clonación y hospedaje del agente Blackbeard en un espacio de código

En lugar de implementar el agente Blackbeard como una aplicación web, puedes hospedarlo en un codespace para acelerar considerablemente el proceso de compilación.

  1. Ve al repositorio copilot-extensions/blackbeard-extension. Selecciona el menú desplegable Code y, a continuación, haz clic en Create codespace on main.
  2. Para buscar el nuevo codespace, selecciona el menú desplegable ** Code** . Junto al nuevo codespace, selecciona y, a continuación, haz clic en Open in Browser.
  3. En el terminal integrado, ejecuta npm start para iniciar el agente Blackbeard en el puerto 3000.
  4. En la pestaña "Ports" del panel VS Code, haz clic en Forward a port y, a continuación, agrega el puerto 3000.
  5. Haz clic con el botón derecho en el puerto, establece la visibilidad en "Public" y, a continuación, copia la dirección local.

3. Integración y prueba de la extensión Blackbeard

Después de configurar la GitHub App y el agente Blackbeard, puedes integrar el agente con la aplicación y probar la extensión Blackbeard. Debes realizar los siguientes cambios en la configuración de la GitHub App:

  • En la configuración "General", en el campo "Callback URL", pega la dirección reenviada del agente.
  • En la configuración de "Permissions & events", concede permisos de solo lectura a Copilot Chat.
  • En la configuración de "Copilot", establece el tipo de aplicación en "Agent" y rellena los campos restantes.

Después de actualizar la configuración de la GitHub App, puedes empezar a chatear con la extensión; para ello escribe @YOUR-EXTENSION-NAME en la ventana Copilot Chat de un cliente o IDE compatibles y, a continuación, envía una indicación de la manera habitual. Para obtener una lista de clientes e IDE admitidos, consulta Acerca de la compilación de Copilot Extensions.

Note

No se admite chatear con GitHub Copilot Extensions en GitHub Codespaces.

Para obtener instrucciones más detalladas, consulta Configuración de la aplicación de GitHub para el agente de Copilot.

2. Clonación e inicio del agente Blackbeard localmente

En lugar de implementar el agente Blackbeard como una aplicación web, puedes hospedar el agente localmente para acelerar considerablemente el proceso de compilación.

  1. Usando la aplicación de línea de comandos, clona el repositorio copilot-extensions/blackbeard-extension.
  2. Ejecuta npm install para instalar las dependencias necesarias y, a continuación, ejecuta npm start para iniciar el agente Blackbeard en el puerto 3000.

3. Exposición del servidor local

Para que se pueda acceder al agente Blackbeard desde la plataforma Copilot y GitHub, debes exponer el servidor local para que sea accesible mediante solicitudes HTTP. Para ello, puedes usar cualquier servicio de reenvío de puertos o tunelización. En los pasos siguientes, usaremos ngrok.

  1. Ve a la página de descarga de ngrok y, acontinuación, instala la versión de ngrok adecuada para tu sistema operativo.

  2. Ve a la página de instalación y configuración de ngrok y, a continuación, inicia sesión o regístrate para obtener una cuenta de ngrok.

  3. Para exponer el servidor local, en una nueva ventana de la aplicación de línea de comandos, ejecuta el siguiente comando:

    Shell
    ngrok http http://localhost:3000

  4. En la aplicación de línea de comandos, junto a "Forwarding", copia la dirección URL que ngrok asignó al servidor.

4. Integración y prueba de la extensión Blackbeard

Para integrar GitHub App con el agente Blackbeard, debes realizar los siguientes cambios en la configuración de la aplicación:

  • En la configuración "General", en el campo "Callback URL", pega la dirección URL del servidor expuesto.
  • En la configuración de "Permissions & events", concede permisos de solo lectura a Copilot Chat.
  • En la configuración de "Copilot", establece el tipo de aplicación en "Agent" y rellena los campos restantes.

Después de actualizar la configuración de GitHub App, puedes empezar a chatear con la extensión; para ello, escribe @YOUR-EXTENSION-NAME en la ventana Copilot Chat y, a continuación, envía una indicación de la manera habitual.

Para obtener instrucciones más detalladas, consulta Configuración de la aplicación de GitHub para el agente de Copilot.

Pasos siguientes

Ahora que tienes una GitHub Copilot Extension en funcionamiento, puedes intentar compilarla en el agente Blackbeard para experimentar con el desarrollo del agente.

Para obtener información sobre las implementaciones de agentes más complejas, también puedes revisar los siguientes agentes de ejemplo y el kit de desarrollo de software (SDK), todos los cuales están disponibles en la organización copilot-extensions:

  • GitHub Models: un agente más complejo que le permite preguntar e interactuar con varios LLM enumerados en GitHub Marketplace a través de Copilot Chat. El agente de GitHub Models usa la llamada a funciones.
  • Llamada a funciones: un agente de ejemplo escrito en Go que muestra la llamada de función y los cuadros de diálogo de confirmación.
  • Extensión de RAG: un agente de ejemplo escrito en Go que muestra una implementación sencilla de la generación aumentada de recuperación.
  • SDK de versión preliminar: un SDK que simplifica el desarrollo de Copilot Extensions mediante el control automático de la comprobación de solicitudes, el análisis de carga y el formato de respuesta. Este SDK permite a los generadores de extensiones centrarse más en la creación de funciones básicas y menos en código reutilizable.