Tích hợp API và Bộ công cụ hỗ trợ mã bằng MCP

Nhận thông tin tình báo theo bối cảnh về Merchant API từ trợ lý lập trình mà bạn chọn. Trong môi trường phát triển tích hợp (IDE), giờ đây, bạn có thể truy cập vào tính năng tích hợp tài liệu dành cho nhà phát triển bằng dịch vụ Giao thức ngữ cảnh mô hình (MCP). Dịch vụ này giúp đẩy nhanh quá trình phát triển của bạn cho quy trình tích hợp và di chuyển bằng cách cung cấp cho trợ lý lập trình của bạn ngữ cảnh có thẩm quyền từ tài liệu API chính thức của Google.

Để biết thêm thông tin về giao thức này, hãy xem tiêu chuẩn Giao thức bối cảnh mô hình.

Tổng quan

Khi di chuyển từ Content API for Shopping sang Merchant API hoặc tạo một mối tích hợp mới, bạn cần hiểu rõ các cấu trúc dịch vụ, tên tài nguyên và phương thức mới. Dịch vụ MCP đơn giản hoá việc này bằng cách cung cấp tài liệu chính thức và các mẫu mã cho trợ lý lập trình của bạn.

Dịch vụ này sử dụng một phần phụ trợ Tạo sinh tăng cường truy xuất (RAG) có tính chuyên biệt cao. Khi bạn hỏi trợ lý lập trình IDE có hỗ trợ MCP một câu hỏi về Merchant API, dịch vụ này sẽ truy xuất các đoạn mã và văn bản phù hợp nhất từ các tài nguyên chính thức của Google rồi trả về các đoạn mã và văn bản đó dưới dạng bối cảnh cho trợ lý lập trình của bạn. Nhờ đó, trợ lý có thể đưa ra câu trả lời chính xác và mới nhất mà bạn không cần phải rời khỏi môi trường phát triển.

Cách hoạt động

Tài liệu dành cho nhà phát triển tích hợp bằng MCP sẽ tích hợp vào một quy trình phát triển hiện đại, được hỗ trợ bằng AI:

  1. Bạn đặt câu hỏi trong Trợ lý lập trình hoặc Agent tương thích với MCP. Đây có thể là một câu hỏi bằng ngôn ngữ tự nhiên, yêu cầu về mẫu mã Merchant API hoặc thậm chí là yêu cầu dịch trực tiếp mã của bạn sang Merchant API.
  2. Trợ lý lập trình của bạn sẽ gửi yêu cầu về ngữ cảnh đến điểm cuối MCP.
  3. Dịch vụ MCP tìm kiếm trong bộ sưu tập tài liệu, hướng dẫn và mẫu mã chính thức của Merchant API đã được lập chỉ mục để tìm thông tin phù hợp nhất.
  4. Dịch vụ này trả về những đoạn mã có thẩm quyền này dưới dạng bối cảnh cho trợ lý lập trình của bạn.
  5. Trợ lý lập trình của bạn sử dụng ngữ cảnh chất lượng cao này để tạo ra câu trả lời chính xác và hữu ích cho câu hỏi ban đầu của bạn hoặc để thực hiện một tác vụ dịch mã.

Bắt đầu

Để sử dụng MCP, hãy làm theo các bước sau:

1. Sử dụng một công cụ tương thích

Mở một IDE hoặc trợ lý lập trình hỗ trợ Giao thức ngữ cảnh mô hình bằng phương thức truyền HTTP có thể truyền trực tuyến.

2. Cấu hình thiết bị đầu cuối

Để kết nối IDE hoặc trợ lý lập trình với MCP, hãy sử dụng thông tin chi tiết về điểm cuối từ xa được cung cấp. Bạn có thể phải nhập URL dịch vụ trực tiếp hoặc định nghĩa MCP (tuỳ thuộc vào cấu hình của công cụ).

URL của dịch vụ là:

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

3. Thêm hướng dẫn cho nhân viên hỗ trợ (không bắt buộc)

Để cho phép tác nhân dịch trực tiếp mã bằng MCP, hãy cung cấp cho tác nhân Hướng dẫn hệ thống: Giao thức MerchantIntegrator Agent. Những hướng dẫn này hướng dẫn nhân viên hỗ trợ cách sử dụng MCP đúng cách để dịch mã. Tuỳ thuộc vào công cụ bạn sử dụng, bạn có thể cung cấp các chỉ dẫn này trong cấu hình chỉ dẫn hệ thống hoặc dưới dạng một tệp bối cảnh bổ sung cho tác nhân.

Ví dụ về các trường hợp sử dụng

MCP có thể đẩy nhanh quy trình làm việc của bạn trong những trường hợp sử dụng phổ biến này.

Trường hợp 1: Di chuyển mã products.insert

Bạn có thể yêu cầu tác nhân di chuyển trực tiếp mã tích hợp Content API for Shopping products.insert sang Merchant API.

Câu lệnh của người dùng:

"Di chuyển mã products.insert sang Merchant API"

Bằng cách cung cấp cho trợ lý của bạn Hướng dẫn hệ thống: Giao thức MerchantIntegrator Agent và quyền truy cập vào MCP, trợ lý của bạn có thể dịch mã Content API for Shopping sang mã Merchant API ngay trong IDE của bạn. Trong trường hợp này, thao tác này sẽ xác định productInputs.insert là lệnh gọi tương đương và liên kết các thuộc tính sản phẩm từ định dạng cũ sang định dạng mới mà Merchant API yêu cầu. Công cụ này cũng có thể cập nhật các tệp nhập bắt buộc và tệp quản lý phần phụ thuộc (ví dụ: requirements.txt, pom.xml hoặc package.json). Bạn có thể hướng dẫn tác nhân thực hiện các thay đổi tại chỗ hoặc tạo một thư mục mới.

Trường hợp 2: Tìm chức năng tương đương

Bạn có một ứng dụng hiện có đang sử dụng Content API for Shopping và cần cập nhật ứng dụng đó. Bạn có thể hỏi về một phương thức cũ cụ thể để biết thông tin chi tiết về cách triển khai mới và một mẫu mã có liên quan.

Câu lệnh của người dùng:

"Phương thức tương đương của Merchant API cho phương thức accountstatuses.get trong Content API for Shopping là gì?"

Dịch vụ MCP cung cấp bối cảnh từ hướng dẫn di chuyển chính thức và tài liệu tham khảo, cho phép trợ lý của bạn trả lời bằng một câu trả lời chi tiết, bao gồm cả tên API mới, accounts.issues.

Tình huống 3: Tìm mã mẫu

Bạn đang triển khai một tính năng mới và cần một ví dụ thực tế để làm theo.

Câu lệnh của người dùng:

"Cho tôi xem một đoạn mã Python để thêm dịch vụ vận chuyển mới bằng Merchant API."

Dịch vụ MCP truy xuất các mã mẫu có liên quan từ kho lưu trữ chính thức của Google trên GitHub và hướng dẫn dành cho nhà phát triển. Sau đó, trợ lý của bạn có thể trình bày một khối mã hoàn chỉnh, sẵn sàng điều chỉnh.

Tình huống 4: Tìm hiểu các khái niệm về API

Bạn gặp phải một khái niệm mới hoặc muốn tìm hiểu cấu trúc của một tài nguyên hay mẫu Merchant API tổng thể.

Câu lệnh của người dùng:

"Làm cách nào để cập nhật kho hàng cho một sản phẩm bằng Merchant API?"

Dịch vụ MCP trả về bối cảnh từ tài liệu về tài nguyên sản phẩm và các hướng dẫn có liên quan. Sau đó, trợ lý của bạn có thể giải thích cách sử dụng phương thức accounts.productInputs.insert và cung cấp tài nguyên sản phẩm một phần chỉ chứa productId và các trường liên quan đến khoảng không quảng cáo mà bạn cần cập nhật.

"Làm cách nào để uỷ quyền cho các lệnh gọi ứng dụng bằng Merchant API?"

Dịch vụ MCP truy xuất bối cảnh từ các hướng dẫn xác thực chính thức, bao gồm nhiều phương thức uỷ quyền. Sau đó, trợ lý của bạn có thể giải thích các lựa chọn chính hiện có, chẳng hạn như sử dụng tài khoản dịch vụ cho các hoạt động tương tác giữa máy chủ với máy chủ hoặc mã ứng dụng khách OAuth 2.0 khi thay mặt người dùng hành động.

Tình huống 5: Thích ứng với các thay đổi về API

Merchant API giới thiệu các mẫu mới (chẳng hạn như yêu cầu theo lô) khác với Content API for Shopping. Content API for Shopping sử dụng các phương thức custombatch cụ thể, trong khi Merchant API sử dụng một tính năng xử lý hàng loạt HTTP chung, được tích hợp sẵn.

Câu lệnh của người dùng:

"Cách mới để thực hiện products.custombatch trong Merchant API là gì?"

Dịch vụ MCP truy xuất ngữ cảnh từ Tái cấu trúc mã cho các yêu cầu đồng thời giải thích rằng không có phương thức custombatch chuyên dụng trong Merchant API. Thay vào đó, thư viện này cung cấp tài liệu về cách sử dụng tính năng xử lý hàng loạt HTTP với Content-Type của multipart. Sau đó, trợ lý của bạn có thể giải thích cách tạo một yêu cầu HTTP duy nhất chứa nhiều lệnh gọi API, được gửi đến điểm cuối https://merchantapi.googleapis.com/batch/{sub-api}/v1 và cung cấp ví dụ về cách cấu trúc yêu cầu gồm nhiều phần. Việc này sẽ biến một tác vụ di chuyển có thể gây nhầm lẫn thành một quy trình có hướng dẫn.

Trường hợp 6: Dịch truy vấn báo cáo

Bạn có thể yêu cầu tác nhân dịch một truy vấn báo cáo từ Content API for Shopping sang Merchant API.

Câu lệnh của người dùng:

"Di chuyển truy vấn báo cáo này từ Content API sang Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

Dịch vụ MCP truy xuất tài liệu tham khảo báo cáo, hướng dẫn cho nhà phát triển và hướng dẫn di chuyển mới nhất. Dựa trên thông tin này, hệ thống sẽ chuyển đổi truy vấn sang cấu trúc mới và cập nhật các trường thành tên và giá trị mới.

Nguồn cơ sở kiến thức

Dịch vụ MCP xây dựng cơ sở kiến thức của mình hoàn toàn từ các nguồn công khai và chính thức để đảm bảo bối cảnh mà dịch vụ này cung cấp là chính xác và đáng tin cậy. Dịch vụ này lập chỉ mục toàn bộ nội dung của trang web chính thức dành cho nhà phát triển và kho lưu trữ mẫu mã, bao gồm:

Trước
Client libraries
Tiếp
Overview