Ferramenta MCP

Listar notificações da caixa de entrada

sosoapi_list_inbox_notifications

Consulte a caixa de entrada do usuário no app, dos mais recentes para os mais antigos (até 50), opcionalmente apenas não lidos ou de um tipo.

Ler como Markdown

Perfis 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
}

/identity-api/user/inbox/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.

Campos de entrada
Campo / ramificação	Tipo / obrigatório	Restrições
`$`	`object`Obrigatório no objeto pai	`additionalProperties: false`
`kind`	`string`Opcional / item	`minLength: 1` `maxLength: 64`
`unread_only`	`boolean`Opcional / item	—
`limit`	`integer`Opcional / item	`minimum: 1` `maximum: 50`

JSON Schema completo

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "unread_only": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "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.

Saída estruturada
Campo / ramificação	Tipo / obrigatório	Restrições
`$`	`object`Obrigatório no objeto pai	`additionalProperties: false`
`notifications`	`array`Obrigatório no objeto pai	—
`notifications[]`	`object`Opcional / item	`additionalProperties: false`
`notifications[].id`	`string`Obrigatório no objeto pai	`format: "uuid"`
`notifications[].workspace_id`	`string`Obrigatório no objeto pai	`format: "uuid"`
`notifications[].kind`	`string`Obrigatório no objeto pai	—
`notifications[].title`	`string`Obrigatório no objeto pai	—
`notifications[].body`	`string \| null`Obrigatório no objeto pai	—
`notifications[].body`anyOf 1	`string`Obrigatório no objeto pai	—
`notifications[].body`anyOf 2	`null`Obrigatório no objeto pai	—
`notifications[].link_url`	`string \| null`Obrigatório no objeto pai	—
`notifications[].link_url`anyOf 1	`string`Obrigatório no objeto pai	—
`notifications[].link_url`anyOf 2	`null`Obrigatório no objeto pai	—
`notifications[].payload`	`object`Obrigatório no objeto pai	`default: {}` `additionalProperties: {}`
`notifications[].payload.*`	`any JSON value`Opcional / item	—
`notifications[].read_at`	`string \| null`Obrigatório no objeto pai	—
`notifications[].read_at`anyOf 1	`string`Obrigatório no objeto pai	—
`notifications[].read_at`anyOf 2	`null`Obrigatório no objeto pai	—
`notifications[].created_at`	`string`Obrigatório no objeto pai	—

JSON Schema completo

{
  "type": "object",
  "properties": {
    "notifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "workspace_id": {
            "type": "string",
            "format": "uuid"
          },
          "kind": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "link_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "payload": {
            "default": {},
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          "read_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "kind",
          "title",
          "body",
          "link_url",
          "payload",
          "read_at",
          "created_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "notifications"
  ],
  "$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_inbox_notifications",
  "arguments": {}
}

structuredContent

{
  "notifications": []
}

/identity-api/user/inbox/list

Instale ou conecte MCP