Skip to content

Working with AI

While we don’t have our own MCP server yet, we provide an official Agent Skill and llms.txt to help AI agents understand the structure and syntax of the Sveltia CMS configuration. Generated from this documentation site, these can be used with AI code assistants, such as GitHub Copilot, ChatGPT, Claude, and others, to enhance their ability to help you write and edit the configuration file.

Work-in-Progress

This site is still under development, and the documentation may contain inaccurate or incomplete information. The Agent Skill and llms.txt files are automatically generated from the documentation site, so they may also contain errors or omissions. We’ll continue to improve the documentation and these files over time.

Agent Skill

An Agent Skill is a folder of instructions and reference material that an AI coding agent loads only when it’s relevant. Our official skill teaches agents how to install, configure, migrate and debug Sveltia CMS, and it includes a script that validates your configuration file against the JSON schema published with the current release.

Unofficial Skills

Several third-party Sveltia CMS skills are listed in agent skill directories. They are not maintained by us, and the ones we have reviewed are pinned to old releases and repeat outdated version numbers and feature claims. We recommend the official skill below.

Installing in Claude Code

Add our marketplace, then install the plugin:

/plugin marketplace add sveltia/ai-tools
/plugin install sveltia-cms@sveltia

Run /plugin marketplace update sveltia to pick up documentation updates.

Installing in Other Agents

The skill follows the open Agent Skills specification, so it works with any compatible agent, including Claude, Codex, Cursor, GitHub Copilot and Gemini CLI. Copy the plugins/sveltia-cms/skills/sveltia-cms folder from our ai-tools repository into the location your agent reads skills from, and check your agent’s documentation for that path.

Validating Your Configuration

The skill bundles a validation script you can also run directly, without an agent. It requires Node.js:

sh
node scripts/validate-config.mjs public/admin/config.yml

It reports unknown options, unsupported values and invalid names, along with a few common mistakes in the admin page markup. Pass --version to check against a specific release, or --offline to reuse the cached schema.

llms.txt

We also generate standard llms.txt files from this documentation site.

Available llms.txt Files

There are two versions of the Sveltia CMS documentation available as llms.txt files:

  • llms.txt: A sitemap-style version of the documentation, including the title and description of each page. (4k+ tokens)
    https://sveltiacms.app/llms.txt
  • llms-full.txt: A complete version of the documentation, including all page content, code examples, and showcase examples. (290k+ tokens)
    https://sveltiacms.app/llms-full.txt

Using the llms.txt Files

If you use GitHub Copilot in VS Code, you can use the #fetch tool in the chat interface to load the llms.txt file as context:

#fetch https://sveltiacms.app/llms.txt

If you use Cursor, you can add the llms.txt file using the @docs feature.

For other AI agents, refer to their documentation on how to add custom knowledge sources or context files.