KI-Codierwerkzeuge
Lassen Sie Ihren KI-Assistenten die mindzieAPI sofort verstehen
Moderne KI-Codierwerkzeuge wie Claude Code, Cursor, Windsurf und GitHub Copilot können Dokumentationen direkt von URLs lesen. Wir stellen LLM-optimierte Dokumentationsdateien bereit, die Ihrem KI-Codierassistenten ein vollständiges Wissen über die mindzieAPI vermitteln.
Schnellreferenz
Kopieren Sie diese URLs, um Ihre KI-Codierwerkzeuge zu konfigurieren:
| Ressource | URL | Am besten geeignet für |
|---|---|---|
| Komplette Dokumentation | https://docs.mindziestudio.com/llms-full.txt |
Vollständiges API-Verständnis (~120K Tokens) |
| Dokumentationsindex | https://docs.mindziestudio.com/llms.txt |
Schnelle Referenz mit Links zu Seiten |
Claude Code
Claude Code kann Dokumentation über WebFetch oder benutzerdefinierte Anweisungen abrufen.
Methode 1: WebFetch (Empfohlen)
Rufen Sie in einer Claude Code Sitzung die komplette Dokumentation ab:
Please read the mindzieAPI documentation from https://docs.mindziestudio.com/llms-full.txt
Claude lädt und liest die gesamte API-Dokumentation. Sie können dann Fragen zu Endpunkten, Authentifizierung, Anfrage-/Antwortformaten stellen und Codebeispiele erhalten.
Methode 2: In Projektanweisungen einfügen
Für dauerhaften Zugriff über Sitzungen hinweg fügen Sie Ihrem Projekt CLAUDE.md oder .claude/settings.json hinzu:
## mindzieAPI Referenz
Beim Arbeiten mit der mindzieAPI laden Sie die Dokumentation von:
https://docs.mindziestudio.com/llms-full.txt
Diese enthält die vollständige API-Dokumentation inklusive:
- Authentifizierung (Bearer Tokens, API-Schlüssel)
- Alle Endpunkte (Tenants, Users, Projects, Datasets, Blocks, Dashboards)
- Anfrage-/Antwortformate
- Codebeispiele in mehreren Sprachen
Beispiel-Prompts
Sobald Claude die Dokumentation hat, können Sie fragen:
- "Wie authentifiziere ich mich mit der mindzieAPI?"
- "Schreibe Python-Code, um ein neues Dataset zu erstellen"
- "Was ist der Endpunkt zum Ausführen eines Blocks?"
- "Zeig mir, wie man eine CSV-Datei in ein Projekt hochlädt"
Cursor IDE
Cursor kann Dokumentation über die @docs-Funktion indexieren für sofortigen Zugriff während des Codierens.
Einrichtungsschritte
- Öffnen Sie Cursor Einstellungen (Cmd/Ctrl + ,)
- Navigieren Sie zu Features > Docs
- Klicken Sie auf Neues Dokument hinzufügen
- Geben Sie URL ein:
https://docs.mindziestudio.com/llms-full.txt - Benennen Sie es:
mindzieAPI
Verwendung
Verweisen Sie in Cursor Chat auf die Dokumentation:
@mindzieAPI Wie authentifiziere ich API-Anfragen?
@mindzieAPI Schreibe eine Funktion, um alle Projekte in einem Tenant aufzulisten
Windsurf
Windsurf unterstützt externe Dokumentationsquellen für KI-gestütztes Codieren.
Einrichtung
- Öffnen Sie die Windsurf-Einstellungen
- Navigieren Sie zum Wissensdatenbank- oder Dokumentationsbereich
- Fügen Sie
https://docs.mindziestudio.com/llms-full.txtals externe Quelle hinzu
Verwendung
Während des Codierens verweist Windsurf automatisch auf die mindzieAPI-Dokumentation, um genaue Vorschläge und Vervollständigungen zu liefern.
GitHub Copilot
Copilot ruft URLs zwar nicht direkt ab, aber Sie können Kontext über Projektdateien bereitstellen.
Option 1: In Projekt einbinden
Erstellen Sie eine Datei docs/mindzieAPI.md in Ihrem Projekt mit der API-Referenz. Copilot nutzt diese als Kontext, wenn Sie im Projekt arbeiten.
Option 2: Copilot Chat
Fügen Sie in GitHub Copilot Chat wichtige Abschnitte der Dokumentation ein oder verweisen Sie auf die URL:
Using the mindzieAPI documented at https://docs.mindziestudio.com/llms-full.txt,
write a Python class to manage datasets.
Cody (Sourcegraph)
Cody kann externe Dokumentation indexieren für kontextbewusste Unterstützung.
Einrichtung
- Öffnen Sie die Cody-Einstellungen
- Fügen Sie
https://docs.mindziestudio.com/llms-full.txtzu Ihren Kontextquellen hinzu - Die Dokumentation steht in Ihren Codier-Sitzungen zur Verfügung
Generische LLM-Nutzung
Für jede LLM-Schnittstelle (ChatGPT, Claude Web usw.) können Sie:
- Zuerst den Index abrufen: Besuchen Sie
https://docs.mindziestudio.com/llms.txt, um die Struktur der Dokumentation zu sehen - Komplette Docs laden: Kopieren Sie den Inhalt von
https://docs.mindziestudio.com/llms-full.txtin Ihren LLM-Kontext - Fragen stellen: Das LLM versteht jetzt die gesamte mindzieAPI
Was enthalten ist
Die LLM-Dokumentation deckt alle mindzieAPI-Fähigkeiten ab:
| Kategorie | Umfang |
|---|---|
| Authentifizierung | API-Schlüssel (Global und Tenant), Bearer-Tokens, Scopes, Sicherheitsbestimmungen |
| Tenants | Multi-Tenant-Verwaltung, Erstellung, Aktualisierung, Löschen mit Sicherheitsmechanismen |
| Benutzer | Globale Operationen, tenant-spezifische Operationen, Rollen und Berechtigungen |
| Projekte | CRUD-Operationen, Caching, Benutzerzugriffe, Import/Export (.mpz Dateien) |
| Datensätze | Erstellung, CSV/XES-Import, Aktualisierungen, Spaltenzuordnung, Dateiformate |
| Blöcke | Analyse-Blöcke, Ausführung, Ergebnisabruf, Blockarten |
| Dashboards | Verwaltung, Panel-Konfiguration, Freigabe und öffentliche URLs |
| Anreicherungen | Pipelines, Python-Notebook-Integration, Ausführung |
| Aktionen | Benannte Aktion ausführen, Ping-Endpunkte, Ausführungshistorie |
| Ausführung | Async-Jobverwaltung, Warteschlangen-Operationen, Statusverfolgung |
Kontextfenster-Betrachtungen
Verschiedene KI-Modelle haben unterschiedliche Kontextlimits. So passen unsere Dokumentationsdateien:
| Modell | Kontextlimit | llms-full.txt | Empfehlung |
|---|---|---|---|
| Claude Opus 4 | 200K Tokens | Passt (~120K) | Volle Dokumentation verwenden |
| Claude Sonnet | 200K Tokens | Passt (~120K) | Volle Dokumentation verwenden |
| GPT-4 Turbo | 128K Tokens | Eng | Volle Dokumentation verwenden |
| GPT-4o | 128K Tokens | Eng | Volle Dokumentation verwenden |
| Claude Haiku | 200K Tokens | Passt (~120K) | Volle Dokumentation verwenden |
| Gemini Pro | 128K Tokens | Eng | Index + spezifische Seiten ggf. notwendig |
| GPT-3.5 | 16K Tokens | Zu groß | Index verwenden, spezifische Seiten abrufen |
Für kleinere Kontextfenster
Wenn Ihr Modell eingeschränkten Kontext hat:
- Verwenden Sie
llms.txt(den Index), um die API-Struktur zu erfassen - Identifizieren Sie benötigte Abschnitte
- Laden Sie einzelne Markdown-Dateien von
/docs-master/mindzieAPI/{category}/{page}/page.mdherunter
Dateiformate
| URL | Format | Größe | Tokens |
|---|---|---|---|
/llms.txt |
Markdown (Index) | ~6 KB | ~1,5K |
/llms-full.txt |
Markdown (komplett) | ~470 KB | ~120K |
/docs-master/.../*.md |
Markdown (Einzelseiten) | 2-15 KB pro Datei | ~500-4K pro Datei |
Dokumentation aktuell halten
Die LLM-Dokumentation wird bei jeder Aktualisierung der API-Dokumentation neu generiert. Die Dateien enthalten einen Zeitstempel, wann sie zuletzt erstellt wurden.
Für die aktuellste Dokumentation sollte Ihr KI-Werkzeug stets frische Kopien laden und nicht dauerhaft zwischenspeichern.
MCP-Server-Integration
Für erweiterte KI-Werkzeugintegration stellt die mindzieAPI einen MCP (Model Context Protocol) Server bereit, der KI-Assistenten ermöglicht, programmgesteuert mit mindzieStudio zu interagieren.
Der MCP-Server beinhaltet Werkzeuge wie mindzie_list_block_types mit einem unified Kategorien-Parameter, der alle Blocktypen (Filter, Rechner und Anreicherungen) mit vollständigen Metadaten in einem einzigen Aufruf zurückgibt.
Siehe MCP-Server-Dokumentation
Nächste Schritte
Bereit, mit KI-Unterstützung zu programmieren? Probieren Sie Folgendes:
- Richten Sie Ihr KI-Codierwerkzeug auf
https://docs.mindziestudio.com/llms-full.txtein - Fragen Sie: "Wie authentifiziere ich mich mit der mindzieAPI?"
- Fordern Sie an: "Schreibe Python-Code, der alle Projekte auflistet"
- Entwickeln Sie vollständige Integrationen mit KI-gestützter Code-Generierung
Für eine menschenlesbare Dokumentation siehe den Schnellstart-Guide oder stöbern Sie im vollständigen API-Referenz.