Alibaba Cloud Model Studio:Plugins personnalisés

Créer un plugin personnalisé

Étape 1 : Créer un plugin

1. Accédez à la page Plugins et cliquez sur Create Plugin.

2. Saisissez les informations du plugin.

   Plug-in Name : Saisissez un nom descriptif. Le chinois et l'anglais sont pris en charge. Exemple : Outil de test de requête d'accord de dortoir

   Plug-in Description : Décrivez brièvement les fonctionnalités et l'objectif du plugin en langage naturel. Cette description aide le modèle à décider quand utiliser le plugin. Exemple : Interroge le contenu d'une entrée d'accord de dortoir spécifique en fonction de l'index numérique saisi.

   Plug-in URL : Endpoint d'accès du plugin. Exemple :https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run Model Studio traite les différents chemins sous un même domaine comme des API distinctes. Ces chemins correspondent au Tool Path configuré lors de la création d'un outil. Les outils d'un même plugin partagent un nom de domaine, mais le chemin de chaque outil correspond à une API unique. Par exemple, un plugin contient deux API : Requête : https://xxx.com/query Suppression : https://xxx.com/delete Dans cet exemple, https://xxx.com est l'Plug-in URL, tandis que /query et /delete sont les valeurs de Tool Path. Cela indique que le plugin contient deux outils.

   Si une authentification est requise, activez le commutateur Enable Authentication et saisissez les paramètres d'authentification.

   Paramètres d'authentification

   Headers (Facultatif)	Si une authentification est nécessaire, vous pouvez transmettre les informations d'authentification dans un en-tête personnalisé.
   Enable Authentication (Facultatif)	Détermine si une application doit fournir une authentification pour appeler votre plugin personnalisé. Cela dépend de la politique de sécurité de votre fournisseur d'API.
   Authentication Type	Il existe deux méthodes d'authentification : l'authentification au niveau du service et l'authentification au niveau de l'utilisateur. Location : Vous pouvez placer les informations d'authentification dans l'en-tête de la requête ou dans la chaîne de requête (query string). Header : Cette option place les informations d'authentification dans l'en-tête Authorization de la requête HTTP, les masquant ainsi dans l'URL. Query : Cette option place les informations d'authentification dans l'URL. Par exemple : https://example.com?api_key=123456. Parameter Name : Si vous placez les informations d'authentification dans la chaîne de requête, spécifiez le nom du paramètre utilisé pour l'authentification, par exemple api_key. Si vous les placez dans l'en-tête, le paramètre est Authorization par défaut. Type : basic : N'ajoute aucun préfixe au jeton fourni. bearer : Ajoute le préfixe Bearer au jeton. appcode : Ajoute le préfixe APPCODE au jeton. Le préfixe est inclus dans le champ d'authentification. Par exemple, si vous sélectionnez bearer, l'en-tête Authorization devient Authorization: Bearer <YOUR_TOKEN>. Token (pour l'authentification au niveau du service) : Jeton d'authentification fourni par le fournisseur d'API, tel qu'une clé API.

3. Une fois le formulaire rempli, cliquez sur Confirm Create Plug-in > Create Tool ou sur Continue to Add Tool.

Étape 2 : Créer un outil

1. Saisissez les informations de l'outil, configurez les paramètres d'entrée et de sortie, puis définissez les paramètres avancés éventuels.

   Dans cet exemple, saisissez « Outil de requête des règles de dortoir » pour Tool Name et « Interroge le contenu d'une règle de dortoir spécifique en fonction de l'index numérique saisi » pour Tool Description. Définissez le Tool Path sur /article, sélectionnez POST pour Request Method, et choisissez application/json pour Submission Method. Pour le paramètre d'entrée, définissez le nom du paramètre sur article_index, la description du paramètre sur « index », et le type sur Number. Ce paramètre est transmis dans le Body, il est obligatoire, et sa méthode de transmission est LLM recognition. Pour le paramètre de sortie, définissez le nom du paramètre sur article, la description du paramètre sur « contenu de la règle de dortoir », et le type sur String. Dans les paramètres avancés, la requête de saisie utilisateur est « Interroger le contenu de la règle de dortoir correspondante en fonction de la valeur d'index saisie », et la valeur du paramètre d'entrée article_index est 5.

   Paramètres de l'outil

   Informations sur l'outil

   Tool Name	Saisissez un nom descriptif. Le chinois et l'anglais sont pris en charge.
   Tool Description	Brève description des fonctionnalités et des cas d'utilisation de l'outil. Cela aide le modèle à décider quand appeler l'outil. Utilisez un langage naturel et fournissez des exemples si possible.
   Tool Path	Chemin relatif vers l'Plug-in URL. Le chemin doit commencer par une barre oblique (/). Le système ajoute ce chemin à l'Plug-in URL pour construire l'URL complète de la requête.
   Request Method	Sélectionnez GET ou POST comme méthode de requête pour appeler l'API.
   Submission Method	Type d'encodage du corps de la requête. application/json : Le contenu du corps est constitué de données au format JSON. application/x-www-form-urlencoded : Encode les données de formulaire sous forme de paires clé-valeur. Cette méthode d'encodage s'applique aux requêtes POST. Elle encode les données de formulaire en paires clé-valeur, sépare les paires par des esperluettes (&) et les clés des valeurs par des signes égal (=). Les données sont ensuite encodées en URL, ce qui convertit les caractères spéciaux en un signe pourcentage (%) suivi de deux chiffres hexadécimaux. Par exemple, un espace est encodé sous la forme %20, & sous la forme %26, et = sous la forme %3D. Exemple : name=John Doe&age=25 est encodé sous la forme name=John%20Doe&age=25.

   Configurer les paramètres d'entrée et de sortie

   Configure Input Parameters	Cliquez sur Add Input Parameter pour configurer les paramètres.
   	Parameter Name : Utilisez un nom descriptif pour aider le modèle à comprendre ce que représente le paramètre. Par exemple, city.
   	Parameter Description : Description concise et précise de la fonction du paramètre d'entrée. Cela aide le modèle à mieux comprendre comment récupérer la valeur du paramètre. Par exemple, pour un paramètre nommé date, vous pouvez le décrire comme une date et également spécifier son format, tel que yyyy-MM-dd.
   	Type : Type de données du paramètre. ImportantLes sous-propriétés d'un type Object ne peuvent pas être vides. Cliquez sur l'icône à la fin de la ligne de l'objet pour ajouter une sous-propriété.
   	Passing Method : Définit la manière dont la valeur du paramètre est transmise. Ce réglage est essentiel pour assurer un fonctionnement correct. LLM Recognition : Le modèle extrait la valeur du paramètre à partir de la saisie de l'utilisateur. Business Pass-through : Le système transmet la valeur du paramètre directement depuis une source externe, sans traitement ni modification. Lorsque vous appelez une application à l'aide du SDK DashScope ou d'une API HTTP, le système transmet les paramètres d'entrée de type business pass-through à l'application via biz_params et user_defined_params. Pour plus d'informations, consultez Transmettre des paramètres à une application.
   Configure Output Parameters	Cliquez sur Add Output Parameters et configurez les paramètres. Tous les paramètres sont obligatoires. Le modèle utilise les définitions des paramètres de sortie pour filtrer et restructurer la réponse de l'API en fonction de la requête de l'utilisateur, puis renvoie la réponse finale. Comme pour les paramètres d'entrée, les paramètres de sortie doivent être décrits de manière concise et précise, avec un minimum d'imbrication. ImportantLes méthodes de requête GET et POST prennent toutes deux en charge le type Object pour les paramètres. Cependant, les sous-propriétés d'un type Object ne peuvent pas être vides. Cliquez sur l'icône à la fin de la ligne de l'objet pour ajouter une sous-propriété.

   Configuration avancée (Facultatif)

   Advanced Configuration	Fournissez des exemples d'appel pour aider le modèle à éviter les oublis ou les appels d'outils incorrects. Si les paramètres d'entrée sont complexes et que le modèle risque de les construire incorrectement, fournir des exemples améliore la précision des appels.
   	Value : Spécifie les paramètres d'invocation que vous attendez que le modèle génère à partir de la requête d'un utilisateur. Par exemple, pour la saisie utilisateur « Quel temps fait-il à Hangzhou demain ? », les paramètres attendus sont {"city": "Hangzhou", "date": "2025-04-25"}.

2. Une fois la configuration terminée, cliquez sur Save Draft.

3. Déboguez l'outil en ligne pour vérifier que l'API peut être appelée.

   Cliquez sur Test Tool. Si vous avez activé l'authentification, saisissez les informations d'authentification et les valeurs des paramètres d'entrée. Cliquez ensuite sur Start Running. Si l'exécution échoue, ajustez la configuration en fonction du message d'erreur dans la section Run Result et testez à nouveau jusqu'à ce que l'exécution réussisse. Vous pouvez saisir les valeurs des paramètres d'entrée manuellement ou sous forme de code. Pour les paramètres complexes, utilisez Code Editing. Dans l'éditeur de code, vous pouvez soumettre les paramètres d'entrée complets au format JSON ainsi que leurs valeurs correspondantes.

4. Une fois le test réussi, cliquez sur Publish. Les applications ne peuvent appeler que les outils ayant le statut Published.

Console

• Méthode 1 : Publiez le plugin en tant que service MCP, puis ajoutez le service à une application agent.

  Étape 1 : Publier le plugin en tant que service MCP

  1. Sur la page Plugins, passez la souris sur la carte du plugin cible et cliquez sur Publish as MCP Service.

     Si le plugin a déjà été converti en service MCP, le bouton devient View MCP Service . Cliquez dessus pour accéder à la page de gestion MCP et consulter les détails du service.

  2. Après une publication réussie, vous pouvez consulter les détails du service MCP sur la page MCP Management, y compris le nom du service, sa description et son ID.

  Étape 2 : Ajouter le service MCP à une application agent

  1. Accédez au canevas d'orchestration de l'application Agent Application. Dans le bloc MCP, cliquez sur +.

  2. Dans le panneau Select MCP Service, basculez vers l'onglet Custom MCPS, recherchez le service MCP converti à partir du plugin, et cliquez sur Add All pour l'ajouter à l'application.

     Vous pouvez également cliquer sur Convert from Plugin to MCP pour publier directement un plugin qui n'a pas encore été converti.

  3. Testez si le plugin fonctionne comme prévu.

     • Sans authentification : Discutez avec le modèle dans la zone de saisie pour tester la fonctionnalité du plugin.
     • Avec user-level authentication ou service-level authentication : Avant de commencer une conversation, cliquez sur pour configurer le jeton d'authentification. Vous n'avez besoin de configurer le jeton qu'une seule fois par session sur cette page.
     • Si la Passing Method pour un paramètre d'entrée d'outil est définie sur Business Pass-through, vous devez cliquer sur pour configurer la valeur de la variable avant de commencer une conversation. Vous n'avez besoin de saisir la valeur qu'une seule fois par session sur cette page.

  4. Une fois le test terminé, cliquez sur Publish pour publier l'application.

• Méthode 2 : Sur la page Application Management, accédez au canevas d'orchestration de votre application Agent Application, ajoutez le service MCP depuis le bloc MCP, testez sa fonctionnalité, puis cliquez sur Publish pour publier l'application.

API

L'ID de l'outil identifie un outil spécifique. Lorsque vous appelez un outil via une API, vous devez transmettre l'ID correct pour garantir que le système identifie correctement la requête.

1. Dans la liste Plugins, recherchez le plugin contenant l'outil et cliquez sur View Details.
2. Passez le pointeur sur l'icône à côté du nom de l'outil.
3. Cliquez sur l'icône pour copier l'ID de l'outil.

• Lorsque vous appelez une application à l'aide d'une API, si le plugin de l'application utilise des paramètres de type business pass-through ou nécessite une User-level Authentication, vous devez utiliser le paramètre biz_params pour transmettre les informations d'authentification ou les informations de paramètre transparent. Pour plus d'informations, consultez Référence API DashScope pour les workflows et les applications Agent héritées.