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

Receba informações contextuais sobre a API Merchant do assistente de programação de sua preferência. No ambiente de desenvolvimento integrado (IDE, na sigla em inglês), agora é possível acessar a integração da documentação para desenvolvedores usando o serviço do Protocolo de Contexto de Modelo (MCP, na sigla em inglês). 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 Google.

Para mais informações sobre o protocolo, consulte o padrão do Protocolo de Contexto de Modelo.

Visão geral

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

O serviço usa um back-end de geração aumentada de recuperação (RAG, na sigla em inglês) altamente especializado. Quando você faz uma pergunta sobre a API Merchant ao assistente de programação do 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. Isso permite que o assistente forneça respostas precisas e atualizadas sem que você precise sair do ambiente de desenvolvimento.

Como funciona

A integração da documentação para desenvolvedores usando o MCP é integrada a um fluxo de trabalho de desenvolvimento moderno com tecnologia de IA:

  1. Você faz uma pergunta no assistente de programação ou agente compatível com MCP. Pode ser uma pergunta em linguagem natural, uma solicitação de um exemplo de código da API Merchant ou até mesmo uma solicitação para traduzir seu código diretamente para a API Merchant.
  2. O assistente de programação envia uma solicitação de contexto para o endpoint do MCP.
  3. O serviço MCP pesquisa a 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 o assistente de programação.
  5. O 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 IDE ou 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 o IDE ou o 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 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"

Configurações:

Antigravity

Siga as instruções na documentários do Antigravity.

{
    "mcpServers": {
        "mapi-devdocs": {
            "command": "npx",
            "args": [
                "-y",
                "mcp-remote",
                "https://merchantapi.googleapis.com/devdocs/mcp"
            ]
        }
    }
}

Visual Studio Code

Siga as instruções na documentação do Visual Studio Code.

{
    "servers": {
        "mapi-devdocs": {
            "type": "http",
            "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
        }
    }
}

3. Adicionar instruções do agente (opcional)

Para permitir que o agente traduza o código diretamente usando o MCP, forneça as instruções do sistema: agente MerchantIntegrator protocolo. Essas 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 nesses 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 products.insert da API Content for Shopping para a API Merchant.

Comando do usuário:

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

Ao fornecer ao agente as instruções do sistema: protocolo do agente MerchantIntegrator e acesso ao MCP, o agente pode traduzir o código da API Content for Shopping para o código da API Merchant diretamente no seu IDE. Nesse caso, ele vai identificar productInputs.insert como a chamada equivalente e mapear os atributos do produto do formato antigo para o novo formato 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 a 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 GitHub do Google e dos guias para desenvolvedores. O assistente pode apresentar um bloco de código completo e pronto para adaptação.

Cenário 4: entender os conceitos da 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 o contexto da documentação de recursos de produtos e guias relevantes. 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 faço para autorizar as chamadas do meu aplicativo com a API Merchant?"

O serviço MCP recupera o contexto dos guias de autenticação oficiais, que abrangem diferentes métodos de autorização. 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: adaptar-se às mudanças da 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 lote 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 do código de refatoração para solicitações simultâneas explicando que os métodos dedicados custombatch não existem na API Merchant. Em vez disso, ele fornece documentação sobre como usar o lote HTTP com um Content-Type de multipart. O assistente pode explicar como construir uma única solicitação HTTP que contenha várias chamadas de API, enviadas para o endpoint https://merchantapi.googleapis.com/batch/{sub-api}/v1, e fornecer um exemplo de como estruturar a solicitação multipart. Isso transforma uma tarefa de migração potencialmente confusa em um processo guiado.

Cenário 6: traduzir uma consulta de relatórios

Você pode pedir ao agente para traduzir uma consulta de relatórios da API Content for Shopping para a API Merchant.

Comando do usuário:

"Migre esta consulta de relatórios da API Content para a API Merchant: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

O serviço MCP recupera a documentação de referência de relatórios, os guias para desenvolvedores e os guias de migração mais recentes. Com base nessas informações, ele transforma a consulta na nova estrutura e atualiza os campos para os novos nomes e valores.

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: