Ferramenta MCP
Ler uma visão geral do corpus de pesquisa selecionado
sosoapi_research_projects_overviewLer contagens determinísticas de um corpus exato selado; itens selecionados não representam tamanho de público ou de mercado. Exige agent:research.
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": true
}- /research-api/projects/overview: agent:research · dados exatos de recurso do Research autorizados atualmente
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 |
|
project_id | stringObrigatório no objeto pai |
|
project_revision | integerObrigatório no objeto pai |
|
corpus_snapshot_id | stringObrigatório no objeto pai |
|
JSON Schema completo
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"project_id": {
"type": "string",
"format": "uuid"
},
"project_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"corpus_snapshot_id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id",
"project_id",
"project_revision",
"corpus_snapshot_id"
],
"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 |
|
project_id | stringObrigatório no objeto pai |
|
project_revision | integerObrigatório no objeto pai |
|
corpus_snapshot_id | stringObrigatório no objeto pai |
|
method_version | stringObrigatório no objeto pai |
|
coverage | stringObrigatório no objeto pai |
|
evidence_count | integerObrigatório no objeto pai |
|
unique_items | integerObrigatório no objeto pai |
|
brand_union_count | integerObrigatório no objeto pai |
|
overlap_count | integerObrigatório no objeto pai |
|
brands | arrayObrigatório no objeto pai |
|
brands[] | objectOpcional / item |
|
brands[].id | stringObrigatório no objeto pai |
|
brands[].name | stringObrigatório no objeto pai |
|
brands[].matched_items | integerObrigatório no objeto pai |
|
brands[].observed_mention_share | number | nullObrigatório no objeto pai | — |
brands[].observed_mention_shareanyOf 1 | numberObrigatório no objeto pai |
|
brands[].observed_mention_shareanyOf 2 | nullObrigatório no objeto pai | — |
brands[].evidence | arrayObrigatório no objeto pai |
|
brands[].evidence[] | objectOpcional / item |
|
brands[].evidence[].evidence_id | stringObrigatório no objeto pai |
|
brands[].evidence[].revision | integerObrigatório no objeto pai |
|
languages | arrayObrigatório no objeto pai |
|
languages[] | objectOpcional / item |
|
languages[].language | string | nullObrigatório no objeto pai | — |
languages[].languageanyOf 1 | stringObrigatório no objeto pai |
|
languages[].languageanyOf 2 | nullObrigatório no objeto pai | — |
languages[].item_count | integerObrigatório no objeto pai |
|
platforms | arrayObrigatório no objeto pai |
|
platforms[] | objectOpcional / item |
|
platforms[].platform | string | nullObrigatório no objeto pai | — |
platforms[].platformanyOf 1 | stringObrigatório no objeto pai |
|
platforms[].platformanyOf 2 | nullObrigatório no objeto pai | — |
platforms[].item_count | integerObrigatório no objeto pai |
|
sources | arrayObrigatório no objeto pai |
|
sources[] | objectOpcional / item |
|
sources[].category | stringObrigatório no objeto pai |
|
sources[].item_count | integerObrigatório no objeto pai |
|
history | objectObrigatório no objeto pai |
|
history.eligible | booleanObrigatório no objeto pai |
|
history.reason | stringObrigatório no objeto pai |
|
JSON Schema completo
{
"type": "object",
"properties": {
"project_id": {
"type": "string",
"format": "uuid"
},
"project_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"corpus_snapshot_id": {
"type": "string",
"format": "uuid"
},
"method_version": {
"type": "string",
"const": "literal-mentions/v1"
},
"coverage": {
"type": "string",
"enum": [
"supplied_set",
"bounded_sample",
"partial"
]
},
"evidence_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unique_items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"brand_union_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"overlap_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"brands": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"matched_items": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"observed_mention_share": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1
},
{
"type": "null"
}
]
},
"evidence": {
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"evidence_id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"evidence_id",
"revision"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"matched_items",
"observed_mention_share",
"evidence"
],
"additionalProperties": false
}
},
"languages": {
"maxItems": 501,
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 35
},
{
"type": "null"
}
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"language",
"item_count"
],
"additionalProperties": false
}
},
"platforms": {
"maxItems": 8,
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"anyOf": [
{
"type": "string",
"enum": [
"threads",
"instagram",
"facebook",
"youtube",
"x",
"reddit",
"web"
]
},
{
"type": "null"
}
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"platform",
"item_count"
],
"additionalProperties": false
}
},
"sources": {
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"your_accounts",
"public_posts",
"team_notes"
]
},
"item_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"category",
"item_count"
],
"additionalProperties": false
}
},
"history": {
"type": "object",
"properties": {
"eligible": {
"type": "boolean",
"const": false
},
"reason": {
"type": "string",
"const": "insufficient_comparable_history"
}
},
"required": [
"eligible",
"reason"
],
"additionalProperties": false
}
},
"required": [
"project_id",
"project_revision",
"corpus_snapshot_id",
"method_version",
"coverage",
"evidence_count",
"unique_items",
"brand_union_count",
"overlap_count",
"brands",
"languages",
"platforms",
"sources",
"history"
],
"$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_research_projects_overview",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"corpus_snapshot_id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"corpus_snapshot_id": "11111111-1111-4111-8111-111111111111",
"method_version": "literal-mentions/v1",
"coverage": "supplied_set",
"evidence_count": 0,
"unique_items": 0,
"brand_union_count": 0,
"overlap_count": 0,
"brands": [],
"languages": [],
"platforms": [],
"sources": [],
"history": {
"eligible": false,
"reason": "insufficient_comparable_history"
}
}