MCP-Tool

X-Veröffentlichungscredits abrufen

sosoapi_get_x_usage

Lies die von diesem Workspace geteilten Organisations-X-Credits. Benötigt workspace_id. Free erhält einmal 10, Pro 100 je Abrechnungszeitraum. Text kostet 1, Text mit URL 10. Optionaler text berechnet seine Kosten. Liest gespeicherte Kontingente ohne X-API-Aufruf.

Als Markdown lesen

Profile und Transporte

Profile: core, full · Transporte: stdio, http

Wähle core oder full für die sichtbaren Tools deines Clients; dies ändert keine Berechtigungen. Lokaler Dateiupload benötigt stdio und ist über HTTP nicht verfügbar. Setze SOSOAPI_OUTPUT_SCHEMAS=1 für Ausgabeschemas in der Erkennung. Tools liefern unabhängig davon strukturierte Ergebnisse.

Berechtigungen und Nebeneffekte

Annotationen helfen Clients, Tools zu beschreiben. Jeder Aufruf prüft weiterhin Authentifizierung, Rolle, Ressourcenzugriff und erteilte Funktionen des Nutzers.

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

/studio-api/x/usage: agent:operate · synchronous_http_response

Eingabefelder

Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.

Eingabefelder
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	`additionalProperties: false`
`workspace_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"`
`text`	`string`Optional / Element	`maxLength: 4096`

Vollständiges JSON Schema

{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "text": {
      "type": "string",
      "maxLength": 4096
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Strukturierte Ausgabe

Dieses Schema beschreibt structuredContent in einem erfolgreichen Tool-Ergebnis. Die MCP-Antwort enthält auch content und kann bei fehlgeschlagenem Aufruf isError setzen. Lies bei Veröffentlichungen das endgültige Beitragsergebnis, statt eine angenommene Anfrage oder Textantwort als Bestätigung zu werten. Die verknüpfte API-Operation erklärt Berechtigungen und Wiederholungsregeln.

Strukturierte Ausgabe
Feld / Variante	Typ / erforderlich	Einschränkungen
`$`	`object`Im Elternobjekt erforderlich	`additionalProperties: false`
`workspace_id`	`string`Im Elternobjekt erforderlich	`format: "uuid"`
`plan`	`string`Im Elternobjekt erforderlich	`enum: ["free","founding_pro"]`
`allowance`	`string`Im Elternobjekt erforderlich	`enum: ["one_time","monthly"]`
`period_start`	`string`Im Elternobjekt erforderlich	`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`	`string \| null`Im Elternobjekt erforderlich	—
`period_end`anyOf 1	`string`Im Elternobjekt erforderlich	`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 2	`null`Im Elternobjekt erforderlich	—
`limit`	`number`Im Elternobjekt erforderlich	—
`limit`anyOf 1	`number`Im Elternobjekt erforderlich	`const: 10`
`limit`anyOf 2	`number`Im Elternobjekt erforderlich	`const: 100`
`reserved`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`consumed`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`remaining`	`integer`Im Elternobjekt erforderlich	`minimum: 0` `maximum: 9007199254740991`
`costs`	`object`Im Elternobjekt erforderlich	`additionalProperties: false`
`costs.text`	`number`Im Elternobjekt erforderlich	`const: 1`
`costs.with_url`	`number`Im Elternobjekt erforderlich	`const: 10`
`draft_credits`	`number`Optional / Element	—
`draft_credits`anyOf 1	`number`Optional / Element	`const: 1`
`draft_credits`anyOf 2	`number`Optional / Element	`const: 10`

Vollständiges 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
}

Beispiel eines Tool-Aufrufs

Diese Beispiele nutzen anhand der Schemas geprüfte fiktive Werte. Ersetze IDs durch autorisierte IDs, Medien durch bereite Assets und Daten durch bestätigte Veröffentlichungszeiten. Prüfe Kontoeignung vor Schreibvorgängen. Diese Seite sendet keine API-Anfragen.

{
  "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
  }
}

/studio-api/x/usage

MCP installieren oder verbinden