MCP 工具
列出報表定義
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在父物件中必填 |
|
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 回應也包含 content，並可能在呼叫失敗時設定 isError。對於發布，請讀取貼文的最終結果，不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | 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
}工具呼叫範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。
{
"name": "sosoapi_list_report_definitions",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"kind": "metric"
}
}structuredContent
{
"items": [],
"next_cursor": null
}