EntwicklerdokumentationAPI v1

Anleitungen

KI-Client mit MCP verbinden

Geben Sie einem KI-Client per OAuth Zugriff auf einen Arbeitsbereich, mit denselben Ressourcenberechtigungen wie das Mitglied.

Connector-URL kopieren

Öffnen Sie in Squario Konto → Verbundene Apps und kopieren Sie die MCP-Server-URL. Fügen Sie sie als entfernten oder benutzerdefinierten MCP-Server in einem Client mit Unterstützung für entfernte OAuth-Server hinzu. Die URL endet auf /functions/v1/mcp-server/mcp und unterscheidet sich von der REST-Basis-URL. Verwenden Sie die URL der App.

  • Der Client entdeckt den Server, registriert sich und öffnet die Zustimmungsseite.
  • Melden Sie sich an, wählen Sie den Arbeitsbereich und genehmigen Sie den Zugriff.
  • Der Client erhält OAuth-Tokens und entdeckt verfügbare Tools.
  • Widerrufen Sie die Verbindung jederzeit unter Konto → Verbundene Apps.

Eine Freigabe handelt als Sie

MCP verwendet OAuth 2.1 mit PKCE, keinen API-Schlüssel. Tokens binden ein Mitglied an einen Arbeitsbereich. Mitgliedschaft, squaria.mcp, Datensatzsichtbarkeit und Feldrechte werden bei jedem Aufruf geprüft. Zugriffstokens gelten eine Stunde; Refreshtokens 30 Tage und rotieren bei Nutzung. Der Client sollte diesen Lebenszyklus verwalten.

Entdecken, validieren, dann schreiben

Beginnen Sie mit describe_resource oder describe_capabilities, lesen Sie dann die benötigten Datensätze. Verwenden Sie validate_change vor Änderungen. Tools sind nach Ressource parametrisiert und gegen das Arbeitsbereichsschema zertifiziert.

Entdecken, validieren, dann schreiben
ZweckBeispiele
Datensätzelist_records, get_record, resolve_reference, global_search
Entdeckungdescribe_resource, describe_capabilities, list_data_models, list_custom_fields
Änderungenvalidate_change, create_record, update_record, archive_record, restore_record
Arbeitsbereichskontextlist_forms, list_drive_items, list_audit_log, Wissenstools
Ansichten und Berichtelist_views, save_view, save_structural_view, run_report

Freigabe, Credits und Grenzen

Verwenden Sie die Tool-Freigabefunktionen Ihres Clients für Änderungen. MCP-Aufrufe verbrauchen KI-Credits statt REST-Kontingent; ein fehlgeschlagener Tool-Aufruf wird erstattet. Jede wiederholte Ausführung ist ein neuer Aufruf mit neuem Verbrauch. Standardgrenzen sind 60/Minute und 1.000/Stunde pro Mitglied und Arbeitsbereich. Drosselung liefert 429 mit Retry-After.

  • Drive-Tools zeigen Metadaten, nie Dateiinhalte.
  • MCP bietet keine App-Seitennavigation oder Detail-Layout-Aktionen.
  • Verfügbare Tools ändern sich mit Serverversionen. Nutzen Sie die Tool-Discovery des Clients als Vertrag.