הצגת הגדרות דוחות

sosoapi_list_report_definitions

הצגת הגדרות דוחות. נעשה שימוש במערך הנתונים ובגרסה שנבדקו ונבחרו במפורש; המקור אינו מתרענן אוטומטית. אפשר להעביר את נתוני הקלט להפקה דרך צינור אל 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
}

/analytics-api/reporting/definitions/list: agent:operate · synchronous_http_response

שדות קלט

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

שדות קלט
שדה / ענף	סוג / חובה	אילוצים
`$`	`object`חובה באובייקט האב	`additionalProperties: false`
`workspace_id`	`string`חובה באובייקט האב	`format: "uuid"`
`kind`	`string`חובה באובייקט האב	`enum: ["metric","template"]`
`page_size`	`integer`רשות / פריט	`minimum: 1` `maximum: 50`
`cursor`	`object`רשות / פריט	`additionalProperties: false`
`cursor.id`	`string`חובה באובייקט האב	`format: "uuid"`
`cursor.version`	`integer`חובה באובייקט האב	`minimum: 1` `maximum: 1000000`
`history`	`boolean`רשות / פריט	—

JSON Schema מלא

{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "type": "string",
      "enum": [
        "metric",
        "template"
      ]
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "cursor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "version": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000000
        }
      },
      "required": [
        "id",
        "version"
      ],
      "additionalProperties": false
    },
    "history": {
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id",
    "kind"
  ],
  "additionalProperties": false
}

פלט מובנה

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

פלט מובנה
שדה / ענף	סוג / חובה	אילוצים
`$`	`object`חובה באובייקט האב	`additionalProperties: false`
`items`	`array`חובה באובייקט האב	`maxItems: 50`
`items[]`	`object`רשות / פריט	`additionalProperties: false`
`items[].id`	`string`חובה באובייקט האב	`format: "uuid"`
`items[].kind`	`string`חובה באובייקט האב	`enum: ["metric","template"]`
`items[].workspace_id`	`string`חובה באובייקט האב	`format: "uuid"`
`items[].definition_id`	`string`חובה באובייקט האב	`format: "uuid"`
`items[].version`	`integer`חובה באובייקט האב	`minimum: 1` `maximum: 1000000`
`items[].name`	`string`חובה באובייקט האב	`maxLength: 100`
`items[].payload`	`object`חובה באובייקט האב	`additionalProperties: {}`
`items[].payload.*`	`any JSON value`רשות / פריט	—
`items[].source_object_key`	`string \| null`חובה באובייקט האב	—
`items[].source_sha256`	`string \| null`חובה באובייקט האב	—
`items[].created_at`	`string`חובה באובייקט האב	`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)))$"`
`items[].archived`	`boolean`חובה באובייקט האב	—
`next_cursor`	`object \| null`חובה באובייקט האב	—
`next_cursor`anyOf 1	`object`חובה באובייקט האב	`additionalProperties: false`
`next_cursor.id`anyOf 1	`string`חובה באובייקט האב	`format: "uuid"`
`next_cursor.version`anyOf 1	`integer`חובה באובייקט האב	`minimum: 1` `maximum: 1000000`
`next_cursor`anyOf 2	`null`חובה באובייקט האב	—

JSON Schema מלא

{
  "type": "object",
  "properties": {
    "items": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "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"
        ],
        "additionalProperties": false
      }
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "version": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000000
            }
          },
          "required": [
            "id",
            "version"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "items",
    "next_cursor"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

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

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

{
  "name": "sosoapi_list_report_definitions",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "kind": "metric"
  }
}

structuredContent

{
  "items": [],
  "next_cursor": null
}

/analytics-api/reporting/definitions/list

התקנה או חיבור של MCP