MCP-verktøy
Les oversikt over et valgt forskningskorpus
sosoapi_research_projects_overviewLes deterministiske antall for et nøyaktig forseglet korpus; valgte elementer er ikke publikums- eller markedsstørrelse. Krever agent:research.
Les som MarkdownProfiler og transporter
Profiler: full · Transporter: stdio, http
Velg core eller full for å kontrollere hvilke verktøy klienten ser; dette endrer ikke tillatelsene. Lokal filopplasting krever stdio og er utilgjengelig over HTTP. Angi SOSOAPI_OUTPUT_SCHEMAS=1 for å inkludere utdataskjemaer i oppdagelsen. Verktøy returnerer strukturerte resultater med eller uten den innstillingen.
Tillatelser og sideeffekter
Merknader hjelper klienter med å beskrive et verktøy. Hvert kall kontrollerer fortsatt brukerens autentisering, rolle, ressurstilgang og funksjonstillatelser.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /research-api/projects/overview: agent:research · nøyaktige forskningsressursdata med gjeldende tillatelse
Inndatafelter
Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.
| Felt / gren | Type / påkrevd | Begrensninger |
|---|---|---|
$ | objectPåkrevd i forelder |
|
workspace_id | stringPåkrevd i forelder |
|
project_id | stringPåkrevd i forelder |
|
project_revision | integerPåkrevd i forelder |
|
corpus_snapshot_id | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"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
}Strukturert utdata
Dette skjemaet beskriver structuredContent i et vellykket verktøyresultat. MCP-svaret inkluderer også content og kan sette isError når et kall mislykkes. Ved publisering, les innleggets endelige resultat i stedet for å regne en akseptert forespørsel eller et tekstsvar som bekreftelse. Den lenkede API-operasjonen forklarer tillatelser og regler for nye forsøk.
Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.
| Felt / gren | Type / påkrevd | Begrensninger |
|---|---|---|
$ | objectPåkrevd i forelder |
|
project_id | stringPåkrevd i forelder |
|
project_revision | integerPåkrevd i forelder |
|
corpus_snapshot_id | stringPåkrevd i forelder |
|
method_version | stringPåkrevd i forelder |
|
coverage | stringPåkrevd i forelder |
|
evidence_count | integerPåkrevd i forelder |
|
unique_items | integerPåkrevd i forelder |
|
brand_union_count | integerPåkrevd i forelder |
|
overlap_count | integerPåkrevd i forelder |
|
brands | arrayPåkrevd i forelder |
|
brands[] | objectValgfritt / element |
|
brands[].id | stringPåkrevd i forelder |
|
brands[].name | stringPåkrevd i forelder |
|
brands[].matched_items | integerPåkrevd i forelder |
|
brands[].observed_mention_share | number | nullPåkrevd i forelder | — |
brands[].observed_mention_shareanyOf 1 | numberPåkrevd i forelder |
|
brands[].observed_mention_shareanyOf 2 | nullPåkrevd i forelder | — |
brands[].evidence | arrayPåkrevd i forelder |
|
brands[].evidence[] | objectValgfritt / element |
|
brands[].evidence[].evidence_id | stringPåkrevd i forelder |
|
brands[].evidence[].revision | integerPåkrevd i forelder |
|
languages | arrayPåkrevd i forelder |
|
languages[] | objectValgfritt / element |
|
languages[].language | string | nullPåkrevd i forelder | — |
languages[].languageanyOf 1 | stringPåkrevd i forelder |
|
languages[].languageanyOf 2 | nullPåkrevd i forelder | — |
languages[].item_count | integerPåkrevd i forelder |
|
platforms | arrayPåkrevd i forelder |
|
platforms[] | objectValgfritt / element |
|
platforms[].platform | string | nullPåkrevd i forelder | — |
platforms[].platformanyOf 1 | stringPåkrevd i forelder |
|
platforms[].platformanyOf 2 | nullPåkrevd i forelder | — |
platforms[].item_count | integerPåkrevd i forelder |
|
sources | arrayPåkrevd i forelder |
|
sources[] | objectValgfritt / element |
|
sources[].category | stringPåkrevd i forelder |
|
sources[].item_count | integerPåkrevd i forelder |
|
history | objectPåkrevd i forelder |
|
history.eligible | booleanPåkrevd i forelder |
|
history.reason | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"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
}Eksempel på verktøykall
Disse eksemplene bruker fiktive verdier kontrollert mot skjemaene. Erstatt ID-ene med noen du har lov til å bruke, mediene med klare ressurser og datoene med bekreftet publiseringstidspunkt. Kontroller kontoens kvalifikasjon før en skriveoperasjon sendes inn. Siden sender ingen API-forespørsler.
{
"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"
}
}