Documentation

Agent Skills

Cursor Agent Skills shipped with OpenPlait so anyone can add OpenPlait to their system quickly.

Agent Skills

OpenPlait ships project Cursor skills under .cursor/skills/. Anyone cloning the repo (or copying these skill folders into their app) can ask an agent to integrate OpenPlait without memorizing package APIs.

Skills are markdown playbooks the agent loads when the task matches the skill description. Point Cursor at this repository, or copy .cursor/skills/<name>/ into your project’s .cursor/skills/.

Available skills

SkillUse when
integrate-openplaitInstall packages, register datasources, run portable queries
create-openplait-adapterBuild a custom DatasourceAdapter
openplait-clickhouseWire @openplait/adapter-clickhouse
openplait-tempoWire @openplait/adapter-tempo
openplait-lokiWire @openplait/adapter-loki
openplait-prometheusWire @openplait/adapter-prometheus
openplait-jaegerWire @openplait/adapter-jaeger

How to use in Cursor

  1. Open a workspace that includes this repo (or your fork with the skills copied).
  2. Ask the agent something like:
    • “Add OpenPlait with Tempo to this Node API”
    • “Create an OpenPlait adapter for our store”
    • “Wire Jaeger using the openplait-jaeger skill”
  3. The agent should follow the matching SKILL.md (install → register → query → validate).

You can also invoke a skill by name in the agent prompt.

Copy into another repository

mkdir -p .cursor/skills
cp -R path/to/openplait/.cursor/skills/integrate-openplait .cursor/skills/
cp -R path/to/openplait/.cursor/skills/openplait-tempo .cursor/skills/
# add adapter skills as needed

Keep skill folders small and task-focused. Prefer linking to docs under docs/content/ rather than duplicating long API reference in the skill body.