MCP-verktyg

Skapa API-nyckel

sosoapi_create_api_key

Skapa en personlig åtkomstnyckel med valda funktioner (agent:operate, agent:publish, agent:engage), valfri workspace_ids-gräns och en livslängd på upp till 365 dagar; hemligheten returneras en gång och kan inte läsas igen. En agent kan bara tilldela det som dess egen auktorisering omfattar, i högst 30 dagar, och nyckeln slutar fungera när behörigheten upphör. Kräver behörigheten Hantera API-nycklar; en PAT kan inte använda den.

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": false,
  "destructiveHint": false,
  "idempotentHint": false,
  "openWorldHint": false
}

/identity-api/api-keys/create: agent:manage_api_keys · 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`
`name`	`string`Obligatoriskt i överordnat objekt	`minLength: 1` `maxLength: 80`
`lifetime_days`	`integer`Valfritt / objekt	Dagar tills nyckeln löper ut (1-365, standard 365). En nyckel skapad av en delegerad agent gäller aldrig längre än 30 dagar. `minimum: 1` `maximum: 365`
`capabilities`	`array`Valfritt / objekt	Vad nyckeln får göra. Standard för en inloggad användare är operate, publish och engage. En delegerad agent kan endast tilldela det som dess egen auktorisering omfattar (aldrig nyckelhantering). `minItems: 1` `maxItems: 3`
`capabilities[]`	`string`Valfritt / objekt	`enum: ["agent:operate","agent:publish","agent:engage"]`
`workspace_ids`	`array`Valfritt / objekt	Begränsa nyckeln till dessa arbetsytor. Utelämna för alla arbetsytor användaren får komma åt. En begränsad nyckel måste ange sin arbetsyta (workspace_id) på rutter som annars använder aktiv arbetsyta och kan inte göra organisationsövergripande läsningar. `minItems: 1` `maxItems: 100`
`workspace_ids[]`	`string`Valfritt / objekt	`format: "uuid"`
`scopes`	`array`Valfritt / objekt	Utfasat alias för capabilities. Det följs exakt; en tom lista ignoreras. `maxItems: 3`
`scopes[]`	`string`Valfritt / objekt	`enum: ["agent:operate","agent:publish","agent:engage"]`
`idempotency_key`	`string`Valfritt / objekt	Valfritt. Återanvänd samma nyckel för ett säkert nytt försök. Hemligheten visas en gång: ett nytt försök som hittar en redan skapad nyckel svarar 409 IDEMPOTENT_REPLAY (details.existing_key anger den) i stället för att visa den igen. Återkalla den nyckeln och skapa en ny med en ny idempotency_key. `minLength: 8` `maxLength: 160` `pattern: "^[!-~]+$"`

Fullständigt JSON Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "lifetime_days": {
      "description": "Days until the key expires (1-365, default 365). A key created by a delegated agent never lives longer than 30 days.",
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    },
    "capabilities": {
      "description": "What the key may do. Defaults to operate, publish and engage for a signed-in user. A delegated agent can only grant what its own authorization holds (never key management).",
      "minItems": 1,
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "agent:operate",
          "agent:publish",
          "agent:engage"
        ]
      }
    },
    "workspace_ids": {
      "description": "Limit the key to these Workspaces. Omit it for every Workspace the user can access. A limited key must name its Workspace (workspace_id) on routes that would otherwise use the active Workspace, and cannot call organization-wide reads.",
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "scopes": {
      "description": "Deprecated alias of capabilities. It is honoured exactly; an empty list is ignored.",
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "agent:operate",
          "agent:publish",
          "agent:engage"
        ]
      }
    },
    "idempotency_key": {
      "description": "Optional. Reuse the same key to retry safely. The secret is shown once: a retry that finds the key already created answers 409 IDEMPOTENT_REPLAY (details.existing_key names it) instead of showing it again. Revoke that key and create a new one with a new idempotency_key.",
      "type": "string",
      "minLength": 8,
      "maxLength": 160,
      "pattern": "^[!-~]+$"
    }
  },
  "required": [
    "name"
  ],
  "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`
`apiKey`	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`apiKey.id`	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`apiKey.name`	`string`Obligatoriskt i överordnat objekt	—
`apiKey.last_4`	`string`Obligatoriskt i överordnat objekt	—
`apiKey.scopes`	`array`Obligatoriskt i överordnat objekt	—
`apiKey.scopes[]`	`string`Valfritt / objekt	—
`apiKey.created_at`	`string`Obligatoriskt i överordnat objekt	`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)))$"`
`apiKey.expires_at`	`string \| null`Obligatoriskt i överordnat objekt	—
`apiKey.expires_at`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)))$"`
`apiKey.expires_at`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`apiKey.last_used_at`	`string \| null`Obligatoriskt i överordnat objekt	—
`apiKey.last_used_at`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)))$"`
`apiKey.last_used_at`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`apiKey.revoked_at`	`string \| null`Obligatoriskt i överordnat objekt	—
`apiKey.revoked_at`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)))$"`
`apiKey.revoked_at`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`apiKey.status`	`string`Obligatoriskt i överordnat objekt	`enum: ["active","expired","revoked"]`
`apiKey.replaces`	`object \| null`Obligatoriskt i överordnat objekt	—
`apiKey.replaces`anyOf 1	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`apiKey.replaces.id`anyOf 1	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`apiKey.replaces.name`anyOf 1	`string`Obligatoriskt i överordnat objekt	—
`apiKey.replaces.last_4`anyOf 1	`string`Obligatoriskt i överordnat objekt	—
`apiKey.replaces.status`anyOf 1	`string`Obligatoriskt i överordnat objekt	`enum: ["active","expired","revoked"]`
`apiKey.replaces`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`apiKey.replaced_by`	`array`Obligatoriskt i överordnat objekt	—
`apiKey.replaced_by[]`	`object`Valfritt / objekt	`additionalProperties: false`
`apiKey.replaced_by[].id`	`string`Obligatoriskt i överordnat objekt	`format: "uuid"`
`apiKey.replaced_by[].name`	`string`Obligatoriskt i överordnat objekt	—
`apiKey.replaced_by[].last_4`	`string`Obligatoriskt i överordnat objekt	—
`apiKey.replaced_by[].status`	`string`Obligatoriskt i överordnat objekt	`enum: ["active","expired","revoked"]`
`apiKey.capabilities`	`array`Valfritt / objekt	—
`apiKey.capabilities[]`	`string`Valfritt / objekt	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKey.workspace_ids`	`array \| null`Valfritt / objekt	—
`apiKey.workspace_ids`anyOf 1	`array`Valfritt / objekt	—
`apiKey.workspace_ids[]`anyOf 1	`string`Valfritt / objekt	`format: "uuid"`
`apiKey.workspace_ids`anyOf 2	`null`Valfritt / objekt	—
`apiKey.created_by_delegated_grant_id`	`string \| null`Valfritt / objekt	—
`apiKey.created_by_delegated_grant_id`anyOf 1	`string`Valfritt / objekt	`format: "uuid"`
`apiKey.created_by_delegated_grant_id`anyOf 2	`null`Valfritt / objekt	—
`secret`	`string`Obligatoriskt i överordnat objekt	`minLength: 1`

Fullständigt JSON Schema

{
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "last_4": {
          "type": "string"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "created_at": {
          "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)))$"
        },
        "expires_at": {
          "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"
            }
          ]
        },
        "last_used_at": {
          "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"
            }
          ]
        },
        "revoked_at": {
          "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"
            }
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "expired",
            "revoked"
          ]
        },
        "replaces": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string"
                },
                "last_4": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "active",
                    "expired",
                    "revoked"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "last_4",
                "status"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "replaced_by": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "name": {
                "type": "string"
              },
              "last_4": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "expired",
                  "revoked"
                ]
              }
            },
            "required": [
              "id",
              "name",
              "last_4",
              "status"
            ],
            "additionalProperties": false
          }
        },
        "capabilities": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "agent:operate",
              "agent:publish",
              "agent:engage"
            ]
          }
        },
        "workspace_ids": {
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "created_by_delegated_grant_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "name",
        "last_4",
        "scopes",
        "created_at",
        "expires_at",
        "last_used_at",
        "revoked_at",
        "status",
        "replaces",
        "replaced_by"
      ],
      "additionalProperties": false
    },
    "secret": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "apiKey",
    "secret"
  ],
  "$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_create_api_key",
  "arguments": {
    "name": "example"
  }
}

structuredContent

{
  "apiKey": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "example",
    "last_4": "example",
    "scopes": [],
    "created_at": "2099-01-15T09:00:00Z",
    "expires_at": null,
    "last_used_at": null,
    "revoked_at": null,
    "status": "active",
    "replaces": null,
    "replaced_by": []
  },
  "secret": "example"
}

/identity-api/api-keys/create

Installera eller anslut MCP