Ficheros de contexto para LLM

OpenKM proporciona un conjunto de ficheros de contexto en texto plano siguiendo la convención llms.txt. Cada fichero consolida un área específica de la documentación de OpenKM — firmas de métodos, parámetros, tipos de retorno, ejemplos de código y detalles de configuración — en un único fichero optimizado para que lo consuma un LLM.

El propósito de estos ficheros es dar a cualquier LLM (Claude, ChatGPT, Gemini, Copilot, etc.) conocimiento preciso de los internos de OpenKM para que pueda ayudarle a escribir código de integración, scripts de automatización, plugins o consultas SQL sin inventarse nombres de método, firmas incorrectas o estructuras de tabla erróneas.

Cómo usarlos

El flujo de trabajo recomendado es colocar el fichero o ficheros relevantes en la carpeta de su proyecto y referenciarlos directamente en su prompt usando la sintaxis @file admitida por la mayoría de los IDE asistidos por IA (Cursor, Windsurf, VS Code + Copilot, etc.) o adjuntándolos a su conversación en Claude, ChatGPT, o cualquier otro LLM basado en chat.

Puede cargar un único fichero o combinar varios según la tarea que tenga entre manos. Por ejemplo, al desarrollar un plugin puede que quiera cargar juntos llms-full-plugins y llms-full-api para dar al LLM contexto completo.

Ejemplo de prompt

I am working on an OpenKM 8.2 automation plugin.
In @llms-full-plugins-8.2.5.txt you have the complete plugin system reference.
In @llms-full-api-8.2.5.txt you have the full OpenKM Java API reference.

Create a new Automation Action plugin that:
- Fires on add or set metadata (AT_POST).
- Reads the metadata property group "okg:invoice" from the document.
- Sends an email notification using MailUtils if the field "okp.invoice.amount" exceeds 10000.

Ficheros disponibles

llms-full-api

Referencia completa de las fachadas de la API Java de OpenKM (OKMDocument, OKMFolder, OKMSearch, OKMPropertyGroup, etc.). Cubre todos los métodos públicos con sus firmas, parámetros, tipos de retorno, excepciones lanzadas y ejemplos de uso. Use este fichero al escribir código que interactúe con el repositorio de OpenKM de forma programática.

Versión	Fichero
8.2.9 y superior	llms-full-api-8.2.9.txt
8.2.8	llms-full-api-8.2.8.txt
8.2.5 a 8.2.7	llms-full-api-8.2.5.txt

llms-full-plugins

Referencia completa para desarrolladores del sistema de plugins de OpenKM. Cubre todos los tipos de plugin (Automation Action, Automation Validation, Crontab, Text Extractor, Document Converter, Search, Report, REST, validadores de formulario, Suggestbox, OCR, y más), sus interfaces, firmas de método requeridas, anotaciones y ejemplos de implementación. Use este fichero al desarrollar o extender plugins de OpenKM.

Versión	Fichero
8.2.9 y superior	llms-full-plugins-8.2.9.txt
8.2.5 a 8.2.8	llms-full-plugins-8.2.5.txt

llms-full-metadata

Referencia completa del sistema de metadatos de OpenKM. Cubre el formato de definición XML de los grupos de propiedades (DTD 3.15), todos los tipos de campo (Input, Select, SuggestBox, TextArea, CheckBox, etc.) con sus atributos, los elementos de validador e interceptor, el control de acceso de seguridad, la internacionalización, y cómo trabajar con metadatos de forma programática a través de la API. Use este fichero al diseñar o consultar grupos de propiedades de metadatos.

Versión	Fichero
8.2.5 y superior	llms-full-metadata-8.2.5.txt

llms-full-core-utils

Referencia completa de los beans de Spring de utilidades del núcleo de OpenKM (ArchiveUtils, FileUtils, MailUtils, PathUtils, WorkflowUtils, LegacySrv, ShardUtils, y otros). Cubre todos los métodos públicos con firmas y ejemplos de uso. Use este fichero al escribir scripts o plugins que dependan de utilidades internas de OpenKM.

Versión	Fichero
8.2.5 y superior	llms-full-core-utils-8.2.5.txt

llms-small-dbms

Referencia compacta del esquema de base de datos de OpenKM. Cubre las principales tablas SQL y sus columnas (nombre, tipo, descripción), agrupadas por área funcional: nodos del repositorio, permisos de seguridad, versiones de documentos, grupos de propiedades de metadatos, usuarios y roles, y el registro de actividad. Use este fichero al escribir consultas SQL o HQL directamente contra la base de datos de OpenKM.

Versión	Fichero
8.2.5 y superior	llms-small-dbms-8.2.5.txt