Ferramenta MCP
Listar definições de relatório
sosoapi_list_report_definitionsListar definições de relatório. Usa o conjunto de dados e a versão explicitamente definidos e revisados; a fonte não é atualizada automaticamente. As entradas de renderização podem ser encaminhadas por um pipe para sosoapi report render --output FILE.
Ler como MarkdownPerfis e transportes
Perfis: full · Transportes: stdio, http
Escolha core ou full para controlar quais ferramentas seu cliente vê; isso não altera suas permissões. O envio de arquivos locais exige stdio e não está disponível por HTTP. Defina SOSOAPI_OUTPUT_SCHEMAS=1 para incluir schemas de saída na descoberta. As ferramentas retornam resultados estruturados com ou sem essa configuração.
Permissões e efeitos colaterais
As anotações ajudam os clientes a descrever uma ferramenta. Cada chamada ainda verifica autenticação, função, acesso a recursos e concessões de capacidades do usuário.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/definitions/list: agent:operate · synchronous_http_response
Campos de entrada
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
workspace_id | stringObrigatório no objeto pai |
|
kind | stringObrigatório no objeto pai |
|
page_size | integerOpcional / item |
|
cursor | objectOpcional / item |
|
cursor.id | stringObrigatório no objeto pai |
|
cursor.version | integerObrigatório no objeto pai |
|
history | booleanOpcional / item | — |
JSON Schema completo
{
"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
}Saída estruturada
Este schema descreve structuredContent em um resultado de ferramenta bem-sucedido. A resposta MCP também inclui content e pode definir isError quando uma chamada falha. Para publicações, consulte o resultado final do post em vez de tratar uma requisição aceita ou resposta de texto como confirmação. A operação de API vinculada explica as permissões e regras de repetição.
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
items | arrayObrigatório no objeto pai |
|
items[] | objectOpcional / item |
|
items[].id | stringObrigatório no objeto pai |
|
items[].kind | stringObrigatório no objeto pai |
|
items[].workspace_id | stringObrigatório no objeto pai |
|
items[].definition_id | stringObrigatório no objeto pai |
|
items[].version | integerObrigatório no objeto pai |
|
items[].name | stringObrigatório no objeto pai |
|
items[].payload | objectObrigatório no objeto pai |
|
items[].payload.* | any JSON valueOpcional / item | — |
items[].source_object_key | string | nullObrigatório no objeto pai | — |
items[].source_sha256 | string | nullObrigatório no objeto pai | — |
items[].created_at | stringObrigatório no objeto pai |
|
items[].archived | booleanObrigatório no objeto pai | — |
next_cursor | object | nullObrigatório no objeto pai | — |
next_cursoranyOf 1 | objectObrigatório no objeto pai |
|
next_cursor.idanyOf 1 | stringObrigatório no objeto pai |
|
next_cursor.versionanyOf 1 | integerObrigatório no objeto pai |
|
next_cursoranyOf 2 | nullObrigatório no objeto pai | — |
JSON Schema completo
{
"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
}Exemplo de chamada de ferramenta
Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.
{
"name": "sosoapi_list_report_definitions",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"kind": "metric"
}
}structuredContent
{
"items": [],
"next_cursor": null
}