MCP-verktøy
Arkiver prosjekt
sosoapi_archive_projectArkiver et prosjekt uten å endre prosjektets planlagte innlegg. For å stoppe et innlegg, avbryt det planlagte innlegget separat. Bare eieren av arbeidsområdet; oppgi expected_lifecycle_version og en idempotency_key.
Les som MarkdownProfiler og transporter
Profiler: 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": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /studio-api/projects/archive: 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 |
|
id | stringPåkrevd i forelder |
|
expected_lifecycle_version | integerPåkrevd i forelder |
|
idempotency_key | stringPåkrevd i forelder |
|
Fullstendig JSON Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"expected_lifecycle_version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"idempotency_key": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"id",
"expected_lifecycle_version",
"idempotency_key"
],
"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 |
|
project | objectPåkrevd i forelder |
|
project.id | stringPåkrevd i forelder |
|
project.workspace_id | stringPåkrevd i forelder |
|
project.name | stringPåkrevd i forelder |
|
project.operational_state | stringPåkrevd i forelder |
|
project.lifecycle_version | integerPåkrevd i forelder |
|
project.defaults_version | integerPåkrevd i forelder |
|
project.archived_at | string | nullPåkrevd i forelder | — |
project.archived_atanyOf 1 | stringPåkrevd i forelder | — |
project.archived_atanyOf 2 | nullPåkrevd i forelder | — |
project.archived_by | string | nullPåkrevd i forelder | — |
project.archived_byanyOf 1 | stringPåkrevd i forelder |
|
project.archived_byanyOf 2 | nullPåkrevd i forelder | — |
project.archived_by_api_key_id | string | nullPåkrevd i forelder | — |
project.archived_by_api_key_idanyOf 1 | stringPåkrevd i forelder |
|
project.archived_by_api_key_idanyOf 2 | nullPåkrevd i forelder | — |
project.created_at | stringPåkrevd i forelder | — |
project.updated_at | stringPåkrevd i forelder | — |
project.version | integerValgfritt / element |
|
receipt_id | stringPåkrevd i forelder |
|
applied | booleanPåkrevd i forelder | — |
deduped | booleanPåkrevd i forelder | — |
held_schedule_count | integerPåkrevd i forelder |
|
Fullstendig 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
},
"receipt_id": {
"type": "string",
"format": "uuid"
},
"applied": {
"type": "boolean"
},
"deduped": {
"type": "boolean"
},
"held_schedule_count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"project",
"receipt_id",
"applied",
"deduped",
"held_schedule_count"
],
"$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_archive_project",
"arguments": {
"id": "11111111-1111-4111-8111-111111111111",
"expected_lifecycle_version": 1,
"idempotency_key": "example-intent-0001"
}
}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"
},
"receipt_id": "11111111-1111-4111-8111-111111111111",
"applied": false,
"deduped": false,
"held_schedule_count": 0
}