OpenAPI לסוכני AI
מסמך OpenAPI מתאר API של HTTP בצורה קריאה למכונה: נקודות הקצה שלו, הפרמטרים שכל אחת מקבלת, המבנה של כל תגובה ואיך מבצעים אימות. סוכן יכול לקרוא מסמך כזה כדי ללמוד איך לפנות ל-API שלא פגש מעולם.
- שירותים ברשימה עם תיאור OpenAPI
- 23
- אתרים שמגישים קובץ ai-plugin.json אמיתי
- 75 מתוך 1,504
מתיאור API לכלים
פריימוורקים של סוכנים וכמה פלטפורמות של עוזרי AI יכולים להפוך את הפעולות (operations) במסמך OpenAPI לכלים: המזהה של הפעולה הופך לשם הכלי, התקציר והתיאור שלה מסבירים למודל מתי להשתמש בה, וסכמת הפרמטרים שלה הופכת לקלט של הכלי. המודל ממלא את הפרמטרים, והפלטפורמה שולחת את בקשת ה-HTTP.
מניפסט התוסף
המניפסט /.well-known/ai-plugin.json הוצג יחד עם מערכת התוספים של ChatGPT ב-2023: הוא ציין את שם השירות, תיאר אותו עבור המודל והפנה למסמך OpenAPI. מערכת התוספים הזו הוחלפה מאז, אבל חלק מהאתרים עדיין מגישים את הקובץ, והוא עדיין מציין איפה נמצא תיאור ה-API שלהם.
OpenAPI ו-MCP
OpenAPI מתאר כל API של HTTP, לא משנה מי פונה אליו. MCP הוא פרוטוקול שנבנה לעוזרי AI: השרת מפרט את הכלים שלו כשהלקוח מתחבר, והלקוח מפעיל אותם. שרתי MCP רבים הם שכבה דקה מעל API שיש לו גם תיאור OpenAPI, ויש כלים שמייצרים אחד מהשני.
מה הופך תיאור לידידותי לסוכנים
מזהי פעולות ברורים ותיאורים שנכתבו בשביל מי שלא ראה את ה-API מעולם; דוגמאות; ערכי enum לערכים המותרים; שגיאות מתועדות; שיטת אימות מוצהרת, ולא רק מוסברת בטקסט חופשי; ופעולות קטנות שכל אחת מהן עושה דבר אחד. כתובת URL יציבה שבה המסמך מפורסם מאפשרת לסוכנים ולאינדקסים למצוא אותו.
שירותים עם תיאור OpenAPI · שירותים עם API ציבורי · לעיון באינדקס ←
עוד: מה זה שרת MCP? · מה זה llms.txt? · איך עוזרי AI מוצאים ומזמינים נסיעות · איך הרישומים מאומתים · שכבות תעבורה ב-MCP: stdio, Streamable HTTP ו-SSE · מרוחק או מקומי: באיזה סוג שרת MCP להשתמש · איך מוסיפים שרת MCP לעוזר AI · מה זה ה-MCP Registry הרשמי? · מה כותבים בקובץ llms.txt · איך עוזרי AI מוצאים זמינות לנסיעות · לפני שמחברים שרת MCP: רשימת בדיקה