ערכת כלים לשילוב API ולסיוע בכתיבת קוד באמצעות MCP

אפשר לקבל מידע הקשרי על Merchant API מהעוזר לתכנות שבחרתם. בסביבת הפיתוח המשולבת (IDE), עכשיו אפשר לגשת לשילוב של מסמכי התיעוד למפתחים באמצעות שירות Model Context Protocol‏ (MCP). השירות הזה מאיץ את תהליך הפיתוח שלכם לשילובי נתונים ותהליכי העברה על ידי מתן הקשר מהימן לעוזר האישי לתכנות שלכם מתיעוד ה-API הרשמי של Google.

מידע נוסף על הפרוטוקול עצמו זמין בתקן Model Context Protocol.

סקירה כללית

כשעוברים מ-Content API for Shopping ל-Merchant API או כשיוצרים שילוב חדש, צריך להבין את המבנים החדשים של השירות, את שמות המשאבים ואת השיטות. שירות ה-MCP מפשט את התהליך הזה באמצעות מתן גישה למאמרי עזרה רשמיים ולדוגמאות קוד לעוזר האישי לתכנות.

השירות משתמש בקצה עורפי (backend) של Retrieval-Augmented Generation (יצירה משולבת-אחזור, RAG) שהוא מאוד ייעודי. כששואלים את העוזר לתכנות בסביבת פיתוח משולבת (IDE) עם תמיכה ב-MCP שאלה לגבי Merchant API, השירות מאחזר את קטעי הטקסט והקוד הכי רלוונטיים ממקורות רשמיים של Google ומחזיר אותם כהקשר לעוזר לתכנות. כך העוזר הדיגיטלי יכול לספק תשובות מדויקות ועדכניות בלי שתצטרכו לצאת מסביבת הפיתוח.

איך זה עובד

שילוב של מסמכי פיתוח באמצעות MCP משתלב בתהליך פיתוח מודרני שנעזר ב-AI:

  1. אתם שואלים שאלה בעוזר או בסוכן תכנות שתואמים ל-MCP. יכולה להיות שאלה בשפה טבעית, בקשה לדוגמה לקוד של Merchant API או אפילו בקשה לתרגם את הקוד ישירות ל-Merchant API.
  2. העוזר בתכנות שולח בקשה להקשר לנקודת הקצה של ה-MCP.
  3. שירות ה-MCP מחפש בנתונים המאונדקסים שלו את המידע הכי רלוונטי מתוך מאמרי העזרה הרשמיים, המדריכים ודוגמאות הקוד של Merchant API.
  4. השירות מחזיר את קטעי הקוד המוסמכים האלה כהקשר לעוזר התכנות.
  5. העוזר בתכנות משתמש בהקשר האיכותי הזה כדי ליצור תשובה מדויקת ומועילה לשאלה המקורית שלכם, או כדי לבצע משימת תרגום קוד.

תחילת העבודה

כדי להשתמש ב-MCP, צריך לבצע את השלבים הבאים:

1. שימוש בכלי תואם

פותחים סביבת פיתוח משולבת (IDE) או עוזר אישי לתכנות שתומכים בפרוטוקול Model Context Protocol עם העברה של HTTP בסטרימינג.

2. הגדרת נקודת הקצה

כדי לחבר את סביבת הפיתוח המשולבת (IDE) או את העוזר האישי לתכנות ל-MCP, צריך להשתמש בפרטים של נקודת הקצה המרוחקת שסופקו. יכול להיות שתצטרכו להזין את כתובת ה-URL של השירות הישיר או את ההגדרה של ה-MCP (בהתאם להגדרות של הכלי).

כתובת ה-URL של השירות היא:

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

הגדרות תצורה:

Antigravity

פועלים לפי ההוראות במסמכי התיעוד של Antigravity.

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

קוד Visual Studio

פועלים לפי ההוראות בתיעוד של Visual Studio Code.

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

3. הוספת הוראות לסוכן (אופציונלי)

כדי לאפשר לסוכן לתרגם קוד ישירות באמצעות MCP, צריך לספק לו את ההוראות למערכת: פרוטוקול MerchantIntegrator Agent. ההוראות האלה עוזרות לסוכן להשתמש נכון ב-MCP כדי לתרגם קוד. בהתאם לכלי, אפשר לספק את ההוראות האלה בהגדרת הוראות המערכת או כקובץ הקשר נוסף לסוכן.

תרחישים לדוגמה לשימוש

ה-MCP יכול להאיץ את תהליך העבודה שלכם בתרחישי השימוש הנפוצים האלה.

תרחיש 1: העברת קוד products.insert

אפשר לבקש מהנציג להעביר ישירות קוד שילוב של Content API for Shopping products.insert אל Merchant API.

הנחיה למשתמש:

‫"Migrate products.insert code to Merchant API"

אם תספקו לסוכן שלכם הוראות מערכת: MerchantIntegrator Agent Protocol וגישה ל-MCP, הסוכן יוכל לתרגם קוד של Content API for Shopping לקוד של Merchant API ישירות בסביבת הפיתוח המשולבת (IDE). במקרה הזה, המערכת תזהה את productInputs.insert כקריאה שוות ערך ותמפה את מאפייני המוצר מהפורמט הישן לפורמט החדש שנדרש על ידי Merchant API. הוא יכול גם לעדכן את הייבוא הנדרש ואת קובץ ניהול התלות (לדוגמה, requirements.txt, pom.xml או package.json). אפשר להנחות את הסוכן לבצע את השינויים במקום או ליצור תיקייה חדשה.

תרחיש 2: איתור פונקציונליות מקבילה

יש לכם אפליקציה קיימת שמשתמשת ב-Content API for Shopping ואתם רוצים לעדכן אותה. אפשר לשאול על שיטה ספציפית מדור קודם כדי לקבל פרטים על ההטמעה החדשה וקוד לדוגמה רלוונטי.

הנחיה למשתמש:

"מה המקבילה של Merchant API לשיטה accountstatuses.get ב-Content API for Shopping?"

שירות ה-MCP מספק הקשר ממדריכי ההעברה הרשמיים וממסמכי העיון, ומאפשר לעוזר הדיגיטלי להשיב תשובה מפורטת, כולל שם ה-API החדש, accounts.issues.

תרחיש 3: חיפוש דוגמת קוד

אתם מטמיעים תכונה חדשה וצריכים דוגמה מעשית לפעולה.

הנחיה למשתמש:

‫"הצג לי דוגמת קוד ב-Python להוספת שירות משלוחים חדש באמצעות Merchant API."

שירות ה-MCP מאחזר דוגמאות קוד רלוונטיות ממאגרי GitHub הרשמיים של Google וממדריכי המפתחים. לאחר מכן, העוזר הדיגיטלי יכול להציג בלוק קוד מלא ומוכן להתאמה.

תרחיש 4: הבנת מושגים שקשורים ל-API

נתקלתם במושג חדש או שאתם רוצים להבין את המבנה של משאב או את הדפוס הכללי של Merchant API.

הנחיה למשתמש:

"איך מעדכנים את המלאי של מוצר באמצעות Merchant API?"

שירות ה-MCP מחזיר הקשר מתוך מסמכי התיעוד של משאבי המוצרים ומתוך מדריכים רלוונטיים. העוזר הדיגיטלי יכול להסביר איך להשתמש בשיטה accounts.productInputs.insert ולספק את משאב המוצר החלקי שמכיל רק את productId ואת השדות שקשורים למלאי שצריך לעדכן.

"איך מאשרים את הקריאות לאפליקציה באמצעות Merchant API?"

שירות ה-MCP מאחזר הקשר ממדריכי האימות הרשמיים, שכוללים שיטות שונות למתן הרשאות. לאחר מכן, העוזר הדיגיטלי יכול להסביר את האפשרויות העיקריות שזמינות, כמו שימוש בחשבון שירות לאינטראקציות משרת לשרת או שימוש במזהה לקוח OAuth 2.0 כשפועלים בשם משתמש.

תרחיש 5: הסתגלות לשינויים ב-API

ב-Merchant API יש דפוסים חדשים – כמו בקשות באצווה – ששונים מאלה של Content API for Shopping. ב-Content API for Shopping נעשה שימוש בשיטות ספציפיות של custombatch, ואילו ב-Merchant API נעשה שימוש בתכונה מובנית וכללית של אצווה HTTP.

הנחיה למשתמש:

"מהי הדרך החדשה להשתמש ב-products.custombatch ב-Merchant API?"

שירות ה-MCP מאחזר הקשר מתוך Refactor code for concurrent requests ומסביר ששיטות custombatch ייעודיות לא קיימות ב-Merchant API. במקום זאת, הוא מספק תיעוד על שימוש ב-HTTP batching עם Content-Type של multipart. לאחר מכן, העוזר הדיגיטלי יכול להסביר איך ליצור בקשת HTTP אחת שמכילה כמה קריאות ל-API, שנשלחת לנקודת הקצה https://merchantapi.googleapis.com/batch/{sub-api}/v1, ולספק דוגמה לאופן שבו אפשר לבנות את הבקשה מרובת החלקים. כך הופכים משימת העברה שעלולה להיות מבלבלת לתהליך מודרך.

תרחיש 6: תרגום של שאילתת דיווח

אתם יכולים לבקש מהסוכן לתרגם שאילתת דיווח מ-Content API for Shopping ל-Merchant API.

הנחיה למשתמש:

‫"Migrate this reporting query from Content API to Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

שירות ה-MCP מאחזר את מסמכי העיון העדכניים ביותר בנושא דיווח, מדריכים למפתחים ומדריכים להעברה. על סמך המידע הזה, הוא משנה את השאילתה למבנה החדש ומעדכן את השדות לשמות ולערכים החדשים שלהם.

מקורות של מאגר ידע

מאגר הידע של שירות ה-MCP מבוסס אך ורק על מקורות ציבוריים ורשמיים, כדי להבטיח שההקשר שהוא מספק יהיה מדויק ומהימן. השירות מבצע אינדוקס של כל התוכן באתר הרשמי למפתחים ובמאגר של דוגמאות קוד, כולל: