SosoAPI
התחילו בחינם
HE
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
התחילו בחינם

החיפוש נטען רק כשמשתמשים בו. עיינו בכל הקטגוריות שלהלן.

כלי MCP

קבלת גרסה של הגדרת דוח

sosoapi_get_report_definition

קבלת גרסה של הגדרת דוח. נעשה שימוש במערך הנתונים ובגרסה שנבדקו ונבחרו במפורש; המקור אינו מתרענן אוטומטית. אפשר להעביר את נתוני הקלט להפקה דרך צינור אל sosoapi report render --output FILE.

קריאה בפורמט Markdown

פרופילים ואמצעי תעבורה

פרופילים: full · אמצעי תעבורה: stdio, http

בחרו core או full כדי לשלוט בכלים שהלקוח רואה; הבחירה אינה משנה את ההרשאות שלו. העלאת קבצים מקומיים דורשת stdio ואינה זמינה דרך HTTP. הגדירו SOSOAPI_OUTPUT_SCHEMAS=1 להכללת סכמות פלט בגילוי הכלים. הכלים מחזירים תוצאות מובנות עם ההגדרה הזו או בלעדיה.

הרשאות והשפעות לוואי

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

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

שדות קלט

שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.

שדות קלט
שדה / ענףסוג / חובהאילוצים
$objectחובה באובייקט האב
  • additionalProperties: false
workspace_idstringחובה באובייקט האב
  • format: "uuid"
idstringחובה באובייקט האב
  • format: "uuid"
versionintegerרשות / פריט
  • minimum: 1
  • maximum: 1000000
JSON Schema מלא
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    }
  },
  "required": [
    "workspace_id",
    "id"
  ],
  "additionalProperties": false
}

פלט מובנה

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

שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.

פלט מובנה
שדה / ענףסוג / חובהאילוצים
$objectחובה באובייקט האב
  • additionalProperties: false
idstringחובה באובייקט האב
  • format: "uuid"
kindstringחובה באובייקט האב
  • enum: ["metric","template"]
workspace_idstringחובה באובייקט האב
  • format: "uuid"
definition_idstringחובה באובייקט האב
  • format: "uuid"
versionintegerחובה באובייקט האב
  • minimum: 1
  • maximum: 1000000
namestringחובה באובייקט האב
  • maxLength: 100
payloadobjectחובה באובייקט האב
  • additionalProperties: {}
payload.*any JSON valueרשות / פריט—
source_object_keystring | nullחובה באובייקט האב—
source_sha256string | nullחובה באובייקט האב—
created_atstringחובה באובייקט האב
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
archivedbooleanחובה באובייקט האב—
JSON Schema מלא
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "type": "string",
      "enum": [
        "metric",
        "template"
      ]
    },
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "definition_id": {
      "type": "string",
      "format": "uuid"
    },
    "version": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    },
    "name": {
      "type": "string",
      "maxLength": 100
    },
    "payload": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "source_object_key": {
      "type": [
        "string",
        "null"
      ]
    },
    "source_sha256": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "format": "date-time"
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "kind",
    "workspace_id",
    "definition_id",
    "version",
    "name",
    "payload",
    "source_object_key",
    "source_sha256",
    "created_at",
    "archived"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

דוגמת קריאה לכלי

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

{
  "name": "sosoapi_get_report_definition",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "id": "11111111-1111-4111-8111-111111111111",
  "kind": "metric",
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "definition_id": "11111111-1111-4111-8111-111111111111",
  "version": 1,
  "name": "example",
  "payload": {},
  "source_object_key": "example",
  "source_sha256": "example",
  "created_at": "2099-01-15T09:00:00Z",
  "archived": false
}
התקנה או חיבור של MCP