Wiki › API-Katalog › tools

tools

17 Funktionen in dieser Kategorie.

tools.list GET /api/admin/tools/list

Alle registrierten Tools auflisten

Hilfe

Listet alle registrierten Tools mit Name, Beschreibung, Berechtigungen und Parameter-Schema auf.

Beispiel-Prompts

  • Welche Tools sind registriert?
  • Zeige alle Tools
  • Tool-Liste
raw_response: Ja
tools.permissions GET /api/admin/tools/permissions

Tool-Berechtigungen pro Gruppe anzeigen

Hilfe

Zeigt die Berechtigungsmatrix: Welche Gruppe darf welche Tools nutzen.

Beispiel-Prompts

  • Zeige Tool-Berechtigungen
  • Welche Gruppen dürfen welche Tools nutzen?
raw_response: Ja
tools.permissions.update POST /api/admin/tools/permissions

Tool-Berechtigungen für eine Gruppe speichern

Hilfe

Aktualisiert die Tool-Berechtigungen für eine bestimmte Gruppe. Erwartet den Gruppennamen und eine Liste erlaubter Tool-Namen.

Parameter

Name Typ Required Default Beschreibung
group string Ja — Gruppenname (DN oder Anzeigename)
tools array Ja — Liste erlaubter Tool-Namen

Beispiel-Prompts

  • Setze Tool-Berechtigungen für Gruppe ERP-Leser
  • Erlaube Gruppe X die Tools erp_order_status und erp_stock_level

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: berechtigungen gruppe {group} aktualisieren

Changelog

Area: tools | Action: update

raw_response: Ja | PK-Param: group
tools.test POST /api/admin/tools/test/{name}

Tool manuell testen

Hilfe

Führt ein registriertes Tool mit den übergebenen Parametern aus und gibt das Ergebnis zurück.

Parameter

Name Typ Required Default Beschreibung
name string Ja — Name des zu testenden Tools
params object Nein {} Test-Eingabeparameter fuer das Tool (tool-abhaengig)

Beispiel-Prompts

  • Teste Tool erp_order_status mit Auftrag 12345
  • Tool-Test für calculate
raw_response: Ja
tools.usage GET /api/admin/tools/usage

Tool-Nutzungsstatistiken anzeigen

Hilfe

Zeigt Nutzungshäufigkeit und letztes Verwendungsdatum pro Tool aus dem Query-Log.

Beispiel-Prompts

  • Welche Tools werden am häufigsten genutzt?
  • Tool-Nutzungsstatistiken
raw_response: Ja
tools.connector_types GET /api/admin/tools/connector-types

Verfügbare Konnektortypen auflisten

Hilfe

Listet alle verfügbaren Konnektortypen mit Config-Schema auf.

Beispiel-Prompts

  • Welche Konnektortypen gibt es?
  • Verfügbare Verbindungstypen
raw_response: Ja
tools.erp.config.read GET /api/admin/tools/erp-config

ERP-Backend-Konfiguration anzeigen

Hilfe

Zeigt die aktuelle ERP-Backend-Konfiguration. SQL-DSN wird maskiert.

Beispiel-Prompts

  • Zeige ERP-Konfiguration
  • Wie ist das ERP-Backend konfiguriert?
raw_response: Ja
tools.erp.config.update POST /api/admin/tools/erp-config

ERP-Konfiguration speichern

Hilfe

Speichert die ERP-Backend-Konfiguration. Bei maskiertem SQL-DSN (********) wird der bestehende Wert beibehalten.

Parameter

Name Typ Required Default Beschreibung
backend string Nein mock ERP-Backend-Typ (mock, sql)
sql_dsn string Nein SQL-Verbindungsstring (PASSWORD_MASK = beibehalten)
sql_driver string Nein auto SQL-Treiber (auto, mssql, postgresql, mysql)
mapping object Nein {} Tabellen-/Feld-Zuordnung

Beispiel-Prompts

  • Setze ERP-Backend auf SQL
  • ERP-Konfiguration speichern

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: erp-konfiguration aktualisieren

Changelog

Area: erp_config | Action: update

raw_response: Ja | PK-Param: backend
tools.erp.test_connection POST /api/admin/tools/erp-test-connection

ERP-SQL-Verbindungstest durchführen

Hilfe

Testet die Verbindung zum konfigurierten ERP-SQL-Backend.

Beispiel-Prompts

  • Teste ERP-Verbindung
  • Funktioniert die ERP-SQL-Verbindung?
raw_response: Ja
tools.erp.table_schema GET /api/admin/tools/erp-table-schema/{table_name}

ERP-Tabellen-Schema auslesen

Hilfe

Zeigt die Spalten einer Tabelle im ERP-SQL-Backend.

Parameter

Name Typ Required Default Beschreibung
table_name string Ja — Name der ERP-Tabelle

Beispiel-Prompts

  • Zeige Schema der Tabelle Auftraege
  • Welche Spalten hat die ERP-Tabelle Kunden?
raw_response: Ja
tools.connections.list GET /api/admin/tools/connections

ERP-Verbindungen auflisten

Hilfe

Zeigt alle konfigurierten ERP-Verbindungen. Passwort-Felder werden maskiert.

Beispiel-Prompts

  • Zeige ERP-Verbindungen
  • Welche Verbindungen sind konfiguriert?
raw_response: Ja
tools.connections.create POST /api/admin/tools/connections

Neue ERP-Verbindung erstellen

Hilfe

Erstellt eine neue ERP-Verbindung. Passwort-Felder werden automatisch verschlüsselt.

Parameter

Name Typ Required Default Beschreibung
name string Ja — Name der Verbindung
type string Ja — Konnektor-Typ (sql, api, ...)
config object Nein {} Verbindungskonfiguration (typabhaengig)
enabled boolean Nein True Verbindung aktiv

Beispiel-Prompts

  • Erstelle eine neue SQL-Verbindung 'Produktions-DB'
  • Neue ERP-Verbindung anlegen

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: erp-verbindung {name} erstellen

Changelog

Area: connections | Action: create

raw_response: Ja | PK-Param: name
tools.connections.update PUT /api/admin/tools/connections/{connection_id}

ERP-Verbindung aktualisieren

Hilfe

Aktualisiert eine bestehende ERP-Verbindung. Bei maskierten Passwörtern (********) wird das bestehende Passwort beibehalten.

Parameter

Name Typ Required Default Beschreibung
connection_id string Ja — ID der Verbindung (z.B. conn-a1b2c3d4)
name string Ja — Name der Verbindung
type string Ja — Konnektor-Typ
config object Nein {} Verbindungskonfiguration
enabled boolean Nein True Verbindung aktiv

Beispiel-Prompts

  • Aktualisiere Verbindung conn-a1b2c3d4
  • Ändere den Namen der Verbindung

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: verbindung {connection_id} aktualisieren

Changelog

Area: connections | Action: update

raw_response: Ja | PK-Param: connection_id
tools.connections.delete DELETE /api/admin/tools/connections/{connection_id}

ERP-Verbindung löschen

Hilfe

Löscht eine bestehende ERP-Verbindung und entfernt die zugehörigen Tool-Zuordnungen.

Parameter

Name Typ Required Default Beschreibung
connection_id string Ja — ID der zu loeschenden Verbindung

Beispiel-Prompts

  • Lösche Verbindung conn-a1b2c3d4
  • ERP-Verbindung entfernen

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: verbindung {connection_id} löschen

Changelog

Area: connections | Action: delete

raw_response: Ja | PK-Param: connection_id
tools.connections.test POST /api/admin/tools/connections/{connection_id}/test

ERP-Verbindung testen

Hilfe

Testet eine bestehende ERP-Verbindung und gibt das Ergebnis zurück.

Parameter

Name Typ Required Default Beschreibung
connection_id string Ja — ID der zu testenden Verbindung

Beispiel-Prompts

  • Teste Verbindung conn-a1b2c3d4
  • Funktioniert die ERP-Verbindung?
raw_response: Ja
tools.assignments GET /api/admin/tools/assignments

Tool→Verbindung Zuordnungen anzeigen

Hilfe

Zeigt die aktuellen Zuordnungen von Tools zu ERP-Verbindungen.

Beispiel-Prompts

  • Zeige Tool-Zuordnungen
  • Welches Tool nutzt welche Verbindung?
raw_response: Ja
tools.assignments.update POST /api/admin/tools/assignments

Tool→Verbindung Zuordnungen speichern

Hilfe

Speichert die Zuordnungen von Tools zu ERP-Verbindungen. Erwartet ein Dictionary mit Tool-Name → Connection-ID.

Parameter

Name Typ Required Default Beschreibung
assignments object Ja — Zuordnung Tool-Name → Connection-ID (dict)

Beispiel-Prompts

  • Ordne erp_order_status der Verbindung conn-abc zu
  • Tool-Zuordnungen aktualisieren

Confirmation

Diese Funktion erfordert eine Bestätigung. Template: tool-zuordnungen aktualisieren

Changelog

Area: assignments | Action: update

raw_response: Ja