使用 MCP 的 API 集成和代码辅助工具包

从您选择的编码助理处获取有关 Merchant API 的情境智能信息。在集成开发环境 (IDE) 中,您现在可以使用 Model Context Protocol (MCP) 服务访问开发者文档集成。此服务可为您的编码助理提供来自官方 Google API 文档的权威上下文,从而加快集成和迁移工作流程的开发速度。

如需详细了解该协议本身,请参阅 Model Context Protocol 标准

概览

从 Content API for Shopping 迁移到 Merchant API 或构建新的集成时,您需要了解新的服务结构、资源名称和方法。MCP 服务通过向编码助理提供官方文档和代码示例来简化此流程。

该服务采用高度专业化的检索增强生成 (RAG) 后端。当您向支持 MCP 的 IDE 编码助理询问有关 Merchant API 的问题时,该服务会从 Google 的官方资源中检索最相关的文本和代码片段,并将其作为上下文返回给编码助理。这样一来,您的助理便可提供准确、最新的回答,而您无需离开开发环境。

运作方式

使用 MCP 集成开发者文档可集成到现代 AI 辅助开发工作流中:

  1. 您在 MCP 兼容的编码助理或代理中提出问题。可以是自然语言问题,也可以是有关实现 Merchant API 方法的代码示例请求。
  2. 您的编码助理会向 MCP 端点发送上下文请求。
  3. MCP 服务会搜索其已编入索引的官方 Merchant API 文档、指南和代码示例集合,以找到最相关的信息。
  4. 该服务会将这些权威代码段作为上下文返回给编码助理。
  5. 您的编码助理会使用此高质量的上下文,针对您最初的问题生成准确且实用的回答。

使用入门

如需使用 MCP,您需要使用支持 Model Context Protocol 且具有可流式传输的 HTTP 传输的 IDE 或编码助理。

端点配置

如需将工具连接到服务,请使用提供的远程端点详细信息,这可能需要您输入直接服务网址或 MCP 定义,具体取决于工具的配置。

服务网址为:

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

使用场景示例

在以下常见使用情形中,MCP 可以加快您的工作流程。

场景 1:迁移旧版 API 调用

您有一个使用 Content API for Shopping 的现有应用,需要更新该应用。您可以询问有关特定旧版方法的问题,以详细了解新实现和相关代码示例。

用户提示

“Merchant API 中与 Content API for Shopping 中的 accountstatuses.get 方法等效的方法是什么?”

MCP 服务可提供来自官方迁移指南和参考文档的上下文,让助理能够提供详细的回答,包括新的 API 名称 accounts.issues

情形 2:查找代码示例

您正在实现一项新功能,需要一个可供参考的实用示例。

用户提示

“向我展示一个使用 Merchant API 添加新配送服务的 Python 代码示例。”

MCP 服务从 Google 官方 GitHub 代码库和开发者指南中检索相关代码示例。然后,Google 助理可以呈现一个完整的、可随时调整的代码块。

情景 3:了解 API 概念

您遇到新概念,或者想了解资源结构或整个 Merchant API 模式。

用户提示

“如何使用 Merchant API 更新商品的商品目录?”

MCP 服务会返回产品资源文档和相关指南中的上下文。然后,您的助理可以说明如何使用 accounts.productInputs.insert 方法,并提供仅包含 productId 和您需要更新的与商品目录相关的字段的部分商品资源。

“如何使用 Merchant API 授权我的应用调用?”

MCP 服务会从涵盖不同授权方法的官方身份验证指南中检索上下文。然后,您的助理可以说明可用的主要选项,例如使用服务账号进行服务器到服务器的互动,或者在代表用户执行操作时使用 OAuth 2.0 客户端 ID。

方案 4:适应 API 变更

Merchant API 引入了与 Content API for Shopping 不同的新模式,例如批处理请求。Content API for Shopping 使用特定的 custombatch 方法,而 Merchant API 使用内置的通用 HTTP 批处理功能。

用户提示

“在 Merchant API 中,执行 products.custombatch 的新方式是什么?”

MCP 服务从重构代码以处理并发请求中检索上下文,说明 Merchant API 中不存在专用 custombatch 方法。相反,它提供了有关使用 HTTP 批处理的文档,其中 Content-Typemultipart。然后,您的助理可以说明如何构建包含多个 API 调用的单个 HTTP 请求(发送到 https://merchantapi.googleapis.com/batch/{sub-api}/v1 端点),并提供有关如何构建多部分请求的示例。这会将可能令人困惑的迁移任务转变为引导式流程。

知识库来源

MCP 服务仅从公开和官方来源构建知识库,以确保其提供的上下文准确可靠。该服务会为官方开发者网站和代码示例代码库的全部内容编制索引,包括: