MCP tool
列出報表定義
sosoapi_list_report_definitions以 viewer 或以上角色，明確傳 workspace_id 同 kind（metric 或 template）列出報表定義。page_size 最多 50，沿 next_cursor 繼續分頁；history=true 可讀版本歷史。只讀已儲存定義，唔會更新平台來源數據。
閱讀 MarkdownProfiles 及連接方式
Profiles: full · Transports: stdio, http
Profile 只影響工具可見性，不會授予權限。HTTP 不提供本機檔案上傳。SOSOAPI_OUTPUT_SCHEMAS=1 會宣告輸出 schema；兩種模式均會回傳 structured results。
權限及改動
MCP annotations 只提供工具發現提示，並非存取控制保證；實際呼叫仍須通過登入、角色、資源及能力檢查。
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/definitions/list: agent:operate · synchronous_http_response
輸入欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
kind | string父物件內必填 |
|
page_size | integer可選／陣列項目 |
|
cursor | object可選／陣列項目 |
|
cursor.id | string父物件內必填 |
|
cursor.version | integer父物件內必填 |
|
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
}結構化輸出
此 schema 描述成功工具結果的 structuredContent。MCP envelope 亦包括 content，失敗時可能設定 isError；請勿將文字收據或已接受的請求視為平台終態。權限及重試規則請參閱對應的 API 操作。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
items | array父物件內必填 |
|
items[] | object可選／陣列項目 |
|
items[].id | string父物件內必填 |
|
items[].kind | string父物件內必填 |
|
items[].workspace_id | string父物件內必填 |
|
items[].definition_id | string父物件內必填 |
|
items[].version | integer父物件內必填 |
|
items[].name | string父物件內必填 |
|
items[].payload | object父物件內必填 |
|
items[].payload.* | any JSON value可選／陣列項目 | — |
items[].source_object_key | string | null父物件內必填 | — |
items[].source_sha256 | string | null父物件內必填 | — |
items[].created_at | string父物件內必填 |
|
items[].archived | boolean父物件內必填 | — |
next_cursor | object | null父物件內必填 | — |
next_cursoranyOf 1 | object父物件內必填 |
|
next_cursor.idanyOf 1 | string父物件內必填 |
|
next_cursor.versionanyOf 1 | integer父物件內必填 |
|
next_cursoranyOf 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
}工具呼叫範例
以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。
{
"name": "sosoapi_list_report_definitions",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"kind": "metric"
}
}structuredContent
{
"items": [],
"next_cursor": null
}