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

MCP-verktyg

Lista projekt

sosoapi_list_projects

Lista en arbetsytas projekt (ett valfritt lager för ursprung och kontostandarder) och vilket som är aktivt.

Läs som Markdown

Profiler och transporter

Profiler: 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": true,
  "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
workspace_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
limitintegerValfritt / objekt

Sidstorlek, 1 till 100. Att skicka limit eller cursor växlar rutten till markörbaserad sidindelning och lägger till next_cursor i svaret.

  • minimum: 1
  • maximum: 100
cursorstringValfritt / objekt

Ogenomskinlig markör: föregående sidas next_cursor, oförändrad. Utelämna den på första sidan. Samma filter måste skickas med varje sida.

  • minLength: 1
  • maxLength: 512
include_versionbooleanValfritt / objekt

Valfritt. true lägger till resursversionen i svaret.

—
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id"
  ],
  "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
projectsarrayObligatoriskt i överordnat objekt—
projects[]objectValfritt / objekt
  • additionalProperties: false
projects[].idstringObligatoriskt i överordnat objekt
  • format: "uuid"
projects[].workspace_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
projects[].namestringObligatoriskt i överordnat objekt
  • minLength: 1
  • maxLength: 200
projects[].operational_statestringObligatoriskt i överordnat objekt
  • enum: ["active","archived"]
projects[].lifecycle_versionintegerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
projects[].defaults_versionintegerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
projects[].archived_atstring | nullObligatoriskt i överordnat objekt—
projects[].archived_atanyOf 1stringObligatoriskt i överordnat objekt—
projects[].archived_atanyOf 2nullObligatoriskt i överordnat objekt—
projects[].archived_bystring | nullObligatoriskt i överordnat objekt—
projects[].archived_byanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uuid"
projects[].archived_byanyOf 2nullObligatoriskt i överordnat objekt—
projects[].archived_by_api_key_idstring | nullObligatoriskt i överordnat objekt—
projects[].archived_by_api_key_idanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uuid"
projects[].archived_by_api_key_idanyOf 2nullObligatoriskt i överordnat objekt—
projects[].created_atstringObligatoriskt i överordnat objekt—
projects[].updated_atstringObligatoriskt i överordnat objekt—
projects[].versionintegerValfritt / objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
active_project_idstring | nullObligatoriskt i överordnat objekt—
active_project_idanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uuid"
active_project_idanyOf 2nullObligatoriskt i överordnat objekt—
next_cursorstring | nullValfritt / objekt

Finns endast när begäran skickade limit eller cursor. Null på sista sidan.

—
next_cursoranyOf 1stringValfritt / objekt—
next_cursoranyOf 2nullValfritt / objekt—
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "workspace_id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "operational_state": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "lifecycle_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "defaults_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "archived_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "archived_by": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "archived_by_api_key_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "id",
          "workspace_id",
          "name",
          "operational_state",
          "lifecycle_version",
          "defaults_version",
          "archived_at",
          "archived_by",
          "archived_by_api_key_id",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "active_project_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ]
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "projects",
    "active_project_id"
  ],
  "$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_list_projects",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "projects": [],
  "active_project_id": null
}
Installera eller anslut MCP