Crear complementos de API a partir de una API existente para Microsoft 365 Copilot

Importante

Los complementos MCP y API proporcionan acciones dentro de los agentes declarativos. No son paquetes de complementos instalables independientes: solo el agente contenedor puede acceder a sus funciones y herramientas. Para obtener información sobre la relación de paquete y manifiesto de acción, consulte Complementos y acciones de agente declarativo.

Recomendación

Recomendado: Comience con las herramientas de desarrollo de Work IQ para escenarios de complemento y agente declarativo de código profesional compatibles. Consulte el inicio rápido de WIQD. Las instrucciones basadas en el kit de herramientas siguen estando disponibles para los proyectos existentes y los flujos de trabajo que las requieren. Compruebe la compatibilidad con la capacidad y la experiencia de destino antes de elegir una herramienta: WIQD no se dirige a agentes de motor personalizados.

Los complementos de API permiten que un agente declarativo llame a su API REST existente. Use el kit de herramientas de agentes de Microsoft 365 para crear un proyecto de agente con una integración de acciones de API basada en la especificación OpenAPI de la API.

Requisitos previos

Recomendación

Para obtener los mejores resultados, asegúrese de que la especificación OpenAPI sigue las directrices detalladas en Cómo hacer que un documento OpenAPI sea eficaz para ampliar Copilot.

Para seguir esta guía, descargue la API de ejemplo de Budget Tracker y configúrela para que se ejecute en su máquina de desarrollo local. Genere el ejemplo al menos una vez para generar el archivo BudgetTracker.json para la API.

Crear el complemento de agente y API

Nota

Las capturas de pantalla y las referencias a la interfaz de usuario de este artículo usan una versión de lanzamiento del Kit de herramientas de agentes de Microsoft 365. Las versiones preliminares pueden diferir de la interfaz de usuario mostrada.

La configuración del complemento API incluye:

  • La especificación OpenAPI para la API de REST.
  • Un manifiesto de complemento que hace referencia a la especificación OpenAPI incluida y describe las operaciones disponibles, el método de autenticación y los formatos de respuesta.

Incluya estos archivos en el paquete de la aplicación del agente contenedor junto con el manifiesto de la aplicación, la definición del agente y los iconos. El manifiesto del complemento de API no es en sí mismo un paquete instalable.

  1. Abra Visual Studio Code. Si el Kit de herramientas de agentes aún no está instalado, consulte Instalar Kit de herramientas de agentes para ver las instrucciones de instalación.

  2. Seleccione el icono del Kit de herramientas de agentes de Microsoft 365 en la barra de actividades izquierda.

  3. Seleccione Crear un nuevo agente o aplicación en el panel de tareas Kit de herramientas de agentes.

    Captura de pantalla de la interfaz del kit de herramientas de agentes

  4. Seleccione Agente declarativo.

  5. Seleccione Agregar una acción y, a continuación, seleccione Iniciar con un documento de descripción de OpenAPI.

  6. Seleccione Examinar y navegue hasta la ubicación de la especificación OpenAPI del ejemplo de seguimiento de presupuestos, ubicada en ./openapi/BudgetTracker.json.

  7. Selecciona todas las operaciones que quieres habilitar para el complemento.

    Interfaz de usuario del kit de herramientas de agentes para seleccionar las operaciones

  8. Elige una ubicación para el proyecto del agente.

  9. Escriba Budget Tracker como nombre del proyecto del agente.

Al completar estos pasos, Agents Toolkit genera el proyecto de agente y su configuración de complemento de API, y abre el proyecto en una nueva ventana de Visual Studio Code.

Nota

La clave de prueba para el intercambio de código (PKCE) está habilitada de forma predeterminada. Si el servidor de identidad no admite PKCE, deshabilítelo agregando la siguiente línea para m365agents.yml en el proyecto de agente.

isPKCEEnabled: false

Aprovisionar y transferir localmente el agente

La instalación de prueba hace que el agente contenedor y su acción de API estén disponibles para las pruebas de desarrollo. No instala el complemento API como una funcionalidad independiente. Este procedimiento no es un método de distribución general para un paquete de complementos compuesto. Para compartir y publicar rutas, consulta Elegir cómo publicar y distribuir el complemento.

  1. Abra el proyecto del agente en Visual Studio Code.

  2. Seleccione el icono del Kit de herramientas de agentes de Microsoft 365 en la barra de actividades izquierda.

  3. En el panel Cuentas , seleccione Iniciar sesión en Microsoft 365. (Si ya has iniciado sesión, continúa con el paso siguiente).

  4. Confirme que tanto la carga de aplicaciones personalizadas habilitada como el acceso de Copilot habilitado se muestran en su cuenta de Microsoft 365. Si no lo hacen, póngase en contacto con el administrador de la organización. Consulte Requisitos para las opciones de extensibilidad de Copilot para obtener más información.

  5. En el panel Ciclo de vida , seleccione Aprovisionar.

  6. Cuando se te pida que introduzcas el ID de cliente para el registro de OAuth..., introduce el ID de cliente de tu plugin.

  7. Cuando se le pida que introduzca el secreto de cliente para el registro de OAuth..., introduzca el secreto de cliente del complemento.

  8. Lee el mensaje en el cuadro de diálogo y selecciona Confirmar para continuar.

  9. Espere a que el kit de herramientas informe de que se ha terminado de aprovisionar.

    El mensaje del kit de herramientas de agentes confirmando el aprovisionamiento correcto

El agente ya está disponible para probarlo con su cuenta de usuario en Microsoft 365 Copilot en Microsoft Teams.

Probar la acción de API del agente

  1. Abra Teams en el explorador e inicie sesión con la cuenta de Microsoft 365 que usó para transferir localmente el agente.

  2. Seleccione Chat en la barra de actividades de la izquierda.

  3. Seleccione Copilot en el panel de chat.

  4. Selecciona Seguimiento de presupuesto en la lista Agentes en el lado derecho. Si la lista no está disponible, seleccione el icono de chats de Copilot y más en la esquina superior derecha.

    Captura de pantalla de la lista de agentes en Microsoft Teams

  5. Haz una pregunta sobre los presupuestos. Por ejemplo, prueba How much is left in the Fourth Coffee lobby renovation budget?. Cuando se le solicite, elija Permitir siempre o Permitir una vez para continuar.

  6. Cuando se le pida que inicie sesión, seleccione Iniciar sesión en el seguimiento de presupuesto.