MCP-verktøy

Vis API-nøkler

sosoapi_list_api_keys

Vis brukerens API-nøkler (navn, siste 4 tegn, status, utløp, avstamning); angi include_authority for også å hente funksjonene og arbeidsområdebegrensningen til hver nøkkel. Hemmeligheter returneres aldri. 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": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

/identity-api/api-keys/list: 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`
`include_revoked`	`boolean`Valgfritt / element	—
`include_authority`	`boolean`Valgfritt / element	Returner også funksjonene til hver nøkkel, arbeidsområdebegrensningen (null = alle arbeidsområder) og den delegerte tillatelsen som opprettet den. —

Fullstendig JSON Schema

{
  "type": "object",
  "properties": {
    "include_revoked": {
      "type": "boolean"
    },
    "include_authority": {
      "description": "Also return each key's capabilities, Workspace limit (null = every Workspace) and the delegated grant that created it.",
      "type": "boolean"
    }
  },
  "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`
`apiKeys`	`array`Påkrevd i forelder	—
`apiKeys[]`	`object`Valgfritt / element	`additionalProperties: false`
`apiKeys[].id`	`string`Påkrevd i forelder	`format: "uuid"`
`apiKeys[].name`	`string`Påkrevd i forelder	—
`apiKeys[].last_4`	`string`Påkrevd i forelder	—
`apiKeys[].scopes`	`array`Påkrevd i forelder	—
`apiKeys[].scopes[]`	`string`Valgfritt / element	—
`apiKeys[].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)))$"`
`apiKeys[].expires_at`	`string \| null`Påkrevd i forelder	—
`apiKeys[].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)))$"`
`apiKeys[].expires_at`anyOf 2	`null`Påkrevd i forelder	—
`apiKeys[].last_used_at`	`string \| null`Påkrevd i forelder	—
`apiKeys[].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)))$"`
`apiKeys[].last_used_at`anyOf 2	`null`Påkrevd i forelder	—
`apiKeys[].revoked_at`	`string \| null`Påkrevd i forelder	—
`apiKeys[].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)))$"`
`apiKeys[].revoked_at`anyOf 2	`null`Påkrevd i forelder	—
`apiKeys[].status`	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`	`object \| null`Påkrevd i forelder	—
`apiKeys[].replaces`anyOf 1	`object`Påkrevd i forelder	`additionalProperties: false`
`apiKeys[].replaces.id`anyOf 1	`string`Påkrevd i forelder	`format: "uuid"`
`apiKeys[].replaces.name`anyOf 1	`string`Påkrevd i forelder	—
`apiKeys[].replaces.last_4`anyOf 1	`string`Påkrevd i forelder	—
`apiKeys[].replaces.status`anyOf 1	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`anyOf 2	`null`Påkrevd i forelder	—
`apiKeys[].replaced_by`	`array`Påkrevd i forelder	—
`apiKeys[].replaced_by[]`	`object`Valgfritt / element	`additionalProperties: false`
`apiKeys[].replaced_by[].id`	`string`Påkrevd i forelder	`format: "uuid"`
`apiKeys[].replaced_by[].name`	`string`Påkrevd i forelder	—
`apiKeys[].replaced_by[].last_4`	`string`Påkrevd i forelder	—
`apiKeys[].replaced_by[].status`	`string`Påkrevd i forelder	`enum: ["active","expired","revoked"]`
`apiKeys[].capabilities`	`array`Valgfritt / element	—
`apiKeys[].capabilities[]`	`string`Valgfritt / element	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKeys[].workspace_ids`	`array \| null`Valgfritt / element	—
`apiKeys[].workspace_ids`anyOf 1	`array`Valgfritt / element	—
`apiKeys[].workspace_ids[]`anyOf 1	`string`Valgfritt / element	`format: "uuid"`
`apiKeys[].workspace_ids`anyOf 2	`null`Valgfritt / element	—
`apiKeys[].created_by_delegated_grant_id`	`string \| null`Valgfritt / element	—
`apiKeys[].created_by_delegated_grant_id`anyOf 1	`string`Valgfritt / element	`format: "uuid"`
`apiKeys[].created_by_delegated_grant_id`anyOf 2	`null`Valgfritt / element	—

Fullstendig JSON Schema

{
  "type": "object",
  "properties": {
    "apiKeys": {
      "type": "array",
      "items": {
        "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
      }
    }
  },
  "required": [
    "apiKeys"
  ],
  "$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_list_api_keys",
  "arguments": {}
}

structuredContent

{
  "apiKeys": []
}

/identity-api/api-keys/list

Installer eller koble til MCP