Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Kodexa Metadata Skills plugin is a Claude Code plugin published at kodexa-ai/kodexa-metadata-skills. It adds Kodexa-specific authoring guidance to Claude Code so it can work with platform metadata files instead of guessing schema shape from scratch.

Prerequisites

Before installing the plugin:
  • Install Claude Code.
  • Install the KDX CLI.
  • Configure KDX authentication for at least one Kodexa environment.
  • Have a Git repository for Kodexa metadata, or plan to create one with kdx sync pull --discover.

Install From The Marketplace

Run these commands in your terminal:
claude plugin marketplace add kodexa-ai/kodexa-metadata-skills
claude plugin install kodexa-metadata-skills
After installation, the skills are available in Claude Code sessions automatically.

Use A Local Checkout

For development or testing, load the plugin from a local clone:
git clone https://github.com/kodexa-ai/kodexa-metadata-skills.git
claude --plugin-dir ./kodexa-metadata-skills
Use a local checkout when you are testing a new version of the skills or contributing improvements to the plugin itself.

Let Claude Code Pick The Skill

Most of the time you can describe the work naturally:
Create an Activity Plan for invoice intake. It should extract invoice fields,
create a review task when confidence is low, call the ERP service bridge after
approval, and route rejected invoices to an exception status.
Claude Code should select the relevant Kodexa skill based on the task. For that example, it should use Activity Plan guidance, and may also draw on task template, data form, service bridge, and KDX CLI guidance depending on the files involved.

Invoke A Skill Directly

When you know the resource type, invoke the skill explicitly:
/kodexa-metadata-skills:activity-plan
/kodexa-metadata-skills:data-definition
/kodexa-metadata-skills:data-form
/kodexa-metadata-skills:task-template
/kodexa-metadata-skills:knowledge-system
/kodexa-metadata-skills:service-bridge
/kodexa-metadata-skills:module
/kodexa-metadata-skills:kdx-cli
Direct invocation is useful when you want Claude Code to stay focused on one class of metadata. For new business workflows, start from this order:
  1. data-definition: model the structured data the workflow produces.
  2. task-template: define the human work item.
  3. data-form: build the review UI for the task.
  4. activity-plan: define the automated process, including when it creates or waits for tasks.
  5. knowledge-system: add context-dependent prompts, rules, examples, or configuration.
  6. project-template or project bindings: bind reusable resources into the project.
  7. kdx-cli: validate and sync the configuration.
If you are maintaining older configuration, the skills repository may contain guidance for legacy resource shapes. For new orchestration work, use Activity Plans and triggers instead of putting process steps inside a Task template.

Verify The Plugin Is Available

Open Claude Code in your metadata repository and ask:
List the Kodexa metadata skills you have available and explain when to use each one.
Then ask it to inspect the repository layout:
Review this repository as a Kodexa metadata sync repo. Identify the sync-config,
manifest files, resource directories, and the safest next validation command.
Claude Code should respond with Kodexa-specific terminology and should not suggest deploying until it has inspected the local files.