MCP 工具
读取非公开报告模板版本
sosoapi_get_report_template读取非公开报告模板版本。使用明确指定并已审阅的数据集和版本;不会自动刷新数据源。 可将渲染输入通过管道传递给 sosoapi report render --output FILE。
阅读 Markdown配置与传输方式
配置: full · 传输方式: stdio、http
选择 core 或 full 以控制客户端显示的工具;这不会变更权限。本地文件上传需要 stdio,无法通过 HTTP 使用。设置 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索结果加入输出schema。无论是否启用此设置,工具皆会返回结构化结果。
权限与副作用
注解帮助客户端描述工具。每次调用仍会检查用户身份验证、角色、资源访问和能力授权。
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/templates/get:agent:operate · synchronous_http_response
输入字段
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 |
|
workspace_id | string在父对象中必填 |
|
id | string在父对象中必填 |
|
version | integer在父对象中必填 |
|
完整 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",
"version"
],
"additionalProperties": false
}结构化输出
此 schema 描述成功工具结果中的 structuredContent。MCP 响应也包含 content,并可能在调用失败时设置 isError。对于发布,请读取帖子的最终结果,不要把获接受的请求或文字响应当作确认。链接的 API 操作说明了权限和重试规则。
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 |
|
contractVersion | string在父对象中必填 |
|
workspaceId | string在父对象中必填 |
|
id | string在父对象中必填 |
|
version | integer在父对象中必填 |
|
name | string在父对象中必填 |
|
format | string在父对象中必填 |
|
sourceBase64 | string在父对象中必填 |
|
sourceSha256 | string在父对象中必填 |
|
mappings | object在父对象中必填 |
|
mappings.* | object可选/项目 | — |
mappings.*oneOf 1 | object可选/项目 |
|
mappings.*.kindoneOf 1 | string在父对象中必填 |
|
mappings.*.valueoneOf 1 | string在父对象中必填 |
|
mappings.*oneOf 2 | object可选/项目 |
|
mappings.*.kindoneOf 2 | string在父对象中必填 |
|
mappings.*.fieldoneOf 2 | string在父对象中必填 |
|
mappings.*oneOf 3 | object可选/项目 |
|
mappings.*.kindoneOf 3 | string在父对象中必填 |
|
mappings.*.platformoneOf 3 | string在父对象中必填 |
|
mappings.*.keyoneOf 3 | string在父对象中必填 |
|
mappings.*.unitoneOf 3 | string在父对象中必填 |
|
mappings.*.grainoneOf 3 | string在父对象中必填 |
|
mappings.*.measurementKindoneOf 3 | string在父对象中必填 |
|
mappings.*.accountIdoneOf 3 | string可选/项目 |
|
mappings.*.providerResourceIdoneOf 3 | string | null可选/项目 | — |
mappings.*.providerResourceIdoneOf 3 / anyOf 1 | string可选/项目 |
|
mappings.*.providerResourceIdoneOf 3 / anyOf 2 | null可选/项目 | — |
mappings.*.sourcePathoneOf 3 | string可选/项目 |
|
mappings.*.requestIdoneOf 3 | string | null可选/项目 | — |
mappings.*.requestIdoneOf 3 / anyOf 1 | string可选/项目 |
|
mappings.*.requestIdoneOf 3 / anyOf 2 | null可选/项目 | — |
mappings.*oneOf 4 | object可选/项目 |
|
mappings.*.kindoneOf 4 | string在父对象中必填 |
|
mappings.*.idoneOf 4 | string在父对象中必填 |
|
mappings.*.versiononeOf 4 | integer在父对象中必填 |
|
mappings.*oneOf 5 | object可选/项目 |
|
mappings.*.kindoneOf 5 | string在父对象中必填 |
|
mappings.*.sourceoneOf 5 | string在父对象中必填 |
|
mappings.*.limitoneOf 5 | integer在父对象中必填 |
|
mappings.*oneOf 6 | object可选/项目 |
|
mappings.*.kindoneOf 6 | string在父对象中必填 |
|
mappings.*.sourceoneOf 6 | string在父对象中必填 |
|
createdAt | string在父对象中必填 |
|
完整 JSON Schema
{
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"const": "analytics-template/v1"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"format": {
"type": "string",
"enum": [
"pptx",
"docx",
"xlsx"
]
},
"sourceBase64": {
"type": "string",
"maxLength": 12582912,
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
},
"sourceSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mappings": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,63}$"
},
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "text"
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "selection"
},
"field": {
"type": "string",
"enum": [
"accounts",
"period",
"timezone",
"platforms",
"dataset",
"reviewed",
"coverage"
]
}
},
"required": [
"kind",
"field"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "metric"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"maxLength": 2000
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"platform",
"key",
"unit",
"grain",
"measurementKind"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "formula"
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"kind",
"id",
"version"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "table"
},
"source": {
"type": "string",
"enum": [
"measurements",
"formulas"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"kind",
"source",
"limit"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "chart"
},
"source": {
"type": "string",
"const": "publication_by_platform"
}
},
"required": [
"kind",
"source"
],
"additionalProperties": false
}
]
}
},
"createdAt": {
"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"
}
},
"required": [
"contractVersion",
"workspaceId",
"id",
"version",
"name",
"format",
"sourceBase64",
"sourceSha256",
"mappings",
"createdAt"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}工具调用示例
这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材,并将日期替换为已确认的发布时间。提交写入前,请检查账号资格。本页不会发送 API 请求。
{
"name": "sosoapi_get_report_template",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111",
"version": 1
}
}structuredContent
{
"contractVersion": "analytics-template/v1",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"name": "example",
"format": "pptx",
"sourceBase64": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"mappings": {},
"createdAt": "2099-01-15T09:00:00Z"
}