MCP-verktøy
Les en lyttestrøm
sosoapi_listening_streams_getLes én lyttestrøm, dens ikke-klarerte søketekst og gjeldende innsamlingstillatelse. 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
}- /listening-api/streams/get: agent:research · lyttedata med gjeldende tillatelse; det indekserte offentlige utvalget er delvis og er ikke en bekreftet kontoomtale
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 |
|
id | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id",
"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 |
|
stream | objectPåkrevd i forelder |
|
stream.id | stringPåkrevd i forelder |
|
stream.workspace_id | stringPåkrevd i forelder |
|
stream.revision | integerPåkrevd i forelder |
|
stream.query_revision | integerPåkrevd i forelder |
|
stream.generation | integerPåkrevd i forelder |
|
stream.source | stringPåkrevd i forelder |
|
stream.content | objectPåkrevd i forelder |
|
stream.content.name | stringPåkrevd i forelder |
|
stream.content.query | stringPåkrevd i forelder |
|
stream.content.source_overrides | objectPåkrevd i forelder |
|
stream.content.source_overrides.hacker_news | stringValgfritt / element |
|
stream.content.include_terms | arrayPåkrevd i forelder |
|
stream.content.include_terms[] | stringValgfritt / element |
|
stream.content.exclude_terms | arrayPåkrevd i forelder |
|
stream.content.exclude_terms[] | stringValgfritt / element |
|
stream.content.item_types | arrayPåkrevd i forelder |
|
stream.content.item_types[] | stringValgfritt / element |
|
stream.content.cadence_minutes | integerPåkrevd i forelder |
|
stream.content.lookback_days | integerPåkrevd i forelder |
|
stream.state | stringPåkrevd i forelder |
|
stream.authorization_expires_at | string | nullPåkrevd i forelder | — |
stream.authorization_expires_atanyOf 1 | stringPåkrevd i forelder |
|
stream.authorization_expires_atanyOf 2 | nullPåkrevd i forelder | — |
stream.last_attempt_at | string | nullPåkrevd i forelder | — |
stream.last_attempt_atanyOf 1 | stringPåkrevd i forelder |
|
stream.last_attempt_atanyOf 2 | nullPåkrevd i forelder | — |
stream.last_success_at | string | nullPåkrevd i forelder | — |
stream.last_success_atanyOf 1 | stringPåkrevd i forelder |
|
stream.last_success_atanyOf 2 | nullPåkrevd i forelder | — |
stream.next_due_at | string | nullPåkrevd i forelder | — |
stream.next_due_atanyOf 1 | stringPåkrevd i forelder |
|
stream.next_due_atanyOf 2 | nullPåkrevd i forelder | — |
stream.created_at | stringPåkrevd i forelder |
|
stream.updated_at | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"stream": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"query_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"generation": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"const": "hacker_news"
},
"content": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"query": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_overrides": {
"default": {},
"type": "object",
"properties": {
"hacker_news": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"additionalProperties": false
},
"include_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"exclude_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"item_types": {
"default": [
"story",
"comment"
],
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"story",
"comment"
]
}
},
"cadence_minutes": {
"default": 60,
"type": "integer",
"minimum": 30,
"maximum": 1440
},
"lookback_days": {
"default": 7,
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"required": [
"name",
"query",
"source_overrides",
"include_terms",
"exclude_terms",
"item_types",
"cadence_minutes",
"lookback_days"
],
"additionalProperties": false
},
"state": {
"type": "string",
"enum": [
"active",
"paused",
"needs_reauthorization",
"deleted"
]
},
"authorization_expires_at": {
"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"
}
]
},
"last_attempt_at": {
"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"
}
]
},
"last_success_at": {
"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"
}
]
},
"next_due_at": {
"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"
}
]
},
"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"
}
},
"required": [
"id",
"workspace_id",
"revision",
"query_revision",
"generation",
"source",
"content",
"state",
"authorization_expires_at",
"last_attempt_at",
"last_success_at",
"next_due_at",
"created_at",
"updated_at"
],
"additionalProperties": false
}
},
"required": [
"stream"
],
"$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_listening_streams_get",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"stream": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"query_revision": 1,
"generation": 1,
"source": "hacker_news",
"content": {
"name": "example",
"query": "example",
"source_overrides": {},
"include_terms": [],
"exclude_terms": [],
"item_types": [
"story",
"comment"
],
"cadence_minutes": 60,
"lookback_days": 7
},
"state": "active",
"authorization_expires_at": null,
"last_attempt_at": null,
"last_success_at": null,
"next_due_at": null,
"created_at": "2099-01-15T09:00:00Z",
"updated_at": "2099-01-15T09:00:00Z"
}
}