Kit di strumenti per l'integrazione di API e Assistente codice utilizzando MCP

Ricevi informazioni contestuali sull'API Merchant dall'assistente alla codifica che preferisci. All'interno dell'ambiente di sviluppo integrato (IDE), ora puoi accedere all'integrazione della documentazione per gli sviluppatori utilizzando il servizio Model Context Protocol (MCP). Questo servizio accelera lo sviluppo per i workflow di integrazione e migrazione fornendo all'assistente alla codifica un contesto autorevole tratto dalla documentazione ufficiale delle API di Google.

Per ulteriori informazioni sul protocollo, consulta lo standard Model Context Protocol.

Panoramica

Quando esegui la migrazione dall'API Content for Shopping all'API Merchant o crei una nuova integrazione, devi comprendere le nuove strutture dei servizi, i nomi delle risorse e i metodi. Il servizio MCP semplifica questa operazione fornendo documentazione ufficiale ed esempi di codice all'assistente alla programmazione.

Il servizio utilizza un backend di Retrieval-Augmented Generation (RAG) altamente specializzato. Quando poni una domanda all'assistente alla programmazione dell'IDE abilitato per MCP sull'API Merchant, il servizio recupera gli snippet di testo e codice più pertinenti dalle risorse ufficiali di Google e li restituisce come contesto all'assistente alla programmazione. In questo modo, l'assistente può fornire risposte accurate e aggiornate senza che tu debba mai uscire dall'ambiente di sviluppo.

Come funziona

L'integrazione della documentazione per sviluppatori tramite MCP si integra in un flusso di lavoro di sviluppo moderno e assistito dall'AI:

  1. Poni una domanda nell'assistente alla codifica o nell'agente compatibile con MCP. Può trattarsi di una domanda in linguaggio naturale, di una richiesta di un esempio di codice dell'API Merchant o anche di una richiesta di traduzione diretta del codice nell'API Merchant.
  2. L'assistente alla programmazione invia una richiesta di contesto all'endpoint MCP.
  3. Il servizio MCP esegue ricerche nella raccolta indicizzata di documentazione, guide ed esempi di codice ufficiali dell'API Merchant per trovare le informazioni più pertinenti.
  4. Il servizio restituisce questi snippet autorevoli come contesto per l'assistente alla codifica.
  5. L'assistente alla programmazione utilizza questo contesto di alta qualità per generare una risposta precisa e utile alla tua domanda originale o per eseguire un'attività di traduzione del codice.

Per iniziare

Per utilizzare MCP:

1. Utilizzare uno strumento compatibile

Apri un IDE o un assistente alla codifica che supporti il Model Context Protocol con il trasporto HTTP in streaming.

2. Configurazione endpoint

Per connettere l'IDE o l'assistente per la programmazione a MCP, utilizza i dettagli dell'endpoint remoto forniti, che potrebbero richiedere l'inserimento dell'URL del servizio diretto o della definizione MCP (a seconda della configurazione dello strumento).

L'URL del servizio è:

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

3. (Facoltativo) Aggiungi istruzioni per l'agente

Per consentire all'agente di tradurre direttamente il codice utilizzando MCP, fornisci le istruzioni di sistema: protocollo dell'agente MerchantIntegrator. Queste istruzioni guidano l'agente su come utilizzare correttamente MCP per la traduzione del codice. A seconda dello strumento, puoi fornire queste istruzioni nella configurazione delle istruzioni di sistema o come file di contesto aggiuntivo per l'agente.

Scenari di utilizzo di esempio

MCP può accelerare il tuo workflow in questi casi d'uso comuni.

Scenario 1: esegui la migrazione del codice products.insert

Puoi chiedere all'agente di eseguire direttamente la migrazione di un codice di integrazione dell'API Content for Shopping products.insert all'API Merchant.

Prompt dell'utente:

"Esegui la migrazione del codice products.insert all'API Merchant"

Fornendo al tuo agente le istruzioni di sistema: protocollo dell'agente MerchantIntegrator e l'accesso a MCP, il tuo agente può tradurre il codice dell'API Content for Shopping nel codice dell'API Merchant direttamente nel tuo IDE. In questo caso, identificherà productInputs.insert come chiamata equivalente e mapperà gli attributi di prodotto dal vecchio formato al nuovo formato richiesto dall'API Merchant. Può anche aggiornare le importazioni richieste e il file di gestione delle dipendenze (ad esempio requirements.txt, pom.xml o package.json). Puoi chiedere all'agente di apportare le modifiche sul posto o di creare una nuova cartella.

Scenario 2: trova funzionalità equivalenti

Hai un'applicazione esistente che utilizza l'API Content for Shopping e devi aggiornarla. Puoi chiedere informazioni su un metodo legacy specifico per ottenere dettagli sulla nuova implementazione e un esempio di codice pertinente.

Prompt dell'utente:

"Qual è l'equivalente dell'API Merchant per il metodo accountstatuses.get nell'API Content for Shopping?"

Il servizio MCP fornisce il contesto delle guide alla migrazione ufficiali e della documentazione di riferimento, consentendo all'assistente di rispondere con una risposta dettagliata, incluso il nuovo nome dell'API, accounts.issues.

Scenario 3: trovare un esempio di codice

Stai implementando una nuova funzionalità e hai bisogno di un esempio pratico da seguire.

Prompt dell'utente:

"Mostrami un esempio di codice Python per aggiungere un nuovo servizio di spedizione utilizzando l'API Merchant."

Il servizio MCP recupera esempi di codice pertinenti dai repository GitHub ufficiali di Google e dalle guide per sviluppatori. L'assistente può quindi presentare un blocco di codice completo e pronto per essere adattato.

Scenario 4: comprendere i concetti delle API

Ti imbatti in un nuovo concetto o vuoi comprendere la struttura di una risorsa o il pattern generale dell'API Merchant.

Prompt dell'utente:

"Come faccio ad aggiornare l'inventario di un prodotto utilizzando l'API Merchant?"

Il servizio MCP restituisce il contesto dalla documentazione della risorsa prodotti e dalle guide pertinenti. L'assistente potrà quindi spiegarti come utilizzare il metodo accounts.productInputs.insert e fornirti la risorsa prodotto parziale contenente solo productId e i campi correlati all'inventario che devi aggiornare.

"Come faccio ad autorizzare le chiamate della mia applicazione con l'API Merchant?"

Il servizio MCP recupera il contesto dalle guide di autenticazione ufficiali, che coprono diversi metodi di autorizzazione. L'assistente può quindi spiegare le opzioni principali disponibili, ad esempio l'utilizzo di un service account per le interazioni server-to-server o di un ID client OAuth 2.0 quando agisce per conto di un utente.

Scenario 5: adattamento alle modifiche dell'API

L'API Merchant introduce nuovi pattern, come le richieste batch, diversi dall'API Content for Shopping. Content API for Shopping utilizza metodi custombatch specifici, mentre l'API Merchant utilizza una funzionalità di batching HTTP generica e integrata.

Prompt dell'utente:

"Qual è il nuovo modo di eseguire un'operazione products.custombatch nell'API Merchant?"

Il servizio MCP recupera il contesto da Refactor code for concurrent requests spiegando che i metodi custombatch dedicati non esistono nell'API Merchant. Fornisce invece la documentazione sull'utilizzo del batch HTTP con un Content-Type di multipart. L'assistente può quindi spiegare come creare una singola richiesta HTTP contenente più chiamate API, inviata all'endpoint https://merchantapi.googleapis.com/batch/{sub-api}/v1 e fornire un esempio di come strutturare la richiesta in più parti. In questo modo, un'attività di migrazione potenzialmente confusa si trasforma in un processo guidato.

Scenario 6: traduci una query per i report

Puoi chiedere all'agente di tradurre una query di generazione di report dall'API Content for Shopping all'API Merchant.

Prompt dell'utente:

"Esegui la migrazione di questa query di reporting dall'API Content all'API Merchant: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Il servizio MCP recupera la documentazione di riferimento più recente per i report, le guide per gli sviluppatori e le guide alla migrazione. In base a queste informazioni, trasforma la query nella nuova struttura e aggiorna i campi con i nuovi nomi e valori.

Fonti della knowledge base

Il servizio MCP crea la sua knowledge base esclusivamente da fonti pubbliche e ufficiali per garantire che il contesto che fornisce sia accurato e affidabile. Il servizio indicizza l'intero contenuto del sito ufficiale per sviluppatori e del repository di esempi di codice, tra cui:

Indietro
Client libraries
Avanti
Overview