> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tool registrieren

> Registrieren Sie ein Tool im MAIP-Tool-Register mit Bereichsanforderungen, Risikoklassifizierung und Ratenbegrenzungen

# Tool registrieren

`POST /v1/tools`

Registriert ein neues Tool im MAIP-Tool-Register des Mandanten. Tools repräsentieren externe Fähigkeiten (APIs, Funktionen, Dienste), die Maschinenagenten aufrufen können. Jedes Tool ist mit einem erforderlichen Geltungsbereich, einem Risikograd und einem optionalen Genehmigungs-Gate verbunden.

Die Plattform erhöht das Risikoniveau automatisch auf `"high"`, wenn der Toolname oder der erforderliche Umfang gefährliche Aktionsverben (schreiben, löschen, senden, ausführen, bereitstellen, zerstören, löschen, kürzen) enthält.

> [!NOTE]
>
> Werkzeugnamen müssen pro Mandant eindeutig sein. Der Versuch, ein Werkzeug mit einem
> Name, der bereits existiert, gibt `409 Conflict` zurück.

### Authentifizierung

Erfordert `X-API-Key` Header oder Bearer JWT Token. Der Arbeitsbereich wird aus den authentifizierten Anmeldeinformationen abgeleitet; senden Sie `X-Tenant-ID` nicht.

### Antwort

**id** `string`

UUID des neu registrierten Werkzeugs.

**tenant\_id** `string`

UUID des besitzenden Mandanten.

**name** `string`

Maschinenlesbarer Toolname.

**display\_name** `string`

Menschenlesbarer Toolname.

**description** `string`

Werkzeugbeschreibung.

**scope\_required** `string`

Erforderlicher Bereich für den Aufruf.

**risk\_level** `string`

Effektive Risikoklassifizierung (kann automatisch erhöht werden).

**requires\_approval** `boolean`

Ob eine menschliche Genehmigung erforderlich ist.

**rate\_limit\_per\_minute** `integer`

Ratenbegrenzung pro Agent.

**category** `string`

Werkzeugkategorie.

**status** `string`

Werkzeugstatus. Bei der Erstellung immer `"active"`.

**metadata** `object`

Werkzeugmetadaten.

**created\_at** `string`

ISO 8601 Erstellungszeitstempel.

**updated\_at** `string`

ISO 8601 Zeitstempel der letzten Aktualisierung.

### Beispiel

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/tools \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "search.web",
    "display_name": "Web Search",
    "description": "Performs web searches via SerpAPI and returns structured results",
    "scope_required": "tool:search.web",
    "risk_level": "low",
    "rate_limit_per_minute": 30,
    "category": "search",
    "metadata": {
      "endpoint_url": "https://serpapi.com/search",
      "auth_type": "api_key",
      "max_results": 10
    }
  }'
```

***

### Automatische Erhöhung des Risikolevels

Die Plattform scannt Toolnamen und Scope-Anforderungen nach gefährlichen Aktionsverben. Bei Erkennung wird das Risikoniveau automatisch erhöht:

| Erkanntes Verb | Auto-Erhöhung |
| - | - |
| `write`, `delete`, `send` | Erhöht auf `"high"` |
| `execute`, `deploy`, `destroy` | Erhöht auf `"high"` |
| `drop`, `truncate` | Erhöht auf `"high"` |

Tools mit dem Risikograd `"critical"` erfordern immer eine menschliche Genehmigung, unabhängig von der Einstellung `requires_approval`.


## OpenAPI

````yaml de/mint-openapi.yaml POST /v1/tools
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks ist eine universelle Verifizierungsinfrastruktur für Dokumente,
    Anmeldeinformationen und digitale Assets.

    Diese Spezifikation definiert die kanonische API für die Interaktion mit
    Truthlocks-Diensten.


    ## Basis-URLs

    - **Produktion**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentifizierung

    - **API-Schlüssel**: Verwenden Sie den Header `X-API-Key` für
    Machine-to-Machine-Operationen

    - **Bearer Tokens**: Verwenden Sie `Authorization: Bearer <jwt>` für
    benutzerinitiierte Operationen


    ## Mandantenidentität

    In der Produktion wird die Mandantenidentität aus dem authentifizierten
    Kontext (API-Schlüssel oder JWT) abgeleitet.

    Der Header `X-Tenant-ID` wird in der Produktion ignoriert, um Spoofing zu
    verhindern.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Produktions-API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox-Umgebung
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: API-Schlüssel- und Token-Verwaltung
  - name: Issuers
    description: Ausstellerregistrierung und Vertrauensmanagement
  - name: Keys
    description: Kryptographische Schlüsselverwaltung für Aussteller
  - name: Attestations
    description: Bestätigungslebenszyklus (prägen, widerrufen, ersetzen)
  - name: Verification
    description: Bestätigungsverifizierung und Proof-Bundles
  - name: Governance
    description: Aussteller-Governance-Workflows (nur Admin)
  - name: Identity
    description: Organisations-, Benutzer- und Rollenverwaltung
  - name: Audit
    description: Audit-Ereignisabfragen
  - name: Tenant Console
    description: Mandantenprofil- und Lebenszyklus-Endpunkte
  - name: Health
    description: Endpunkte für Dienststatus und Bereitschaft
  - name: Risk
    description: Erfassung von Risikosignalen und Betrugserkennung
  - name: Risk Enforcement
    description: >-
      Risikodurchsetzungsmaßnahmen – Blockieren, Herausfordern, Quarantäne und
      Konfiguration
  - name: Billing
    description: Verwaltung von Abrechnung, Abonnements und Add-ons
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) – Agentenregistrierung, Sitzungen,
      Vertrauen, Zeugen, Compliance, Orchestrierung und Beobachtbarkeit
externalDocs:
  description: Transparenz-API nur lesend (separate Dienstspezifikation)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/tools:
    post:
      tags:
        - Machine Identity
      summary: Tool registrieren
      description: >-
        Registriert ein aufrufbares Tool, das Agenten aufrufen können. Das
        Tool-Schema definiert die erwarteten Eingabeargumente mithilfe von JSON
        Schema.
      operationId: maip.tools.register
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                category:
                  type: string
                description:
                  type: string
                  description: Menschenlesbare Toolbeschreibung
                display_name:
                  type: string
                metadata: {}
                name:
                  type: string
                  description: Eindeutiger Werkzeugname
                rate_limit_per_minute:
                  type: integer
                requires_approval:
                  type: boolean
                risk_level:
                  type: string
                scope_required:
                  type: string
              type: object
              required:
                - name
                - display_name
                - scope_required
      responses:
        '201':
          description: Tool registriert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipTool'
        '400':
          description: Validierungsfehler
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Authentifizierung erforderlich
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Ratenlimit überschritten
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipTool:
      type: object
      properties:
        tool_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        schema:
          type: object
          additionalProperties: true
        agent_id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Maschinenlesbarer Fehlercode
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Menschenlesbare Fehlermeldung
        http_status:
          type: integer
          description: HTTP-Statuscode
        retry_after_ms:
          type: integer
          description: >-
            Millisekunden, die vor einem erneuten Versuch gewartet werden sollen
            (für Ratenbegrenzungen)
        details:
          type: object
          description: Zusätzlicher Fehlerkontext
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT für benutzerinitiierte Operationen

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.