Integracja interfejsu API i zestaw narzędzi Code Assist przy użyciu MCP

Uzyskaj kontekstowe informacje o Merchant API od wybranego asystenta do kodowania. W zintegrowanym środowisku programistycznym (IDE) możesz teraz uzyskać dostęp do integracji dokumentacji dla programistów za pomocą usługi Model Context Protocol (MCP). Ta usługa przyspiesza proces programowania w przypadku integracji i migracji, ponieważ zapewnia asystentowi kodowania wiarygodny kontekst z oficjalnej dokumentacji interfejsów API Google.

Więcej informacji o tym protokole znajdziesz w standardzie Model Context Protocol.

Przegląd

Podczas migracji z Content API for Shopping do Merchant API lub tworzenia nowej integracji musisz poznać nowe struktury usług, nazwy zasobów i metody. Usługa MCP upraszcza ten proces, udostępniając oficjalną dokumentację i przykłady kodu asystentowi programowania.

Usługa korzysta z wysoce wyspecjalizowanego backendu Retrieval-Augmented Generation (RAG). Gdy zapytasz asystenta kodowania w IDE z włączoną platformą MCP o Merchant API, usługa pobierze najbardziej odpowiednie fragmenty tekstu i kodu z oficjalnych zasobów Google i zwróci je jako kontekst dla asystenta kodowania. Dzięki temu asystent może udzielać dokładnych i aktualnych odpowiedzi bez konieczności opuszczania środowiska programistycznego.

Jak to działa

Integracja dokumentacji dla programistów za pomocą MCP jest zintegrowana z nowoczesnym przepływem pracy wspomaganym przez AI:

  1. Zadasz pytanie w asystencie do kodowania lub agencie zgodnym z MCP. Może to być pytanie w języku naturalnym, prośba o przykładowy kod interfejsu Merchant API lub nawet prośba o bezpośrednie przetłumaczenie kodu na interfejs Merchant API.
  2. Asystent do kodowania wysyła żądanie kontekstu do punktu końcowego MCP.
  3. Usługa MCP przeszukuje zaindeksowaną kolekcję oficjalnej dokumentacji Merchant API, przewodników i przykładowych kodów, aby znaleźć najbardziej odpowiednie informacje.
  4. Usługa zwraca te autorytatywne fragmenty kodu jako kontekst dla asystenta kodowania.
  5. Twój asystent do kodowania używa tego kontekstu wysokiej jakości, aby wygenerować precyzyjną i przydatną odpowiedź na Twoje pierwotne pytanie lub wykonać zadanie tłumaczenia kodu.

Pierwsze kroki

Aby korzystać z MCP, wykonaj te czynności:

1. Korzystanie ze zgodnego narzędzia

Otwórz IDE lub asystenta kodowania, który obsługuje protokół kontekstu modelu z przesyłaniem strumieniowym HTTP.

2. Konfiguracja punktów końcowych

Aby połączyć IDE lub asystenta kodowania z MCP, użyj podanych szczegółów zdalnego punktu końcowego, które mogą wymagać wpisania bezpośredniego adresu URL usługi lub definicji MCP (w zależności od konfiguracji narzędzia).

Adres URL usługi to:

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

3. Dodawanie instrukcji dla agenta (opcjonalnie)

Aby umożliwić agentowi bezpośrednie tłumaczenie kodu za pomocą MCP, podaj mu instrukcje systemowe: MerchantIntegrator Agent Protocol. Te instrukcje pomagają agentowi prawidłowo korzystać z MCP do tłumaczenia kodu. W zależności od narzędzia możesz podać te instrukcje w konfiguracji instrukcji systemowych lub jako dodatkowy plik kontekstu dla agenta.

Przykładowe scenariusze użycia

MCP może przyspieszyć Twój proces pracy w tych typowych przypadkach użycia.

Scenariusz 1. Przenoszenie kodu products.insert

Możesz poprosić agenta o bezpośrednie przeniesienie kodu integracji Content API for Shopping products.insert do Merchant API.

Prośba użytkownika:

„Przenieś kod products.insert do interfejsu Merchant API”

Jeśli udostępnisz agentowi instrukcje systemowe: MerchantIntegrator Agent Protocol i dostęp do MCP, będzie on mógł tłumaczyć kod Content API for Shopping na kod Merchant API bezpośrednio w środowisku IDE. W tym przypadku zidentyfikuje wywołanie productInputs.insert jako równoważne i zmapuje atrybuty produktu z formatu starego na nowy, wymagany przez interfejs Merchant API. Może też aktualizować wymagane importy i plik zarządzania zależnościami (np. requirements.txt, pom.xml lub package.json). Możesz polecić agentowi wprowadzenie zmian w miejscu lub utworzenie nowego folderu.

Scenariusz 2. Znajdowanie równoważnej funkcji

Masz aplikację, która korzysta z interfejsu Content API for Shopping i musisz ją zaktualizować. Możesz zapytać o konkretną starszą metodę, aby uzyskać szczegółowe informacje o nowej implementacji i odpowiedni przykładowy kod.

Prośba użytkownika:

„Jaki jest odpowiednik metody accountstatuses.get w Content API for Shopping w Merchant API?”

Usługa MCP udostępnia kontekst z oficjalnych przewodników migracji i dokumentacji referencyjnej, dzięki czemu asystent może udzielać szczegółowych odpowiedzi, w tym podawać nową nazwę interfejsu API, accounts.issues.

Scenariusz 3. Znajdowanie przykładowego kodu

Wdrażasz nową funkcję i potrzebujesz praktycznego przykładu.

Prośba użytkownika:

„Pokaż mi przykładowy kod w Pythonie, który umożliwia dodanie nowej usługi dostawy za pomocą interfejsu Merchant API”.

Usługa MCP pobiera odpowiednie przykłady kodu z oficjalnych repozytoriów Google GitHub i przewodników dla deweloperów. Asystent może wtedy przedstawić kompletny blok kodu gotowy do dostosowania.

Scenariusz 4. Zrozumienie koncepcji interfejsu API

Natrafisz na nowe pojęcie lub chcesz poznać strukturę zasobu albo ogólny wzorzec interfejsu Merchant API.

Prośba użytkownika:

„Jak zaktualizować asortyment produktu za pomocą interfejsu Merchant API?”

Usługa MCP zwraca kontekst z dokumentacji zasobu produktów i odpowiednich przewodników. Asystent może wtedy wyjaśnić, jak używać metody accounts.productInputs.insert, i podać częściowy zasób produktu zawierający tylko pole productId oraz pola związane z asortymentem, które musisz zaktualizować.

„Jak autoryzować wywołania aplikacji za pomocą interfejsu Merchant API?”

Usługa MCP pobiera kontekst z oficjalnych przewodników uwierzytelniania, które obejmują różne metody autoryzacji. Asystent może wtedy wyjaśnić główne dostępne opcje, takie jak używanie konta usługi do interakcji między serwerami lub identyfikatora klienta OAuth 2.0 podczas działania w imieniu użytkownika.

Scenariusz 5. Dostosowywanie się do zmian w interfejsie API

Interfejs Merchant API wprowadza nowe wzorce, takie jak grupowanie żądań, które różnią się od Content API for Shopping. Content API for Shopping korzysta z określonych metod, a Merchant API używa wbudowanej, ogólnej funkcji przesyłania żądań zbiorczych HTTP.custombatch

Prośba użytkownika:

„Jaki jest nowy sposób na wykonanie wywołania products.custombatch w interfejsie Merchant API?”.

Usługa MCP pobiera kontekst z artykułu Refactor code for concurrent requests (Przebudowa kodu pod kątem jednoczesnych żądań), w którym wyjaśniono, że w interfejsie Merchant API nie ma dedykowanych custombatch metod. Zamiast tego zawiera dokumentację dotyczącą używania przetwarzania wsadowego HTTP z wartością Content-Type parametru multipart. Asystent może wtedy wyjaśnić, jak utworzyć jedno żądanie HTTP zawierające wiele wywołań interfejsu API, które jest wysyłane do punktu końcowego https://merchantapi.googleapis.com/batch/{sub-api}/v1, i podać przykład struktury żądania wieloczęściowego. Dzięki temu potencjalnie skomplikowane zadanie migracji staje się procesem z instrukcjami.

Scenariusz 6. Tłumaczenie zapytania o raport

Możesz poprosić agenta o przetłumaczenie zapytania dotyczącego raportowania z Content API for Shopping na Merchant API.

Prośba użytkownika:

„Przenieś to zapytanie raportowania z Content API do Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'”

Usługa MCP pobiera najnowszą dokumentację referencyjną raportowania, przewodniki dla programistów i przewodniki migracji. Na podstawie tych informacji przekształca zapytanie w nową strukturę i aktualizuje pola, nadając im nowe nazwy i wartości.

Źródła bazy wiedzy

Usługa MCP buduje swoją bazę wiedzy wyłącznie na podstawie publicznych i oficjalnych źródeł, aby zapewnić dokładność i wiarygodność kontekstu. Usługa indeksuje całą zawartość oficjalnej witryny dla deweloperów i repozytorium przykładowego kodu, w tym:

Wstecz
Client libraries
Dalej
Overview