MCP-verktøy
Utfør handling for privat melding
sosoapi_dm_actions_applyBruk ett klargjort token for svar på en privat melding med en stabil idempotency_key. Ved tapt svar gjenoppretter du status med samme nøkkel; klargjør aldri en erstatning.
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": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /private-messaging-api/actions/apply: agent:dm_reply · endelig leverandørkvittering
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 |
|
social_account_id | stringPåkrevd i forelder |
|
prepare_token | stringPåkrevd i forelder |
|
idempotency_key | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"prepare_token": {
"type": "string",
"minLength": 40,
"maxLength": 128
},
"idempotency_key": {
"type": "string",
"format": "uuid"
}
},
"required": [
"workspace_id",
"social_account_id",
"prepare_token",
"idempotency_key"
],
"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 |
|
contract_version | stringPåkrevd i forelder |
|
action | objectPåkrevd i forelder |
|
action.id | stringPåkrevd i forelder |
|
action.conversation_id | stringPåkrevd i forelder |
|
action.status | stringPåkrevd i forelder |
|
action.provider_message_id | string | nullPåkrevd i forelder | — |
action.reason | string | nullPåkrevd i forelder | — |
action.created_at | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "private-messaging/v1"
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"conversation_id": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"queued",
"claimed",
"sending",
"sent",
"unknown",
"failed",
"cancelled"
]
},
"provider_message_id": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"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"
}
},
"required": [
"id",
"conversation_id",
"status",
"provider_message_id",
"reason",
"created_at"
],
"additionalProperties": false
}
},
"required": [
"contract_version",
"action"
],
"$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_dm_actions_apply",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"idempotency_key": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"contract_version": "private-messaging/v1",
"action": {
"id": "11111111-1111-4111-8111-111111111111",
"conversation_id": "11111111-1111-4111-8111-111111111111",
"status": "queued",
"provider_message_id": "example",
"reason": "example",
"created_at": "2099-01-15T09:00:00Z"
}
}