Outils de Codage IA
Faites comprendre instantanément votre assistant IA à mindzieAPI
Les outils modernes de codage IA comme Claude Code, Cursor, Windsurf et GitHub Copilot peuvent lire la documentation directement à partir d’URLs. Nous fournissons des fichiers de documentation optimisés pour LLM qui donnent à votre assistant IA de codage une connaissance complète de mindzieAPI.
Référence Rapide
Copiez ces URLs pour configurer vos outils de codage IA :
| Ressource | URL | Idéal Pour |
|---|---|---|
| Documentation Complète | https://docs.mindziestudio.com/llms-full.txt |
Compréhension complète de l’API (~120K tokens) |
| Index de la Documentation | https://docs.mindziestudio.com/llms.txt |
Référence rapide avec liens vers les pages |
Claude Code
Claude Code peut accéder à la documentation via WebFetch ou instructions personnalisées.
Méthode 1 : WebFetch (Recommandée)
Dans une session Claude Code, récupérez la documentation complète :
Please read the mindzieAPI documentation from https://docs.mindziestudio.com/llms-full.txt
Claude téléchargera et lira toute la documentation de l’API. Vous pouvez ensuite poser des questions sur les endpoints, l’authentification, les formats requête/réponse, et obtenir des exemples de code.
Méthode 2 : Ajouter aux Instructions du Projet
Pour un accès persistant entre les sessions, ajoutez dans CLAUDE.md ou .claude/settings.json de votre projet :
## Référence mindzieAPI
Lors de la manipulation de mindzieAPI, récupérez la documentation depuis :
https://docs.mindziestudio.com/llms-full.txt
Cette documentation contient :
- Authentification (tokens Bearer, clés API)
- Tous les endpoints (tenants, utilisateurs, projets, datasets, blocks, dashboards)
- Formats de requête/réponse
- Exemples de code dans plusieurs langages
Exemples de Prompts
Une fois que Claude a la documentation, vous pouvez demander :
- « Comment m’authentifier avec mindzieAPI ? »
- « Écris du code Python pour créer un nouveau dataset »
- « Quel est le endpoint pour exécuter un block ? »
- « Montre-moi comment uploader un fichier CSV dans un projet »
Cursor IDE
Cursor peut indexer la documentation avec la fonction @docs pour un accès instantané lors du codage.
Étapes de Configuration
- Ouvrez Paramètres de Cursor (Cmd/Ctrl + ,)
- Allez dans Fonctionnalités > Docs
- Cliquez sur Ajouter un nouveau doc
- Entrez l’URL :
https://docs.mindziestudio.com/llms-full.txt - Nommez-le :
mindzieAPI
Utilisation
Référencez la documentation dans le chat Cursor :
@mindzieAPI Comment authentifier les requêtes API ?
@mindzieAPI Écris une fonction pour lister tous les projets d’un tenant
Windsurf
Windsurf supporte les sources de documentation externes pour l’aide au codage IA.
Configuration
- Ouvrez les paramètres de Windsurf
- Allez à la section base de connaissances ou documentation
- Ajoutez
https://docs.mindziestudio.com/llms-full.txtcomme source externe
Utilisation
Lors du codage, Windsurf référencera automatiquement la documentation mindzieAPI pour fournir des suggestions et complétions précises.
GitHub Copilot
Même si Copilot ne récupère pas directement des URLs, vous pouvez fournir le contexte via des fichiers projet.
Option 1 : Inclure dans le Projet
Créez un fichier docs/mindzieAPI.md dans votre projet avec la référence API. Copilot utilisera cela comme contexte lorsqu’il travaille sur ce projet.
Option 2 : Copilot Chat
Dans GitHub Copilot Chat, collez des sections clés de la documentation ou référez-vous à l’URL :
Using the mindzieAPI documented at https://docs.mindziestudio.com/llms-full.txt,
write a Python class to manage datasets.
Cody (Sourcegraph)
Cody peut indexer la documentation externe pour une assistance contextuelle.
Configuration
- Ouvrez les paramètres Cody
- Ajoutez
https://docs.mindziestudio.com/llms-full.txtà vos sources de contexte - La documentation sera disponible à travers vos sessions de codage
Usage Générique LLM
Pour toute interface LLM (ChatGPT, Claude web, etc.), vous pouvez :
- Récupérer l’index d’abord : Visitez
https://docs.mindziestudio.com/llms.txtpour voir la structure de la documentation - Obtenir la doc complète : Copiez le contenu de
https://docs.mindziestudio.com/llms-full.txtdans le contexte de votre LLM - Poser des questions : Le LLM comprend maintenant toute la mindzieAPI
Contenu Inclus
La documentation LLM couvre toutes les capacités mindzieAPI :
| Catégorie | Contenu |
|---|---|
| Authentification | Clés API (Globales et Tenant), tokens Bearer, scopes, meilleures pratiques de sécurité |
| Tenants | Gestion multi-tenant, création, mises à jour, suppression avec protections |
| Utilisateurs | Opérations globales, opérations limitées au tenant, rôles et permissions |
| Projets | Opérations CRUD, cache, accès utilisateur, import/export (.mpz files) |
| Datasets | Création, import CSV/XES, mises à jour, correspondance de colonnes, formats de fichiers |
| Blocks | Blocks d’analyse, exécution, récupération de résultats, types de blocks |
| Dashboards | Gestion, configuration de panneaux, partage et URLs publiques |
| Enrichissements | Pipelines, intégration de notebooks Python, exécution |
| Actions | Exécution d’actions nommées, endpoints ping, historique d’exécution |
| Exécution | Gestion des jobs asynchrones, opérations de queue, suivi de statut |
Considérations sur la Fenêtre de Contexte
Différents modèles IA ont des limites de contexte différentes. Voici comment nos fichiers de documentation s’adaptent :
| Modèle | Limite Contexte | llms-full.txt | Recommandation |
|---|---|---|---|
| Claude Opus 4 | 200K tokens | S’adapte (~120K) | Utiliser la documentation complète |
| Claude Sonnet | 200K tokens | S’adapte (~120K) | Utiliser la documentation complète |
| GPT-4 Turbo | 128K tokens | Ajusté | Utiliser la documentation complète |
| GPT-4o | 128K tokens | Ajusté | Utiliser la documentation complète |
| Claude Haiku | 200K tokens | S’adapte (~120K) | Utiliser la documentation complète |
| Gemini Pro | 128K tokens | Ajusté | Peut nécessiter index + pages spécifiques |
| GPT-3.5 | 16K tokens | Trop grand | Utiliser l’index, récupérer pages spécifiques |
Pour des Fenêtres de Contexte Plus Petites
Si votre modèle a un contexte limité :
- Utilisez
llms.txt(l’index) pour comprendre la structure de l’API - Identifiez les sections nécessaires
- Récupérez les fichiers markdown individuels depuis
/docs-master/mindzieAPI/{category}/{page}/page.md
Formats de Fichiers
| URL | Format | Taille | Tokens |
|---|---|---|---|
/llms.txt |
Markdown (index) | ~6 KB | ~1.5K |
/llms-full.txt |
Markdown (complet) | ~470 KB | ~120K |
/docs-master/.../*.md |
Markdown (pages individuelles) | 2-15 KB chacune | ~500-4K chacune |
Maintien de la Documentation à Jour
La documentation LLM est régénérée à chaque mise à jour de la documentation API. Les fichiers incluent un timestamp indiquant la dernière génération.
Pour avoir la documentation la plus récente, votre outil IA doit récupérer des copies fraîches plutôt que de mettre en cache indéfiniment.
Intégration Serveur MCP
Pour une intégration avancée des outils IA, mindzieAPI fournit un serveur MCP (Model Context Protocol) qui permet aux assistants IA d’interagir avec mindzieStudio de manière programmatique.
Le serveur MCP inclut des outils comme mindzie_list_block_types avec un paramètre de catégorie unified qui retourne tous les types de blocks (filtres, calculateurs et enrichissements) avec des métadonnées complètes en un seul appel.
Voir la Documentation du Serveur MCP
Prochaines Étapes
Prêt à coder avec l’assistance IA ? Voici quelques idées :
- Pointez votre outil de codage IA vers
https://docs.mindziestudio.com/llms-full.txt - Demandez : « Comment m’authentifier avec mindzieAPI ? »
- Demandez : « Écris du code Python pour lister tous les projets »
- Construisez : Intégrations complètes avec génération de code assistée par IA
Pour une documentation lisible par un humain, consultez le Guide de Démarrage Rapide ou explorez la Référence API complète.