MCP-verktyg

Hämta projekt

sosoapi_get_project

Läs ett projekt via id: namn, livscykelstatus och de livscykel- och standardversioner som senare skrivningar behöver.

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
}

/studio-api/projects/get: agent:operate · synchronous_http_response

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 / gren	Typ / obligatoriskt	Begränsningar
`$`	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`id`	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`include_version`	`boolean`Valfritt / objekt	Valfritt. true lägger till resursversionen i svaret. —

Fullständigt JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "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.

Strukturerat resultat
Fält / gren	Typ / obligatoriskt	Begränsningar
`$`	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`project`	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`project.id`	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`project.workspace_id`	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`project.name`	`string`Obligatoriskt i överordnat objekt	`minLength: 1` `maxLength: 200`
`project.operational_state`	`string`Obligatoriskt i överordnat objekt	`enum: ["active","archived"]`
`project.lifecycle_version`	`integer`Obligatoriskt i överordnat objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`project.defaults_version`	`integer`Obligatoriskt i överordnat objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`project.archived_at`	`string \| null`Obligatoriskt i överordnat objekt	—
`project.archived_at`anyOf 1	`string`Obligatoriskt i överordnat objekt	—
`project.archived_at`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`project.archived_by`	`string \| null`Obligatoriskt i överordnat objekt	—
`project.archived_by`anyOf 1	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`project.archived_by`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`project.archived_by_api_key_id`	`string \| null`Obligatoriskt i överordnat objekt	—
`project.archived_by_api_key_id`anyOf 1	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`project.archived_by_api_key_id`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`project.created_at`	`string`Obligatoriskt i överordnat objekt	—
`project.updated_at`	`string`Obligatoriskt i överordnat objekt	—
`project.version`	`integer`Valfritt / objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`

Fullständigt JSON Schema

{
  "type": "object",
  "properties": {
    "project": {
      "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
    }
  },
  "required": [
    "project"
  ],
  "$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_project",
  "arguments": {
    "id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "project": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "operational_state": "active",
    "lifecycle_version": 1,
    "defaults_version": 1,
    "archived_at": null,
    "archived_by": null,
    "archived_by_api_key_id": null,
    "created_at": "example",
    "updated_at": "example"
  }
}

/studio-api/projects/get

Installera eller anslut MCP