Skip to main content

AI-friendly Documentation Setup

Point your AI coding assistant at this documentation so it can answer Logi Actions SDK questions from authoritative content. Every page on the site is also published as plain Markdown for direct AI consumption.

llms.txt​

Give your AI tool the URL below as its entry point. llms.txt is a flat index of every page's Markdown twin — one entry per page, each with a short description and a direct link to the .md file:

llms-full.txt​

llms-full.txt is the whole documentation set in one file — the llms.txt followed by the complete Markdown of every documentation page. Use it when your AI tool can load one large file up front instead of fetching pages on demand:

Confirm this file fits your tool's context window before loading it whole. For smaller context windows, use the llms.txt index above and fetch individual pages as needed.

Per-page Markdown​

Every page has a Markdown twin at the same URL with .md appended. For example:

Local C# API reference (PluginApi.xml)​

Logi Plugin Service ships with an XML documentation file that gives IDEs their tooltips for the Actions SDK, and it's already on every Windows machine where Logi Plugin Service is installed. Note that the macOS version does not ship with this XML documentation file.

Point your AI tool at it when you want API summaries that match the SDK version you have installed:

  • Windows: C:\Program Files\Logi\LogiPluginService\PluginApi.xml

Use PluginApi.xml alongside this documentation, not as a replacement for it. The XML file describes individual API members in isolation; it carries no guidance on how to structure a plugin.

Staying up to date​

The Markdown files are always kept in sync with the published documentation, so anything your AI tool fetches reflects the current docs. Re-fetch whenever you want fresher context — the hosted files need nothing to install or maintain locally.

PluginApi.xml is part of the Logi Plugin Service installation, so it tracks the Plugin API version on that machine and refreshes whenever the service updates.