Sökningen laddas först när du använder den. Bläddra bland alla kategorier nedan.

MCP-verktyg

Hämta arbetsytekontext

sosoapi_get_workspace_context

Lista arbetsytorna som den inloggade användaren tillhör och vilken som är aktiv. Använd detta när workspace_id är okänt; återanvänd aktuell kontext i stället för att upprepa båda kontextläsningarna. Den aktiva arbetsyta som rapporteras är personens val i webbappen, inte ett standardval för dina anrop: ange workspace_id uttryckligen. Detta är inte enbart en läsning: för ett konto utan arbetsyta skapas den första.

Läs som Markdown

Profiler och transporter

Profiler: core, full · Transporter: stdio, http

Välj core eller full för att styra vilka verktyg klienten ser; detta ändrar inte dess behörigheter. Lokal filuppladdning kräver stdio och är inte tillgänglig via HTTP. Ange SOSOAPI_OUTPUT_SCHEMAS=1 för att inkludera utdatascheman vid identifiering. Verktygen returnerar strukturerade resultat med eller utan inställningen.

Behörigheter och sidoeffekter

Annoteringar hjälper klienter att beskriva ett verktyg. Varje anrop kontrollerar fortfarande användarens autentisering, roll, resursåtkomst och tilldelade funktionsbehörigheter.

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

Indatafält

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

Indatafält
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
include_versionbooleanValfritt / objekt

Valfritt. true lägger till resursversionen i svaret.

—
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Strukturerat resultat

Detta schema beskriver structuredContent i ett lyckat verktygsresultat. MCP-svaret innehåller även content och kan ange isError när ett anrop misslyckas. För publicering ska du läsa inläggets slutresultat i stället för att tolka en accepterad begäran eller ett textsvar som bekräftelse. Den länkade API-åtgärden förklarar behörigheter och regler för nya försök.

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

Strukturerat resultat
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
active_workspace_idstring | nullObligatoriskt i överordnat objekt—
active_workspace_idanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uuid"
active_workspace_idanyOf 2nullObligatoriskt i överordnat objekt—
workspacesarrayObligatoriskt i överordnat objekt—
workspaces[]objectValfritt / objekt
  • additionalProperties: false
workspaces[].idstringObligatoriskt i överordnat objekt
  • format: "uuid"
workspaces[].slugstringObligatoriskt i överordnat objekt—
workspaces[].namestringObligatoriskt i överordnat objekt—
workspaces[].rolestringObligatoriskt i överordnat objekt
  • enum: ["owner","editor","reviewer","viewer"]
workspaces[].versionintegerValfritt / objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "active_workspace_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "editor",
              "reviewer",
              "viewer"
            ]
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "role"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "active_workspace_id",
    "workspaces"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Exempel på verktygsanrop

Exemplen använder fiktiva värden som kontrollerats mot schemana. Ersätt ID:n med sådana du får använda, medier med färdiga mediefiler och datum med din bekräftade publiceringstid. Kontrollera kontots behörighet före en skrivning. Denna sida skickar inga API-anrop.

{
  "name": "sosoapi_get_workspace_context",
  "arguments": {}
}

structuredContent

{
  "active_workspace_id": null,
  "workspaces": []
}
Installera eller anslut MCP