# 列出报告定义

标准 URL： https://sosoapi.ai/zh-hans/docs/mcp/list-report-definitions

`sosoapi_list_report_definitions`

列出报告定义。使用明确指定并已审阅的数据集和版本；不会自动刷新数据源。 可将渲染输入通过管道传递给 sosoapi report render --output FILE。

## 配置与传输方式

配置：full

传输方式：stdio、http

选择 core 或 full 以控制客户端显示的工具；这不会变更权限。本地文件上传需要 stdio，无法通过 HTTP 使用。设置 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索结果加入输出schema。无论是否启用此设置，工具皆会返回结构化结果。

## 权限与副作用

注解帮助客户端描述工具。每次调用仍会检查用户身份验证、角色、资源访问和能力授权。

```json
{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}
```

`/analytics-api/reporting/definitions/list` — agent:operate；synchronous_http_response

## 输入字段

```json
{
  "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 操作说明了权限和重试规则。

```json
{
  "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
}
```

## 工具调用示例

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

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

structuredContent

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

## 底层 API 操作

- [/analytics-api/reporting/definitions/list](https://sosoapi.ai/zh-hans/docs/api/analytics-api-reporting-definitions-list)