Kit de ferramentas de integração de API e Code Assist usando o MCP

Receba inteligência contextual sobre a API Merchant do assistente de programação da sua escolha. No ambiente de desenvolvimento integrado (IDE), agora é possível acessar a integração da documentação do desenvolvedor usando o serviço do Protocolo de Contexto de Modelo (MCP). Esse serviço acelera o desenvolvimento de fluxos de trabalho de integração e migração, fornecendo ao assistente de programação um contexto confiável da documentação oficial da API do Google.

Para mais informações sobre o protocolo, consulte o padrão do protocolo de contexto do modelo.

Visão geral

Ao migrar da API Content for Shopping para a API Merchant ou criar uma nova integração, é necessário entender novas estruturas de serviço, nomes de recursos e métodos. O serviço MCP simplifica isso fornecendo documentação oficial e exemplos de código ao seu assistente de programação.

O serviço usa um back-end de geração aumentada de recuperação (RAG) altamente especializado. Quando você faz uma pergunta sobre a API Merchant para o assistente de programação do seu ambiente de desenvolvimento integrado (IDE) ativado para MCP, o serviço recupera os snippets de texto e código mais relevantes dos recursos oficiais do Google e os retorna como contexto para o assistente de programação. Assim, o assistente pode fornecer respostas precisas e atualizadas sem que você precise sair do ambiente de desenvolvimento.

Como funciona

A integração da documentação do desenvolvedor usando o MCP se integra a um fluxo de trabalho de desenvolvimento moderno e assistido por IA:

  1. Você faz uma pergunta no seu assistente de programação ou agente compatível com o MCP. Pode ser uma pergunta em linguagem natural, um pedido de exemplo de código da API Merchant ou até mesmo uma solicitação para traduzir seu código diretamente para a API Merchant.
  2. Seu assistente de programação envia uma solicitação de contexto para o endpoint do MCP.
  3. O serviço MCP pesquisa na coleção indexada de documentação, guias e exemplos de código oficiais da API Merchant para encontrar as informações mais relevantes.
  4. O serviço retorna esses snippets confiáveis como contexto para seu assistente de programação.
  5. Seu assistente de programação usa esse contexto de alta qualidade para gerar uma resposta precisa e útil à sua pergunta original ou para realizar uma tarefa de tradução de código.

Primeiros passos

Para usar o MCP, siga estas etapas:

1. Usar uma ferramenta compatível

Abra um ambiente de desenvolvimento integrado ou um assistente de programação que ofereça suporte ao protocolo de contexto de modelo com transporte HTTP transmitível.

2. Configuração do endpoint

Para conectar seu ambiente de desenvolvimento integrado ou assistente de programação ao MCP, use os detalhes do endpoint remoto fornecidos, que podem exigir que você insira o URL do serviço direto ou a definição do MCP, dependendo da configuração da sua ferramenta.

O URL do serviço é:

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

3. Adicionar instruções para o agente (opcional)

Para permitir que o agente traduza código diretamente usando o MCP, forneça a ele o Protocolo de instruções do sistema: agente MerchantIntegrator. Estas instruções orientam o agente sobre como usar corretamente o MCP para tradução de código. Dependendo da ferramenta, você pode fornecer essas instruções na configuração de instruções do sistema ou como um arquivo de contexto adicional para o agente.

Exemplos de cenários de uso

O MCP pode acelerar seu fluxo de trabalho nestes casos de uso comuns.

Cenário 1: migrar o código products.insert

Você pode pedir ao agente para migrar diretamente um código de integração da API Content for Shopping products.insert para a API Merchant.

Comando do usuário:

"Migrar o código products.insert para a API Merchant"

Ao fornecer ao seu agente Instruções do sistema: protocolo do agente MerchantIntegrator e acesso ao MCP, ele pode traduzir o código da API Content for Shopping para o código da API Merchant diretamente no seu ambiente de desenvolvimento integrado. Nesse caso, ele vai identificar productInputs.insert como a chamada equivalente e mapear os atributos do produto do formato antigo para o novo, exigido pela API Merchant. Ele também pode atualizar as importações necessárias e o arquivo de gerenciamento de dependências (por exemplo, requirements.txt, pom.xml ou package.json). Você pode instruir o agente a fazer as mudanças no local ou criar uma nova pasta.

Cenário 2: encontrar funcionalidades equivalentes

Você tem um aplicativo que usa a API Content for Shopping e precisa atualizá-lo. Você pode perguntar sobre um método legado específico para receber detalhes sobre a nova implementação e um exemplo de código relevante.

Comando do usuário:

"Qual é o equivalente da API Merchant para o método accountstatuses.get na API Content for Shopping?"

O serviço MCP fornece contexto dos guias de migração oficiais e da documentação de referência, permitindo que o assistente responda com uma resposta detalhada, incluindo o novo nome da API, accounts.issues.

Cenário 3: encontrar um exemplo de código

Você está implementando um novo recurso e precisa de um exemplo prático para seguir.

Comando do usuário:

"Mostre um exemplo de código Python para adicionar um novo serviço de frete usando a API Merchant."

O serviço MCP recupera exemplos de código relevantes dos repositórios oficiais do Google no GitHub e dos guias para desenvolvedores. Em seguida, o assistente pode apresentar um bloco de código completo e pronto para adaptação.

Cenário 4: entender os conceitos de API

Você encontra um novo conceito ou quer entender a estrutura de um recurso ou o padrão geral da API Merchant.

Comando do usuário:

"Como faço para atualizar o inventário de um produto usando a API Merchant?"

O serviço MCP retorna contexto da documentação de recursos de produtos e guias relevantes. Em seguida, o assistente pode explicar como usar o método accounts.productInputs.insert e fornecer o recurso de produto parcial que contém apenas o productId e os campos relacionados ao inventário que você precisa atualizar.

"Como autorizo as chamadas do meu aplicativo com a API Merchant?"

O serviço MCP recupera o contexto dos guias oficiais de autenticação, que abordam diferentes métodos de autorização. Em seguida, o assistente pode explicar as principais opções disponíveis, como usar uma conta de serviço para interações de servidor para servidor ou um ID do cliente OAuth 2.0 ao agir em nome de um usuário.

Cenário 5: adaptação às mudanças na API

A API Merchant apresenta novos padrões, como solicitações em lote, que são diferentes da API Content for Shopping. A API Content for Shopping usa métodos custombatch específicos, enquanto a API Merchant usa um recurso de loteamento HTTP genérico integrado.

Comando do usuário:

"Qual é a nova maneira de fazer um products.custombatch na API Merchant?"

O serviço MCP recupera o contexto de Refatorar código para solicitações simultâneas explicando que métodos custombatch dedicados não existem na API Merchant. Em vez disso, ele fornece documentação sobre o uso de agrupamento em lote HTTP com um Content-Type de multipart. Em seguida, o assistente pode explicar como criar uma única solicitação HTTP que contenha várias chamadas de API, enviada ao endpoint https://merchantapi.googleapis.com/batch/{sub-api}/v1, e fornecer um exemplo de como estruturar a solicitação de várias partes. Isso transforma uma tarefa de migração potencialmente confusa em um processo guiado.

Fontes da base de conhecimento

O serviço MCP cria a base de conhecimento exclusivamente com fontes públicas e oficiais para garantir que o contexto fornecido seja preciso e confiável. O serviço indexa todo o conteúdo do site oficial para desenvolvedores e do repositório de exemplos de código, incluindo:

Anterior
Client libraries
Avançar
Overview