LLM context files

OpenKM provides a set of plain-text context files following the llms.txt convention. Each file consolidates a specific area of the OpenKM documentation — method signatures, parameters, return types, code examples, and configuration details — into a single file optimised for LLM consumption.

The purpose of these files is to give any LLM (Claude, ChatGPT, Gemini, Copilot, etc.) accurate knowledge of the OpenKM internals so it can assist you in writing integration code, automation scripts, plugins, or SQL queries without hallucinating method names, incorrect signatures, or wrong table structures.

How to use them

The recommended workflow is to place the relevant file(s) in your project folder and reference them directly in your prompt using the @file syntax supported by most AI-assisted IDEs (Cursor, Windsurf, VS Code + Copilot, etc.) or by attaching them to your conversation in Claude, ChatGPT, or any other chat-based LLM.

You can load a single file or combine several of them depending on the task at hand. For example, when developing a plugin you may want to load both llms-full-plugins and llms-full-api together to give the LLM complete context.

Sample 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.

Available files

llms-full-api

Complete reference for the OpenKM Java API facades (OKMDocument, OKMFolder, OKMSearch, OKMPropertyGroup, etc.). Covers all public methods with their signatures, parameters, return types, thrown exceptions, and usage examples. Use this file when writing code that interacts with the OpenKM repository programmatically.

llms-full-plugins

Complete developer reference for the OpenKM plugin system. Covers all plugin types (Automation Action, Automation Validation, Crontab, Text Extractor, Document Converter, Search, Report, REST, Form validators, Suggestbox, OCR, and more), their interfaces, required method signatures, annotations, and implementation examples. Use this file when developing or extending OpenKM plugins.

llms-full-metadata

Complete reference for the OpenKM metadata system. Covers the property group XML definition format (DTD 3.15), all field types (Input, Select, SuggestBox, TextArea, CheckBox, etc.) with their attributes, validator and interceptor elements, security access control, internationalisation, and how to work with metadata programmatically via the API. Use this file when designing or querying metadata property groups.

llms-full-core-utils

Complete reference for the OpenKM core utility Spring beans (ArchiveUtils, FileUtils, MailUtils, PathUtils, WorkflowUtils, LegacySrv, ShardUtils, and others). Covers all public methods with signatures and usage examples. Use this file when writing scripts or plugins that rely on internal OpenKM utilities.

llms-small-dbms

Compact reference for the OpenKM database schema. Covers the main SQL tables and their columns (name, type, description), grouped by functional area: repository nodes, security permissions, document versions, metadata property groups, users and roles, and the activity log. Use this file when writing SQL or HQL queries directly against the OpenKM database.