Kit de herramientas de integración de APIs y Code Assist con MCP

Obtén información contextual sobre la API de Merchant del asistente de programación que elijas. En tu entorno de desarrollo integrado (IDE), ahora puedes acceder a la integración de la documentación para desarrolladores con el servicio del Protocolo de contexto del modelo (MCP). Este servicio acelera el desarrollo de los flujos de trabajo de integración y migración, ya que proporciona a tu asistente de programación contexto autorizado de la documentación oficial de la API de Google.

Para obtener más información sobre el protocolo, consulta el estándar del Protocolo de contexto del modelo.

Descripción general

Cuando migras de Content API for Shopping a la API de Merchant o creas una integración nueva, debes comprender las nuevas estructuras de servicio, los nombres de los recursos y los métodos. El servicio de MCP simplifica esto, ya que proporciona documentación oficial y muestras de código a tu asistente de programación.

El servicio utiliza un backend de generación mejorada por recuperación (RAG) altamente especializado. Cuando le haces una pregunta sobre la API de Merchant a tu asistente de programación del IDE habilitado para MCP, el servicio recupera los fragmentos de texto y código más relevantes de los recursos oficiales de Google y los muestra como contexto a tu asistente de programación. Esto permite que tu asistente proporcione respuestas precisas y actualizadas sin que tengas que salir del entorno de desarrollo.

Cómo funciona

La integración de la documentación para desarrolladores con MCP se integra en un flujo de trabajo de desarrollo moderno asistido por IA:

  1. Haces una pregunta en tu asistente de programación o agente compatible con MCP. Puede ser una pregunta en lenguaje natural, una solicitud de una muestra de código de la API de Merchant o incluso una solicitud para traducir directamente tu código a la API de Merchant.
  2. Tu asistente de programación envía una solicitud de contexto al extremo de MCP.
  3. El servicio de MCP busca en su colección indexada de documentación, guías y muestras de código oficiales de la API de Merchant para encontrar la información más relevante.
  4. El servicio muestra estos fragmentos autorizados como contexto a tu asistente de programación.
  5. Tu asistente de programación usa este contexto de alta calidad para generar una respuesta precisa y útil a tu pregunta original o para realizar una tarea de traducción de código.

Cómo comenzar

Para usar MCP, sigue estos pasos:

1. Usa una herramienta compatible

Abre un IDE o un asistente de programación que admita el Protocolo de contexto del modelo con transporte HTTP transmitible.

2. Configuración de extremos

Para conectar tu IDE o asistente de programación a MCP, usa los detalles del extremo remoto proporcionados, que pueden requerir que ingreses la URL directa del servicio o la definición de MCP (según la configuración de tu herramienta).

La URL del servicio es la siguiente:

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

Configuraciones:

Antigravity

Sigue las instrucciones de la documentación de Antigravity.

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

Visual Studio Code

Sigue las instrucciones de la documentación de Visual Studio Code.

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

3. Agrega instrucciones del agente (opcional)

Para permitir que tu agente traduzca código directamente con MCP, proporciónale las instrucciones del sistema: Protocolo del agente MerchantIntegrator. Estas instrucciones guían al agente sobre cómo utilizar correctamente MCP para la traducción de código. Según tu herramienta, puedes proporcionar estas instrucciones en la configuración de las instrucciones del sistema o como un archivo de contexto adicional para el agente.

Situaciones de uso de ejemplo

MCP puede acelerar tu flujo de trabajo en estos casos de uso comunes.

Situación 1: Migra el código products.insert

Puedes pedirle al agente que migre directamente un código de integración products.insert de Content API for Shopping a la API de Merchant.

Instrucción del usuario:

"Migra el código products.insert a la API de Merchant".

Si le proporcionas a tu agente las instrucciones del sistema: Protocolo del agente MerchantIntegrator y acceso a MCP, tu agente puede traducir el código de Content API for Shopping al código de la API de Merchant directamente en tu IDE. En este caso, identificará productInputs.insert como la llamada equivalente y asignará los atributos del producto del formato antiguo al formato nuevo que requiere la API de Merchant. También puede actualizar las importaciones obligatorias y el archivo de administración de dependencias (por ejemplo, requirements.txt, pom.xml o package.json). Puedes indicarle al agente que realice los cambios en el lugar o que cree una carpeta nueva.

Situación 2: Busca una funcionalidad equivalente

Tienes una aplicación existente que usa Content API for Shopping y necesitas actualizarla. Puedes preguntar sobre un método heredado específico para obtener detalles sobre la nueva implementación y una muestra de código pertinente.

Instrucción del usuario:

"¿Cuál es el equivalente de la API de Merchant para el método accountstatuses.get en Content API for Shopping?".

El servicio de MCP proporciona contexto de las guías de migración oficiales y la documentación de referencia, lo que permite que tu asistente responda con una respuesta detallada, incluido el nuevo nombre de la API, accounts.issues.

Situación 3: Busca una muestra de código

Estás implementando una función nueva y necesitas un ejemplo práctico para seguir.

Instrucción del usuario:

"Muéstrame una muestra de código de Python para agregar un nuevo servicio de envío con la API de Merchant".

El servicio de MCP recupera muestras de código pertinentes de los repositorios oficiales de GitHub de Google y las guías para desarrolladores. Luego, tu asistente puede presentar un bloque de código completo y listo para adaptarse.

Situación 4: Comprende los conceptos de la API

Te encuentras con un concepto nuevo o quieres comprender la estructura de un recurso o el patrón general de la API de Merchant.

Instrucción del usuario:

"¿Cómo actualizo el inventario de un producto con la API de Merchant?".

El servicio de MCP muestra contexto de la documentación del recurso products y las guías pertinentes. Luego, tu asistente puede explicar cómo usar el método accounts.productInputs.insert y proporcionar el recurso de producto parcial que contiene solo el productId y los campos relacionados con el inventario que necesitas actualizar.

"¿Cómo autorizo las llamadas de mi aplicación con la API de Merchant?".

El servicio de MCP recupera contexto de las guías de autenticación oficiales, que abarcan diferentes métodos de autorización. Luego, tu asistente puede explicar las opciones principales disponibles, como usar una cuenta de servicio para las interacciones de servidor a servidor o un ID de cliente de OAuth 2.0 cuando actúas en nombre de un usuario.

Situación 5: Adáptate a los cambios de la API

La API de Merchant introduce patrones nuevos, como las solicitudes por lotes, que difieren de Content API for Shopping. Content API for Shopping usa métodos custombatch específicos, mientras que la API de Merchant usa una función de procesamiento por lotes HTTP genérica integrada.

Instrucción del usuario:

"¿Cuál es la nueva forma de hacer un products.custombatch en la API de Merchant?".

El servicio de MCP recupera contexto de Refactoriza el código para solicitudes simultáneas en el que se explica que no existen métodos custombatch dedicados en la API de Merchant. En cambio, proporciona documentación sobre el uso del procesamiento por lotes HTTP con un Content-Type de multipart. Luego, tu asistente puede explicar cómo construir una sola solicitud HTTP que contenga varias llamadas a la API, enviadas al extremo https://merchantapi.googleapis.com/batch/{sub-api}/v1, y proporcionar un ejemplo de cómo estructurar la solicitud de varias partes. Esto convierte una tarea de migración potencialmente confusa en un proceso guiado.

Situación 6: Traduce una consulta de informes

Puedes pedirle al agente que traduzca una consulta de informes de Content API for Shopping a la API de Merchant.

Instrucción del usuario:

"Migra esta consulta de informes de Content API a la API de Merchant: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'".

El servicio de MCP recupera la documentación de referencia de informes, las guías para desarrolladores y las guías de migración más recientes. En función de esta información, transforma la consulta a la nueva estructura y actualiza los campos a sus nuevos nombres y valores.

Fuentes de la base de conocimiento

El servicio de MCP crea su base de conocimiento exclusivamente a partir de fuentes públicas y oficiales para garantizar que el contexto que proporciona sea preciso y confiable. El servicio indexa todo el contenido del sitio oficial para desarrolladores y el repositorio de muestras de código, incluidos los siguientes elementos: