Herramientas de Codificación con IA

Haz que tu asistente de IA entienda instantáneamente la mindzieAPI

Las herramientas modernas de codificación con IA como Claude Code, Cursor, Windsurf y GitHub Copilot pueden leer documentación directamente desde URLs. Proporcionamos archivos de documentación optimizados para LLM que brindan a tu asistente de codificación con IA un conocimiento completo de la mindzieAPI.

Referencia Rápida

Copia estas URLs para configurar tus herramientas de codificación con IA:

Recurso URL Mejor Para
Documentación Completa https://docs.mindziestudio.com/llms-full.txt Comprensión completa de la API (~120K tokens)
Índice de Documentación https://docs.mindziestudio.com/llms.txt Referencia rápida con enlaces a páginas

Claude Code

Claude Code puede acceder a la documentación usando WebFetch o instrucciones personalizadas.

Método 1: WebFetch (Recomendado)

En una sesión de Claude Code, obtén la documentación completa:

Please read the mindzieAPI documentation from https://docs.mindziestudio.com/llms-full.txt

Claude descargará y leerá toda la documentación de la API. Luego podrás hacer preguntas sobre endpoints, autenticación, formatos de solicitud/respuesta y obtener ejemplos de código.

Método 2: Añadir a las Instrucciones del Proyecto

Para acceso persistente entre sesiones, añade al archivo CLAUDE.md o .claude/settings.json de tu proyecto:

## Referencia mindzieAPI

Al trabajar con la mindzieAPI, consulta la documentación en:
https://docs.mindziestudio.com/llms-full.txt

Esto contiene la documentación completa de la API incluyendo:
- Autenticación (tokens Bearer, claves API)
- Todos los endpoints (tenants, usuarios, proyectos, datasets, blocks, dashboards)
- Formatos de solicitud/respuesta
- Ejemplos de código en varios lenguajes

Ejemplos de Solicitudes

Una vez que Claude tenga la documentación, puedes preguntar:

  • "¿Cómo me autentico con la mindzieAPI?"
  • "Escribe código en Python para crear un nuevo dataset"
  • "¿Cuál es el endpoint para ejecutar un block?"
  • "Muéstrame cómo subir un archivo CSV a un proyecto"

Cursor IDE

Cursor puede indexar la documentación usando la función @docs para acceso instantáneo durante la codificación.

Pasos para Configurar

  1. Abre Configuración de Cursor (Cmd/Ctrl + ,)
  2. Navega a Características > Docs
  3. Haz clic en Agregar nuevo doc
  4. Introduce la URL: https://docs.mindziestudio.com/llms-full.txt
  5. Nómbralo: mindzieAPI

Uso

Referencia la documentación en el chat de Cursor:

@mindzieAPI ¿Cómo autentico solicitudes API?

@mindzieAPI Escribe una función para listar todos los proyectos de un tenant

Windsurf

Windsurf soporta fuentes externas de documentación para codificación asistida por IA.

Configuración

  1. Abre la configuración de Windsurf
  2. Navega a la sección de base de conocimientos o documentación
  3. Añade https://docs.mindziestudio.com/llms-full.txt como fuente externa

Uso

Al codificar, Windsurf referenciará automáticamente la documentación de la mindzieAPI para proporcionar sugerencias y autocompletados precisos.

GitHub Copilot

Aunque Copilot no recupera URLs directamente, puedes proveer contexto a través de archivos del proyecto.

Opción 1: Incluir en el Proyecto

Crea un archivo docs/mindzieAPI.md en tu proyecto con la referencia de la API. Copilot usará esto como contexto cuando trabajes en ese proyecto.

Opción 2: Copilot Chat

En GitHub Copilot Chat, pega secciones clave de la documentación o referencia la URL:

Usando la mindzieAPI documentada en https://docs.mindziestudio.com/llms-full.txt,
escribe una clase en Python para gestionar datasets.

Cody (Sourcegraph)

Cody puede indexar documentación externa para asistencia sensible al contexto.

Configuración

  1. Abre la configuración de Cody
  2. Añade https://docs.mindziestudio.com/llms-full.txt a tus fuentes de contexto
  3. La documentación estará disponible en todas tus sesiones de codificación

Uso Genérico con LLM

Para cualquier interfaz LLM (ChatGPT, Claude web, etc.) puedes:

  1. Obtener primero el índice: Visita https://docs.mindziestudio.com/llms.txt para ver la estructura de la documentación
  2. Obtener la documentación completa: Copia el contenido de https://docs.mindziestudio.com/llms-full.txt en el contexto de tu LLM
  3. Hacer preguntas: Ahora el LLM entiende toda la mindzieAPI

Qué Incluye

La documentación para LLM cubre todas las capacidades de mindzieAPI:

Categoría Cobertura
Autenticación Claves API (Global y Tenant), tokens Bearer, scopes, mejores prácticas de seguridad
Tenants Gestión multitenant, creación, actualización, eliminación con protecciones
Usuarios Operaciones globales, operaciones con alcance en tenant, roles y permisos
Proyectos Operaciones CRUD, caché, acceso de usuarios, importación/exportación (.mpz files)
Datasets Creación, importación CSV/XES, actualizaciones, mapeo de columnas, formatos de archivo
Blocks Blocks de análisis, ejecución, recuperación de resultados, tipos de blocks
Dashboards Gestión, configuración de paneles, compartición y URLs públicas
Enriquecimientos Pipelines, integración con notebooks Python, ejecución
Actions Ejecución de acciones nombradas, endpoints ping, historial de ejecución
Ejecución Gestión de trabajos asíncronos, operaciones de cola, seguimiento de estado

Consideraciones sobre la Ventana de Contexto

Diferentes modelos de IA tienen distintos límites de contexto. Así encajan nuestros archivos de documentación:

Modelo Límite de Contexto llms-full.txt Recomendación
Claude Opus 4 200K tokens Cabe (~120K) Usar documentación completa
Claude Sonnet 200K tokens Cabe (~120K) Usar documentación completa
GPT-4 Turbo 128K tokens Ajustado Usar documentación completa
GPT-4o 128K tokens Ajustado Usar documentación completa
Claude Haiku 200K tokens Cabe (~120K) Usar documentación completa
Gemini Pro 128K tokens Ajustado Puede necesitar índice + páginas específicas
GPT-3.5 16K tokens Muy grande Usar índice, obtener páginas específicas

Para Ventanas de Contexto Más Pequeñas

Si tu modelo tiene contexto limitado:

  1. Usa llms.txt (el índice) para entender la estructura de la API
  2. Identifica qué secciones necesitas
  3. Obtén archivos markdown individuales de /docs-master/mindzieAPI/{category}/{page}/page.md

Formatos de Archivo

URL Formato Tamaño Tokens
/llms.txt Markdown (índice) ~6 KB ~1.5K
/llms-full.txt Markdown (completo) ~470 KB ~120K
/docs-master/.../*.md Markdown (páginas individuales) 2-15 KB cada uno ~500-4K cada uno

Mantener la Documentación Actualizada

La documentación para LLM se regenera cada vez que se actualiza la documentación de la API. Los archivos incluyen una marca de tiempo que muestra cuándo se generaron por última vez.

Para obtener la documentación más actual, tu herramienta de IA debe obtener copias frescas en lugar de almacenar en caché indefinidamente.

Integración con el Servidor MCP

Para integración avanzada con herramientas de IA, la mindzieAPI ofrece un servidor MCP (Model Context Protocol) que permite a los asistentes de IA interactuar programáticamente con mindzieStudio.

El servidor MCP incluye herramientas como mindzie_list_block_types con un parámetro de categoría unified que devuelve todos los tipos de blocks (filtros, calculadoras y enriquecimientos) con metadatos completos en una sola llamada.

Ver Documentación del Servidor MCP

Próximos Pasos

¿Listo para empezar a codificar con asistencia de IA? Aquí tienes algunas cosas para probar:

  1. Apunta tu herramienta de codificación con IA a https://docs.mindziestudio.com/llms-full.txt
  2. Pregunta: "¿Cómo me autentico con la mindzieAPI?"
  3. Solicita: "Escribe código en Python para listar todos los proyectos"
  4. Construye: Integraciones completas con generación de código asistida por IA

Para documentación legible por humanos, consulta la Guía de Inicio Rápido o explora la Referencia Completa de la API.