קטלוג היכולות
הרשימה המובְנית של מה שה-API שלכם יכול לעשות — מתגלה פעם אחת, נכתבת על ידיכם, ונקראת בכל המשטחים.
קטלוג היכולות הוא ליבו של Syncanix. זהו תיאור מובְנה של כל מה שהמוצר שלכם יכול לעשות, שמתגלה מה-API שלכם ומלוטש על ידיכם. כל המשטחים — הרכיב, הצ׳אט, שרת ה-MCP — קוראים מהקטלוג היחיד הזה, כך שמה שהעוזר שלכם יכול לעשות נשאר עקבי בכל מקום ונערך במקום אחד.
מהי יכולת
יכולת היא דבר יחיד שה-API שלכם יכול לעשות: נקודת קצה או פעולה, כמו «לאתר הזמנה» או « להחזיר תשלום». כל אחת מתוארת די הצורך כדי שהעוזר יבין מה היא עושה, מה היא צריכה, ומתי להשתמש בה.
מה כל יכולת נושאת
- מזהה
- מזהה יציב בצורה domain.action (למשל orders.refund), שבו משתמשים בכל מקום שבו מפנים ליכולת.
- שיטה ונתיב
- שיטת ה-HTTP והנתיב שאליהם היכולת ממופה (למשל POST /orders/{id}/refund).
- קלטים
- הארגומנטים שהפעולה מקבלת, עם שמותיהם וסוגיהם — לעולם לא ערכי דוגמה מהנתונים שלכם.
- תיאור
- סיכום בשפה ברורה של מה שהפעולה עושה. זה מה שהעוזר קורא כדי להחליט אם להשתמש בה ומתי.
- תופעת לוואי
- האם הפעולה קוראת, כותבת או הרסנית — מה שקובע כיצד היא מאושרת לפני שהיא רצה.
- סיכון
- רמת סיכון שמאפשרת לכם להתייחס לפעולות מסוימות בזהירות רבה יותר משתופעת הלוואי שלהן לבדה הייתה מרמזת.
- הרשאות נדרשות
- ההרשאות (scopes) שמשתמש חייב שיהיו לו כדי שהפעולה תוצע לו בכלל.
- סימון «פנימי»
- מסמן יכולת כפנימית כך שתישאר מחוץ להישג ידו של העוזר ובכל זאת תישאר בקטלוג שלכם.
- סימוני מידע אישי
- מסמן קלטים או פלטים המכילים מידע אישי, כדי שיטופלו ויוסתרו כראוי.
מתגלה, ואז נכתב
הגילוי מציע את הקטלוג בקריאה סטטית של הקוד שלכם. משם הכתיבה בידיכם: שינוי שמות של יכולות, חידוד תיאורים, הגדרת תופעות לוואי וסיכון, סימון נקודות קצה כפנימיות, והתאמת ההרשאות הנדרשות — הכול בלוח הבקרה. השינויים שלכם נשמרים כדריסות, ולכן הם שורדים את הגילוי הבא.
מקור אמת יחיד
מכיוון שהרכיב, משטח הצ׳אט ושרת ה-MCP קוראים כולם מאותו קטלוג, אתם מגדירים פעם אחת מה העוזר יכול לעשות. שנו יכולת בלוח הבקרה וכל המשטחים ישקפו זאת.