Tools
| Tool | Purpose |
|---|---|
| Read | Read project files |
| Glob | Find files by pattern |
| Grep | Search file contents |
| Bash | Run shell commands (e.g., check node version) |
| Edit | Modify existing files |
| Write | Create new files |
Skills loaded
The detecteduserplane-{framework} skill, plus:
userplane-best-practices— cross-cutting install and SDK guidanceuserplane-cdn— script placement, CSP directives, redirect handlinguserplane-web-sdk—initialize()API and recording stateuserplane-metadata-sdk—setUser()/setMetadata()API
Workflow
- Reads
package.jsonto detect the framework. - Loads the matching framework skill as the source of truth.
- Checks for an existing Userplane install — aborts if found.
- Asks for the write key if not already in the environment.
- Creates the provider file and registers it at the app root.
- Wires the environment variable (
.env.localor framework equivalent). - Adds CSP headers when the framework has a headers config.
- Reports a summary of files changed and the next step.
Hard rules
- Does not invent API shapes — only writes what the skill documents.
- Does not duplicate existing providers — searches before creating.
- Does not skip CSP guidance for frameworks with a headers config.
- Stops if Userplane is already installed and directs to
/userplane:audit.
Related articles
- /userplane:integrate — the command that invokes this agent.
- Skills Catalog — the framework skills this agent loads.