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

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

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

نمای کلی

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

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

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

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

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

شروع به کار

برای استفاده از MCP، مراحل زیر را دنبال کنید:

۱. از یک ابزار سازگار استفاده کنید

یک IDE یا دستیار کدنویسی باز کنید که از پروتکل Model Context با انتقال HTTP قابل پخش پشتیبانی کند.

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

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

آدرس اینترنتی سرویس عبارت است از:

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

۳. دستورالعمل‌های اپراتور را اضافه کنید (اختیاری)

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

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

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

سناریو ۱: انتقال کد products.insert

می‌توانید از نماینده بخواهید که مستقیماً یک API محتوا برای products.insert فروشگاه را منتقل کند. کد ادغام را به API فروشنده وارد کنید.

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

"کد products.insert به رابط برنامه‌نویسی کاربردی فروشگاه منتقل کنید"

با ارائه دستورالعمل‌های سیستم: پروتکل عامل MerchantIntegrator و دسترسی به MCP به نماینده شما، نماینده شما می‌تواند کد Content API for Shopping را مستقیماً در IDE شما به کد Merchant API ترجمه کند. در این حالت، productInputs.insert به عنوان فراخوانی معادل شناسایی کرده و ویژگی‌های محصول را از قالب قدیمی به قالب جدید مورد نیاز Merchant API نگاشت می‌کند. همچنین می‌تواند فایل‌های import و مدیریت وابستگی مورد نیاز (به عنوان مثال requirements.txt ، pom.xml یا package.json ) را به‌روزرسانی کند. می‌توانید به نماینده دستور دهید که تغییرات را در محل انجام دهد یا یک پوشه جدید ایجاد کند.

سناریو ۲: یافتن قابلیت‌های معادل

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

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

«معادل API فروشنده برای متد accountstatuses.get در API محتوا برای خرید چیست؟»

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

سناریو ۳: پیدا کردن یک نمونه کد

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

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

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

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

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

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

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

«چگونه می‌توانم موجودی یک محصول را با استفاده از رابط برنامه‌نویسی کاربردی فروشنده به‌روزرسانی کنم؟»

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

«چگونه می‌توانم تماس‌های برنامه‌ام را با رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) تأیید کنم؟»

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

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

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

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

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

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

سناریو ۶: ترجمه یک کوئری گزارش‌دهی

می‌توانید از نماینده بخواهید که یک کوئری گزارش‌دهی را از API محتوا برای خرید به API فروشنده ترجمه کند.

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

«این کوئری گزارش‌دهی را از API محتوا به API فروشنده منتقل کنید: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date بین '2020-12-01' و '2020-12-30'»

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

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

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