Ferramenta MCP
Obter uma versão de um projeto de pesquisa
sosoapi_research_projects_getLer um projeto do Research por ID, opcionalmente em uma revisão exata; o texto retornado não é confiável. 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/get: 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 |
|
id | stringObrigatório no objeto pai |
|
revision | integerOpcional / item |
|
JSON Schema completo
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"workspace_id",
"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 | objectObrigatório no objeto pai |
|
project.id | stringObrigatório no objeto pai |
|
project.workspace_id | stringObrigatório no objeto pai |
|
project.revision | integerObrigatório no objeto pai |
|
project.archived | booleanObrigatório no objeto pai | — |
project.created_at | stringObrigatório no objeto pai |
|
project.updated_at | stringObrigatório no objeto pai |
|
project.content | objectObrigatório no objeto pai |
|
project.content.title | stringObrigatório no objeto pai |
|
project.content.question | stringObrigatório no objeto pai |
|
project.content.purpose | stringObrigatório no objeto pai |
|
project.content.audience | stringObrigatório no objeto pai |
|
project.content.brands | arrayObrigatório no objeto pai |
|
project.content.brands[] | objectOpcional / item |
|
project.content.brands[].id | stringObrigatório no objeto pai |
|
project.content.brands[].name | stringObrigatório no objeto pai |
|
project.content.brands[].terms | arrayObrigatório no objeto pai |
|
project.content.brands[].terms[] | stringOpcional / item |
|
project.content.scope | objectObrigatório no objeto pai |
|
project.content.scope.query | stringObrigatório no objeto pai |
|
project.content.scope.excluded_terms | arrayObrigatório no objeto pai |
|
project.content.scope.excluded_terms[] | stringOpcional / item |
|
project.content.scope.platforms | arrayObrigatório no objeto pai |
|
project.content.scope.platforms[] | stringOpcional / item |
|
project.content.scope.source_categories | arrayObrigatório no objeto pai |
|
project.content.scope.source_categories[] | stringOpcional / item |
|
project.content.scope.languages | arrayObrigatório no objeto pai |
|
project.content.scope.languages[] | stringOpcional / item |
|
project.content.scope.since | string | nullObrigatório no objeto pai | — |
project.content.scope.sinceanyOf 1 | stringObrigatório no objeto pai |
|
project.content.scope.sinceanyOf 2 | nullObrigatório no objeto pai | — |
project.content.scope.until | string | nullObrigatório no objeto pai | — |
project.content.scope.untilanyOf 1 | stringObrigatório no objeto pai |
|
project.content.scope.untilanyOf 2 | nullObrigatório no objeto pai | — |
JSON Schema completo
{
"type": "object",
"properties": {
"project": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"archived": {
"type": "boolean"
},
"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"
},
"updated_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"
},
"content": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"question": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"purpose": {
"type": "string",
"maxLength": 1000
},
"audience": {
"type": "string",
"maxLength": 2000
},
"brands": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"terms": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"required": [
"id",
"name",
"terms"
],
"additionalProperties": false
}
},
"scope": {
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 2000
},
"excluded_terms": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"platforms": {
"maxItems": 7,
"type": "array",
"items": {
"type": "string",
"enum": [
"threads",
"instagram",
"facebook",
"youtube",
"x",
"reddit",
"web"
]
}
},
"source_categories": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"your_accounts",
"public_posts",
"team_notes"
]
}
},
"languages": {
"maxItems": 18,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
"since": {
"anyOf": [
{
"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"
},
{
"type": "null"
}
]
},
"until": {
"anyOf": [
{
"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"
},
{
"type": "null"
}
]
}
},
"required": [
"query",
"excluded_terms",
"platforms",
"source_categories",
"languages",
"since",
"until"
],
"additionalProperties": false
}
},
"required": [
"title",
"question",
"purpose",
"audience",
"brands",
"scope"
],
"additionalProperties": false
}
},
"required": [
"id",
"workspace_id",
"revision",
"archived",
"created_at",
"updated_at",
"content"
],
"additionalProperties": false
}
},
"required": [
"project"
],
"$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_get",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"project": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"archived": false,
"created_at": "2099-01-15T09:00:00Z",
"updated_at": "2099-01-15T09:00:00Z",
"content": {
"title": "example",
"question": "example",
"purpose": "example",
"audience": "example",
"brands": [],
"scope": {
"query": "example",
"excluded_terms": [],
"platforms": [],
"source_categories": [
"your_accounts"
],
"languages": [],
"since": null,
"until": null
}
}
}
}