Déboguer les plug-ins MCP et API localement

Conseil

Recommandé : Commencez avec les outils de développement Work IQ pour les scénarios de plug-in et d’agent déclaratif pro-code pris en charge. Voir le guide de démarrage rapide de WIQD. Les instructions basées sur la boîte à outils restent disponibles pour les projets existants et les flux de travail qui les nécessitent. Vérifiez la prise en charge de la capacité et de l’expérience cible avant de choisir un outil : WIQD ne cible pas les agents de moteur personnalisés.

Les plug-ins permettent aux agents déclaratifs dans Microsoft 365 Copilot d’appeler des serveurs MCP (Model Context Protocol) ou des API REST pour récupérer des données et effectuer des tâches. Microsoft 365 Copilot doit accéder au MCP ou au serveur d’API via Internet. En règle générale, les outils de débogage hébergent les sessions de débogage sur localhost (127.0.0.1), qui est accessible uniquement à partir de la machine exécutant l’outil de débogage. En utilisant un proxy inverse, tel que les tunnels dev, vous pouvez exposer votre session de débogage sur Internet pour activer les appels de débogage à partir de Microsoft 365 Copilot.

Cet article vous montre comment utiliser l’outil pour activer le devtunnel débogage local pour votre serveur MCP ou API.

Remarque

Vos outils de débogage peuvent déjà fournir une solution de proxy inverse. Nous vous recommandons de consulter la documentation relative à vos outils de développement pour confirmer. Par exemple, si vous avez créé une API à l’aide de Microsoft 365 Agents Toolkit, le kit de ressources gère la configuration du proxy inverse pour vous.

Configuration requise

  • CLI devtunnelinstallée sur la machine où vous hébergez vos sessions de débogage
  • Le numéro de port HTTP utilisé par votre outil de débogage

Créer un tunnel de développement persistant

L’interface devtunnel de ligne de commande vous permet de créer un tunnel de développement persistant, un tunnel que vous pouvez arrêter et démarrer en fonction des besoins, sans modification de l’URL hébergée. L’utilisation d’un tunnel avec une URL persistante simplifie le débogage des plug-ins, car vous n’avez pas besoin de mettre à jour vos packages d’application d’agent déclaratif avec de nouvelles URL.

  1. Si vous n’êtes pas déjà connecté à l’interface de ligne de commande devtunnel, utilisez devtunnel user login --help pour voir les options disponibles. Connectez-vous à l’interface de ligne de commande avant de poursuivre.

  2. Créez le tunnel, en autorisant l’accès anonyme. L’accès anonyme est nécessaire pour permettre à Microsoft 365 Copilot d’accéder à votre tunnel et n’est pas lié à une authentification requise par votre API.

    devtunnel create --allow-anonymous
    

    Conseil

    La création d’un nouveau tunnel fait basculer votre tunnel par défaut vers le tunnel nouvellement créé. Cela vous permet d’omettre l’argument dans les tunnel-id commandes suivantes. Si vous créez plusieurs tunnels, vous devrez peut-être utiliser l’argument tunnel-id pour vous assurer que vous utilisez le tunnel attendu. Pour plus d’informations, utilisez la commande ou consultez Référence devtunnel --helpde ligne de commande des tunnels de développement.

  3. Ajoutez le numéro de port HTTP utilisé par votre outil de débogage. Remplacez <port> par votre numéro de port et définissez le --protocol paramètre si https votre outil de débogage utilise HTTPS sur le port ou http s’il n’utilise pas HTTPS.

    devtunnel port create --port-number <port> --protocol https
    
  4. Démarrez le tunnel de développement.

    devtunnel host
    
  5. Pour la première fois que vous exécutez ce tunnel de développement, copiez l’URL intitulée Se connecter via un navigateur. Ouvrez cette URL dans votre navigateur, puis sélectionnez Continuer pour activer le tunnel.

    Remarque

    Après avoir sélectionné Continuer, votre navigateur affiche une erreur. Ceci est prévu et peut être ignoré.

Une fois le tunnel activé, vous pouvez l’arrêter avec CTRL + C. Vous pouvez redémarrer le tunnel à l’aide de la devtunnel host host-id commande.

Utilisation du tunnel de développement

Pour utiliser votre tunnel de développement pour le débogage, chargez une version test d’un package d’application avec l’URL du tunnel de développement à la place de l’URL du serveur.

Définissez la url propriété de l’objet spec du serveur MCP dans le manifeste de votre plug-in.

"runtimes": [
  {
    "type": "RemoteMCPServer",
    "spec": {
      "url": "<your-dev-tunnel-url>",
    }
  }
]

Si vous utilisez Agents Toolkit dans Visual Studio Code pour gérer votre agent déclaratif, vous pouvez ajouter une variable d’environnement au fichier /env/.env.dev.user nommé PLUGIN_SERVER_URL et l’utiliser à la place de l’URL de votre tunnel de développement. Utilisez l’étape Provision (Provision) dans le volet Lifecycle (Cycle de vie ) pour charger un test de votre agent. Dans votre fichier /env/.env.dev.user , ajoutez :

OPENAPI_SERVER_URL=<your-dev-tunnel-url>

Dans le manifeste de votre plug-in, mettez à jour la url propriété :

"runtimes": [
  {
    "type": "RemoteMCPServer",
    "spec": {
      "url": "${{PLUGIN_SERVER_URL}}",
    }
  }
]

Si vous n’utilisez pas Agents Toolkit, vous pouvez générer un nouveau fichier ZIP de package d’application et télécharger votre agent.