Kit d'outils d'intégration d'API et d'assistance au codage utilisant MCP

Obtenez des informations contextuelles sur l'API Merchant auprès de l'assistant de programmation de votre choix. Dans votre environnement de développement intégré (IDE), vous pouvez désormais accéder à l'intégration de la documentation pour les développeurs à l'aide du service MCP (Model Context Protocol). Ce service accélère votre développement pour les workflows d'intégration et de migration en fournissant à votre assistant de codage un contexte faisant autorité à partir de la documentation officielle des API Google.

Pour en savoir plus sur le protocole lui-même, consultez la norme du protocole de contexte de modèle.

Présentation

Lorsque vous migrez de Content API for Shopping vers Merchant API ou que vous créez une intégration, vous devez comprendre les nouvelles structures de service, les noms de ressources et les méthodes. Le service MCP simplifie ce processus en fournissant une documentation officielle et des exemples de code à votre assistant de codage.

Le service utilise un backend de génération augmentée par récupération (RAG) hautement spécialisé. Lorsque vous posez une question sur l'API Merchant à votre assistant de codage IDE compatible avec MCP, le service récupère les extraits de texte et de code les plus pertinents des ressources officielles de Google et les renvoie en tant que contexte à votre assistant de codage. Votre assistant peut ainsi vous fournir des réponses précises et à jour sans que vous ayez à quitter votre environnement de développement.

Fonctionnement

L'intégration de la documentation pour les développeurs à l'aide de MCP s'inscrit dans un workflow de développement moderne assisté par l'IA :

  1. Vous posez une question dans votre assistant de programmation ou agent compatible avec MCP. Il peut s'agir d'une question en langage naturel, d'une demande d'exemple de code de l'API Merchant ou même d'une demande de traduction directe de votre code vers l'API Merchant.
  2. Votre assistant de codage envoie une demande de contexte au point de terminaison MCP.
  3. Le service MCP recherche les informations les plus pertinentes dans sa collection indexée de documentation, de guides et d'exemples de code officiels de l'API Merchant.
  4. Le service renvoie ces extraits faisant autorité comme contexte à votre assistant de programmation.
  5. Votre assistant de codage utilise ce contexte de haute qualité pour générer une réponse précise et utile à votre question initiale ou pour effectuer une tâche de traduction de code.

Premiers pas

Pour utiliser MCP, procédez comme suit :

1. Utiliser un outil compatible

Ouvrez un IDE ou un assistant de codage compatible avec le protocole de contexte de modèle avec transport HTTP en flux.

2. Configuration du point de terminaison

Pour connecter votre IDE ou votre assistant de programmation à MCP, utilisez les informations de point de terminaison distant fournies. Vous devrez peut-être saisir l'URL directe du service ou la définition MCP (selon la configuration de votre outil).

L'URL du service est la suivante :

MCP Server Name: "MAPI Docs MCP"
MCP Server URL:  "https://merchantapi.googleapis.com/devdocs/mcp/"
MCP Server Protocol: "http"

3. Ajouter des instructions pour l'agent (facultatif)

Pour permettre à votre agent de traduire directement du code à l'aide de MCP, fournissez-lui le protocole d'instructions système pour l'agent MerchantIntegrator. Ces instructions expliquent à l'agent comment utiliser correctement MCP pour la traduction de code. Selon l'outil, vous pouvez fournir ces instructions dans la configuration des instructions système ou sous forme de fichier de contexte supplémentaire pour l'agent.

Exemples de scénarios d'utilisation

MCP peut accélérer votre workflow dans les cas d'utilisation courants suivants.

Scénario 1 : Migrer le code products.insert

Vous pouvez demander à l'agent de migrer directement un code d'intégration Content API for Shoppingproducts.insert vers Merchant API.

Requête de l'utilisateur :

"Migrer le code products.insert vers l'API Merchant"

En fournissant à votre agent les instructions système : protocole de l'agent MerchantIntegrator et l'accès à MCP, votre agent peut traduire le code Content API for Shopping en code Merchant API directement dans votre IDE. Dans ce cas, il identifiera productInputs.insert comme l'appel équivalent et mappera les attributs du produit de l'ancien format vers le nouveau format requis par l'API Merchant. Il peut également mettre à jour les importations requises et le fichier de gestion des dépendances (par exemple, requirements.txt, pom.xml ou package.json). Vous pouvez demander à l'agent d'effectuer les modifications sur place ou de créer un dossier.

Scénario 2 : Trouver une fonctionnalité équivalente

Vous disposez d'une application existante qui utilise Content API for Shopping et vous devez la mettre à jour. Vous pouvez poser des questions sur une ancienne méthode spécifique pour obtenir des détails sur la nouvelle implémentation et un exemple de code pertinent.

Requête de l'utilisateur :

"Quel est l'équivalent Merchant API de la méthode accountstatuses.get dans Content API for Shopping ?"

Le service MCP fournit le contexte des guides de migration officiels et de la documentation de référence, ce qui permet à votre assistant de répondre de manière détaillée, y compris avec le nouveau nom d'API, accounts.issues.

Scénario 3 : Trouver un exemple de code

Vous implémentez une nouvelle fonctionnalité et avez besoin d'un exemple pratique à suivre.

Requête de l'utilisateur :

"Montre-moi un exemple de code Python pour ajouter un service de livraison à l'aide de l'API Merchant."

Le service MCP récupère des exemples de code pertinents à partir des dépôts GitHub et des guides pour les développeurs officiels de Google. Votre assistant peut ensuite présenter un bloc de code complet et prêt à être adapté.

Scénario 4 : Comprendre les concepts de l'API

Vous découvrez un nouveau concept ou vous souhaitez comprendre la structure d'une ressource ou le modèle global de l'API Merchant.

Requête de l'utilisateur :

"Comment mettre à jour l'inventaire d'un produit à l'aide de l'API Merchant ?"

Le service MCP renvoie le contexte à partir de la documentation sur les ressources des produits et des guides pertinents. Votre assistant peut ensuite vous expliquer comment utiliser la méthode accounts.productInputs.insert et vous fournir la ressource produit partielle contenant uniquement les champs productId et ceux liés à l'inventaire que vous devez mettre à jour.

"Comment autoriser les appels de mon application avec l'API Merchant ?"

Le service MCP récupère le contexte des guides d'authentification officiels, qui couvrent différentes méthodes d'autorisation. Votre assistant peut ensuite expliquer les principales options disponibles, comme l'utilisation d'un compte de service pour les interactions de serveur à serveur ou d'un ID client OAuth 2.0 lorsque vous agissez au nom d'un utilisateur.

Scénario 5 : S'adapter aux modifications de l'API

La Merchant API introduit de nouveaux modèles, tels que le traitement par lot des requêtes, qui diffèrent de Content API for Shopping. Content API for Shopping utilise des méthodes custombatch spécifiques, tandis que l'API Merchant utilise une fonctionnalité de traitement par lot HTTP générique intégrée.

Requête de l'utilisateur :

"Quelle est la nouvelle façon d'effectuer un products.custombatch dans l'API Merchant ?"

Le service MCP récupère le contexte à partir de Refactor code for concurrent requests (Refactoriser le code pour les requêtes simultanées), qui explique que les méthodes custombatch dédiées n'existent pas dans l'API Merchant. Au lieu de cela, il fournit de la documentation sur l'utilisation du traitement par lot HTTP avec un Content-Type de multipart. Votre assistant peut ensuite vous expliquer comment construire une seule requête HTTP contenant plusieurs appels d'API, envoyée au point de terminaison https://merchantapi.googleapis.com/batch/{sub-api}/v1, et vous fournir un exemple de structure de la requête multipartie. Cela transforme une tâche de migration potentiellement déroutante en un processus guidé.

Scénario 6 : Traduire une requête de rapport

Vous pouvez demander à l'agent de traduire une requête de rapport de l'API Content pour Shopping en requête de l'API Merchant.

Requête de l'utilisateur :

"Migrate this reporting query from Content API to Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Le service MCP récupère la documentation de référence la plus récente sur les rapports, les guides pour les développeurs et les guides de migration. Sur la base de ces informations, il transforme la requête en nouvelle structure et met à jour les champs avec leurs nouveaux noms et valeurs.

Sources de la base de connaissances

Le service MCP constitue sa base de connaissances exclusivement à partir de sources publiques et officielles pour s'assurer que le contexte qu'il fournit est précis et fiable. Le service indexe l'intégralité du contenu du site officiel des développeurs et du dépôt d'exemples de code, y compris :

Précédent
Client libraries
Suivant
Overview