Using these docs with AI agents
When an AI coding agent (Claude Code, Cursor, GitHub Copilot, Codex…) writes your integration, point it at the resources below. They hold the same content as the pages you read, in forms an agent fetches and parses easily. The last section has a paragraph you can paste into your agent's instructions.
Start with llms.txt
| File | What it holds |
|---|---|
| llms.txt | Index of the English pages, grouped by product, each with its Markdown URL and a one-line description. A product's quick reference comes first. Pages not yet in English link the Portuguese version, marked (pt-br). It ends with the OpenAPI specifications. |
| llms-full.txt | The same pages in full, in one file, each under a heading with its URL. |
| pt-br/llms.txt, pt-br/llms-full.txt | The same for the Portuguese pages. |
Both follow the llms.txt format.
Every page as Markdown
Add .md to any page URL to get the page as plain Markdown. For example,
https://docs.lacunasoftware.com/en-us/articles/signer/get-started.md is the Markdown version of
https://docs.lacunasoftware.com/en-us/articles/signer/get-started.
- The front matter gives the title, description, canonical URL, locale, product and the date of the last change.
- Tabs become one code block per tab, each with a bold label; notes and warnings become blockquotes; links and images are absolute URLs.
- Each page links its Markdown version in its HTML head (
<link rel="alternate" type="text/markdown">) and under its content (View as Markdown, Copy page as Markdown). - The PKI SDK .NET API reference works the same way: https://docs.lacunasoftware.com/api/Lacuna.Pki/PKCertificate.md.
Quick references
One page per product with what an integration needs first: install, configuration and authentication, core
operations with code, errors, test certificates, demos and samples. Facts the docs do not cover yet are marked
TODO(docs) instead of guessed.
Not sure which product fits? See Choosing a product.
API specifications
The OpenAPI specification of each cloud API is copied to a stable URL on this site. On-premises instances serve
their own at /swagger.
Demos and samples
- Demos: https://try.lacunasoftware.com/demos.json lists the live demos of try.lacunasoftware.com, with the product, the docs page and the samples of each.
- Samples: the PkiSuiteSamples and
SignerSamples repositories each keep a
samples.jsoncatalog: one entry per task and language, with the file to read, how to run it, the docs page and the demo. - Pages that cover a task end with a Demos and samples box linking the demo and the sample in each language.
A paragraph to give your agent
Paste this into your agent's instructions (for example CLAUDE.md, AGENTS.md or .cursor/rules), and name the
product you use:
This project integrates Lacuna Software products (digital certificates, digital signatures, PKI).
Use the official docs at https://docs.lacunasoftware.com and read them as Markdown:
- Start with https://docs.lacunasoftware.com/llms.txt, the index of all pages by product.
- Add ".md" to any docs page URL to get its Markdown version.
- Read the product's quick reference first (listed first under the product in llms.txt): packages,
configuration, core operations, errors and samples.
- For REST APIs, use the OpenAPI specs at https://docs.lacunasoftware.com/openapi/ (listed at the
end of llms.txt).
- For working code, follow the samples linked from the docs pages (PkiSuiteSamples and
SignerSamples on GitHub) in this project's language.
Do not guess package names, versions, endpoints or headers: take them from the quick reference, the
OpenAPI spec or a sample. When developing, use the test certificates from
https://docs.lacunasoftware.com/en-us/articles/pki-guide/test-certs, never production certificates.