MCP-verktøy
Hent X-publiseringskreditter
sosoapi_get_x_usageLes organisasjonens X-publiseringskreditter som deles av dette arbeidsområdet. Krever workspace_id. Free får 10 én gang; Pro får 100 per faktureringsperiode. Tekst koster 1, tekst med en URL koster 10. Valgfri text beregner kostnaden. Dette leser den lagrede kvoten og kaller ikke X API.
Les som MarkdownProfiler og transporter
Profiler: core, 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": false
}- /studio-api/x/usage: agent:operate · synchronous_http_response
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 |
|
text | stringValgfritt / element |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"text": {
"type": "string",
"maxLength": 4096
}
},
"required": [
"workspace_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 |
|
workspace_id | stringPåkrevd i forelder |
|
plan | stringPåkrevd i forelder |
|
allowance | stringPåkrevd i forelder |
|
period_start | stringPåkrevd i forelder |
|
period_end | string | nullPåkrevd i forelder | — |
period_endanyOf 1 | stringPåkrevd i forelder |
|
period_endanyOf 2 | nullPåkrevd i forelder | — |
limit | numberPåkrevd i forelder | — |
limitanyOf 1 | numberPåkrevd i forelder |
|
limitanyOf 2 | numberPåkrevd i forelder |
|
reserved | integerPåkrevd i forelder |
|
consumed | integerPåkrevd i forelder |
|
remaining | integerPåkrevd i forelder |
|
costs | objectPåkrevd i forelder |
|
costs.text | numberPåkrevd i forelder |
|
costs.with_url | numberPåkrevd i forelder |
|
draft_credits | numberValgfritt / element | — |
draft_creditsanyOf 1 | numberValgfritt / element |
|
draft_creditsanyOf 2 | numberValgfritt / element |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "string",
"enum": [
"free",
"founding_pro"
]
},
"allowance": {
"type": "string",
"enum": [
"one_time",
"monthly"
]
},
"period_start": {
"type": "string",
"format": "date-time",
"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)))$"
},
"period_end": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"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)))$"
},
{
"type": "null"
}
]
},
"limit": {
"anyOf": [
{
"type": "number",
"const": 10
},
{
"type": "number",
"const": 100
}
]
},
"reserved": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"consumed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"remaining": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"costs": {
"type": "object",
"properties": {
"text": {
"type": "number",
"const": 1
},
"with_url": {
"type": "number",
"const": 10
}
},
"required": [
"text",
"with_url"
],
"additionalProperties": false
},
"draft_credits": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 10
}
]
}
},
"required": [
"workspace_id",
"plan",
"allowance",
"period_start",
"period_end",
"limit",
"reserved",
"consumed",
"remaining",
"costs"
],
"$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_get_x_usage",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"plan": "free",
"allowance": "one_time",
"period_start": "2099-01-15T09:00:00Z",
"period_end": null,
"limit": 10,
"reserved": 0,
"consumed": 0,
"remaining": 0,
"costs": {
"text": 1,
"with_url": 10
}
}