Herramienta MCP
Obtener una versión de la definición de un informe
sosoapi_get_report_definitionObtener una versión de la definición de un informe. Utiliza el conjunto de datos y la versión revisados y seleccionados explícitamente; no actualiza las fuentes automáticamente. Los datos de entrada de renderizado se pueden pasar mediante una tubería a sosoapi report render --output FILE.
Leer en MarkdownPerfiles y transportes
Perfiles: full · Transportes: stdio, http
Elige core o full para controlar qué herramientas ve tu cliente; no cambia sus permisos. La carga de archivos locales requiere stdio y no está disponible por HTTP. Establece SOSOAPI_OUTPUT_SCHEMAS=1 para incluir esquemas de salida en la detección. Las herramientas devuelven resultados estructurados con o sin esa opción.
Permisos y efectos secundarios
Las anotaciones ayudan a los clientes a describir una herramienta. Cada llamada sigue comprobando la autenticación, el rol, el acceso al recurso y los permisos de capacidades del usuario.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/definitions/get: agent:operate · synchronous_http_response
Campos de entrada
Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.
| Campo / rama | Tipo / obligatorio | Restricciones |
|---|---|---|
$ | objectObligatorio en el objeto principal |
|
workspace_id | stringObligatorio en el objeto principal |
|
id | stringObligatorio en el objeto principal |
|
version | integerOpcional / elemento |
|
JSON Schema completo
{
"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
}Salida estructurada
Este esquema describe structuredContent en un resultado exitoso de herramienta. La respuesta MCP también incluye content y puede establecer isError si falla una llamada. Para publicación, consulta el resultado final de la publicación en vez de considerar una solicitud aceptada o una respuesta de texto como confirmación. La operación API enlazada explica los permisos y las reglas de reintento.
Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.
| Campo / rama | Tipo / obligatorio | Restricciones |
|---|---|---|
$ | objectObligatorio en el objeto principal |
|
id | stringObligatorio en el objeto principal |
|
kind | stringObligatorio en el objeto principal |
|
workspace_id | stringObligatorio en el objeto principal |
|
definition_id | stringObligatorio en el objeto principal |
|
version | integerObligatorio en el objeto principal |
|
name | stringObligatorio en el objeto principal |
|
payload | objectObligatorio en el objeto principal |
|
payload.* | any JSON valueOpcional / elemento | — |
source_object_key | string | nullObligatorio en el objeto principal | — |
source_sha256 | string | nullObligatorio en el objeto principal | — |
created_at | stringObligatorio en el objeto principal |
|
archived | booleanObligatorio en el objeto principal | — |
JSON Schema completo
{
"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
}Ejemplo de llamada a herramienta
Estos ejemplos usan valores ficticios comprobados con los esquemas. Sustituye los IDs por otros autorizados, los archivos multimedia por recursos listos y las fechas por tu hora de publicación confirmada. Comprueba la elegibilidad de la cuenta antes de enviar una escritura. Esta página no envía solicitudes 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
}