یکپارچه سازی API و کد کمکی ابزار با استفاده از MCP

اطلاعات زمینه‌ای درباره Merchant API را از دستیار کدنویسی انتخابی خود دریافت کنید. در محیط توسعه یکپارچه خود (IDE)، اکنون می توانید با استفاده از سرویس پروتکل زمینه مدل (MCP) به یکپارچه سازی اسناد توسعه دهنده دسترسی داشته باشید. این سرویس با ارائه دستیار برنامه نویسی شما با زمینه معتبر از اسناد رسمی Google API، توسعه شما را برای گردش های کاری یکپارچه سازی و مهاجرت سرعت می بخشد.

برای اطلاعات بیشتر در مورد خود پروتکل، به استاندارد پروتکل زمینه مدل مراجعه کنید.

نمای کلی

هنگام مهاجرت از Content API برای خرید به Merchant API یا ایجاد یک ادغام جدید، باید ساختارهای سرویس، نام منابع و روش‌های جدید را بدانید. سرویس MCP این کار را با ارائه اسناد رسمی و نمونه کد به دستیار کدنویسی شما ساده می کند.

این سرویس از یک باطن بازیابی-افزوده (RAG) بسیار تخصصی استفاده می کند. وقتی از دستیار کدنویسی IDE دارای MCP خود سؤالی در مورد Merchant API می‌پرسید، این سرویس مرتبط‌ترین تکه‌های متن و کد را از منابع رسمی Google بازیابی می‌کند و آنها را به عنوان زمینه به دستیار برنامه‌نویسی شما برمی‌گرداند. این به دستیار شما اجازه می‌دهد بدون اینکه محیط توسعه خود را ترک کنید، پاسخ‌های دقیق و به‌روز ارائه کند.

چگونه کار می کند

یکپارچه‌سازی اسناد توسعه‌دهنده با استفاده از MCP در یک گردش کار توسعه مدرن با کمک هوش مصنوعی ادغام می‌شود:

  1. شما سوالی را در دستیار کدنویسی سازگار با MCP یا نماینده خود می‌پرسید. این می تواند یک سوال زبان طبیعی یا یک درخواست برای نمونه کد برای پیاده سازی متدهای Merchant API باشد.
  2. دستیار برنامه نویسی شما درخواستی را برای زمینه به نقطه پایانی MCP ارسال می کند.
  3. سرویس MCP مجموعه نمایه شده خود از اسناد رسمی Merchant API، راهنماها و نمونه کد را جستجو می کند تا مرتبط ترین اطلاعات را بیابد.
  4. این سرویس این قطعه های معتبر را به عنوان زمینه به دستیار برنامه نویسی شما برمی گرداند.
  5. دستیار برنامه نویسی شما از این زمینه با کیفیت بالا برای ایجاد یک پاسخ دقیق و مفید برای سؤال اصلی شما استفاده می کند.

شروع کردن

برای استفاده از MCP، به یک IDE یا یک دستیار کدنویسی نیاز دارید که از پروتکل بافت مدل با انتقال HTTP قابل پخش پشتیبانی کند.

پیکربندی نقطه پایانی

برای اتصال ابزار خود به سرویس، از جزئیات نقطه پایانی راه دور ارائه شده استفاده کنید، که ممکن است بسته به پیکربندی ابزارتان، URL سرویس مستقیم یا تعریف MCP را وارد کنید.

آدرس سرویس این است:

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

نمونه هایی از سناریوهای استفاده

MCP می تواند گردش کار شما را در این موارد استفاده رایج تسریع کند.

سناریو 1: انتقال یک تماس API قدیمی

شما یک برنامه موجود دارید که از Content API برای خرید استفاده می کند و باید آن را به روز کنید. برای دریافت جزئیات پیاده سازی جدید و نمونه کد مربوطه می توانید در مورد یک روش قدیمی خاص بپرسید.

درخواست کاربر:

"معادل Merchant API برای روش accountstatuses.get در Content API برای خرید چیست؟"

سرویس MCP زمینه را از راهنماهای مهاجرت رسمی و اسناد مرجع فراهم می‌کند و به دستیار شما اجازه می‌دهد با یک پاسخ دقیق، از جمله نام API جدید، accounts.issues پاسخ دهد.

سناریو 2: یافتن یک نمونه کد

شما در حال پیاده سازی یک ویژگی جدید هستید و نیاز به یک مثال عملی برای دنبال کردن دارید.

درخواست کاربر:

"نمونه کد پایتون را برای افزودن یک سرویس حمل و نقل جدید با استفاده از Merchant API به من نشان دهید."

سرویس MCP نمونه‌های کد مربوطه را از مخازن رسمی Google GitHub و راهنمای توسعه‌دهندگان بازیابی می‌کند. سپس دستیار شما می تواند یک بلوک کد کامل و آماده ارائه دهد.

سناریو 3: درک مفاهیم API

شما با مفهوم جدیدی روبرو می شوید یا می خواهید ساختار یک منبع یا الگوی کلی Merchant API را درک کنید.

درخواست کاربر:

"چگونه می توانم موجودی یک محصول را با استفاده از Merchant API به روز کنم؟"

سرویس MCP زمینه را از مستندات منابع محصولات و راهنماهای مربوطه برمی گرداند. سپس دستیار شما می‌تواند نحوه استفاده از روش accounts.productInputs.insert را توضیح دهد و منبع محصول جزئی را که فقط حاوی productId و فیلدهای مربوط به موجودی است که باید به‌روزرسانی کنید، ارائه دهد.

"چگونه می توانم تماس های برنامه خود را با Merchant API مجاز کنم؟"

سرویس MCP زمینه را از راهنماهای رسمی احراز هویت، که روش های مختلف مجوز را پوشش می دهد، بازیابی می کند. سپس دستیار شما می‌تواند گزینه‌های اولیه موجود را توضیح دهد، مانند استفاده از حساب سرویس برای تعاملات سرور به سرور یا شناسه مشتری OAuth 2.0 هنگام اقدام از طرف یک کاربر.

سناریو 4: سازگاری با تغییرات API

Merchant API الگوهای جدیدی را معرفی می‌کند - مانند درخواست‌های دسته‌ای - که با Content API برای خرید متفاوت است. Content API برای خرید از روش‌های custombatch استفاده می‌کند، در حالی که Merchant API از یک ویژگی داخلی و عمومی دسته‌بندی HTTP استفاده می‌کند.

درخواست کاربر:

"روش جدید برای انجام products.custombatch در Merchant API چیست؟"

سرویس MCP زمینه را از کد Refactor برای درخواست‌های همزمان بازیابی می‌کند و توضیح می‌دهد که روش‌های custombatch اختصاصی در Merchant API وجود ندارند. درعوض، مستنداتی در مورد استفاده از دسته‌بندی HTTP با Content-Type multipart ارائه می‌کند. سپس دستیار شما می‌تواند نحوه ساخت یک درخواست HTTP منفرد حاوی چندین تماس API را توضیح دهد که به https://merchantapi.googleapis.com/batch/{sub-api}/v1 نقطه پایانی ارسال می‌شود و نمونه‌ای از نحوه ساختاربندی درخواست چندبخشی ارائه می‌کند. این یک وظیفه مهاجرت بالقوه گیج کننده را به یک فرآیند هدایت شده تبدیل می کند.

منابع دانش پایه

سرویس MCP پایگاه دانش خود را منحصراً از منابع عمومی و رسمی ایجاد می کند تا اطمینان حاصل کند که زمینه ای که ارائه می دهد دقیق و قابل اعتماد است. این سرویس کل محتوای سایت توسعه‌دهنده رسمی و مخزن نمونه کد را نمایه می‌کند، از جمله:

قبلی
Quickstart
بعدی
Overview