仅在使用时加载搜索。在下方浏览所有类别。

MCP 工具

获取报告定义版本

sosoapi_get_report_definition

获取报告定义版本。使用明确指定并已审阅的数据集和版本;不会自动刷新数据源。 可将渲染输入通过管道传递给 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
}

输入字段

「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。

输入字段
字段 / 分支类型 / 必填约束
$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
}

结构化输出

此 schema 描述成功工具结果中的 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
}

工具调用示例

这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材,并将日期替换为已确认的发布时间。提交写入前,请检查账号资格。本页不会发送 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