MCP-verktøy

Opprett API-nøkkel

sosoapi_create_api_key

Opprett en personlig tilgangsnøkkel med valgte funksjoner (agent:operate, agent:publish, agent:engage), valgfri workspace_ids-begrensning og levetid på opptil 365 dager; hemmeligheten returneres én gang og kan ikke leses igjen. En agent kan bare gi det dens egen autorisasjon omfatter, i høyst 30 dager, og nøkkelen slutter å virke når tillatelsen utløper. Krever tillatelsen Administrer API-nøkler; en PAT kan ikke bruke dette.

Les som Markdown

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

/identity-api/api-keys/create: agent:manage_api_keys · 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.

Inndatafelter
Felt / gren	Type / påkrevd	Begrensninger
`$`	`object`Påkrevd i forelder	`additionalProperties: false`
`name`	`string`Påkrevd i forelder	`minLength: 1` `maxLength: 80`
`lifetime_days`	`integer`Valgfritt / element	Dager til nøkkelen utløper (1-365, standard 365). En nøkkel opprettet av en delegert agent varer aldri lenger enn 30 dager. `minimum: 1` `maximum: 365`
`capabilities`	`array`Valgfritt / element	Hva nøkkelen kan gjøre. Standard er operate, publish og engage for en innlogget bruker. En delegert agent kan bare gi det dens egen autorisasjon omfatter (aldri nøkkeladministrasjon). `minItems: 1` `maxItems: 3`
`capabilities[]`	`string`Valgfritt / element	`enum: ["agent:operate","agent:publish","agent:engage"]`
`workspace_ids`	`array`Valgfritt / element	Begrens nøkkelen til disse arbeidsområdene. Utelat for alle arbeidsområder brukeren har tilgang til. En begrenset nøkkel må navngi arbeidsområdet (workspace_id) på ruter som ellers bruker aktivt arbeidsområde, og kan ikke kalle lesinger for hele organisasjonen. `minItems: 1` `maxItems: 100`
`workspace_ids[]`	`string`Valgfritt / element	`format: "uuid"`
`scopes`	`array`Valgfritt / element	Utfaset alias for capabilities. Det respekteres nøyaktig; en tom liste ignoreres. `maxItems: 3`
`scopes[]`	`string`Valgfritt / element	`enum: ["agent:operate","agent:publish","agent:engage"]`
`idempotency_key`	`string`Valgfritt / element	Valgfritt. Gjenbruk samme nøkkel for å prøve igjen trygt. Hemmeligheten vises én gang: et nytt forsøk som finner nøkkelen allerede opprettet, svarer 409 IDEMPOTENT_REPLAY (details.existing_key navngir den) i stedet for å vise den igjen. Tilbakekall den nøkkelen og opprett en ny med en ny idempotency_key. `minLength: 8` `maxLength: 160` `pattern: "^[!-~]+$"`

Fullstendig 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
}

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.

Strukturert utdata
Felt / gren	Type / påkrevd	Begrensninger
`$`	`object`Påkrevd i forelder	`additionalProperties: false`
`apiKey`	`object`Påkrevd i forelder	`additionalProperties: false`
`apiKey.id`	`string`Påkrevd i forelder	`format: "uuid"`
`apiKey.name`	`string`Påkrevd i forelder	—
`apiKey.last_4`	`string`Påkrevd i forelder	—
`apiKey.scopes`	`array`Påkrevd i forelder	—
`apiKey.scopes[]`	`string`Valgfritt / element	—
`apiKey.created_at`	`string`Påkrevd i forelder	`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`Påkrevd i forelder	—
`apiKey.expires_at`anyOf 1	`string`Påkrevd i forelder	`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`Påkrevd i forelder	—
`apiKey.last_used_at`	`string \| null`Påkrevd i forelder	—
`apiKey.last_used_at`anyOf 1	`string`Påkrevd i forelder	`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`Påkrevd i forelder	—
`apiKey.revoked_at`	`string \| null`Påkrevd i forelder	—
`apiKey.revoked_at`anyOf 1	`string`Påkrevd i forelder	`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`Påkrevd i forelder	—
`apiKey.status`	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKey.replaces`	`object \| null`Påkrevd i forelder	—
`apiKey.replaces`anyOf 1	`object`Påkrevd i forelder	`additionalProperties: false`
`apiKey.replaces.id`anyOf 1	`string`Påkrevd i forelder	`format: "uuid"`
`apiKey.replaces.name`anyOf 1	`string`Påkrevd i forelder	—
`apiKey.replaces.last_4`anyOf 1	`string`Påkrevd i forelder	—
`apiKey.replaces.status`anyOf 1	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKey.replaces`anyOf 2	`null`Påkrevd i forelder	—
`apiKey.replaced_by`	`array`Påkrevd i forelder	—
`apiKey.replaced_by[]`	`object`Valgfritt / element	`additionalProperties: false`
`apiKey.replaced_by[].id`	`string`Påkrevd i forelder	`format: "uuid"`
`apiKey.replaced_by[].name`	`string`Påkrevd i forelder	—
`apiKey.replaced_by[].last_4`	`string`Påkrevd i forelder	—
`apiKey.replaced_by[].status`	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKey.capabilities`	`array`Valgfritt / element	—
`apiKey.capabilities[]`	`string`Valgfritt / element	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKey.workspace_ids`	`array \| null`Valgfritt / element	—
`apiKey.workspace_ids`anyOf 1	`array`Valgfritt / element	—
`apiKey.workspace_ids[]`anyOf 1	`string`Valgfritt / element	`format: "uuid"`
`apiKey.workspace_ids`anyOf 2	`null`Valgfritt / element	—
`apiKey.created_by_delegated_grant_id`	`string \| null`Valgfritt / element	—
`apiKey.created_by_delegated_grant_id`anyOf 1	`string`Valgfritt / element	`format: "uuid"`
`apiKey.created_by_delegated_grant_id`anyOf 2	`null`Valgfritt / element	—
`secret`	`string`Påkrevd i forelder	`minLength: 1`

Fullstendig 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
}

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_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

Installer eller koble til MCP