@clix-so/clix-agent-skills 0.1.6 → 0.1.8

package/skills/personalization/SKILL.md

@@ -0,0 +1,128 @@
+---
+name: clix-personalization
+description:
+  Helps developers author and debug Clix personalization templates
+  (Liquid-style) for message content, deep links/URLs, and audience targeting.
+  Use when the user mentions personalization variables, Liquid, templates,
+  conditional logic, loops, filters, deep links, message logs, or when the user
+  types `clix-personalization`.
+---
+
+# Clix Personalization
+
+Use this skill to help developers write **personalized Clix campaigns** using
+template-based variables and light logic in:
+
+- **Message content** (title, body, subtitle)
+- **Links** (dynamic URL or deep link params)
+- **Audience targeting** (conditional include/exclude rules)
+
+## What the official docs guarantee (high-signal)
+
+- **Data namespaces**:
+  - `user.*` (user traits/properties)
+  - `event.*` (event payload properties)
+  - `trigger.*` (custom properties passed via API-trigger)
+  - Device/system vars: `device.id`, `device.platform`, `device.locale`,
+    `device.language`, `device.timezone`, plus `user.id`, `event.name`
+- **Missing variables** render as an **empty string**.
+- **Output**: print values with `{{ ... }}`.
+- **Conditionals**: `{% if %}`, `{% else %}`, `{% endif %}` with operators
+  `== != > < >= <= and or not`. Invalid conditions evaluate to `false`.
+- **Loops**: `{% for x in y %}` / `{% endfor %}` (use guards for empty lists).
+- **Filters**: `upcase`, `downcase`, `capitalize`, `default`, `join`, `split`,
+  `escape`, `strip`, `replace` (chain with `|`).
+- **Errors**: template rendering errors show up in **Message Logs**.
+
+## MCP-first (source of truth)
+
+If the Clix MCP tools are available, treat them as the source of truth:
+
+- `clix-mcp-server:search_docs` for personalization behavior and supported
+  syntax
+
+If MCP tools are not available, use the bundled references in `references/`.
+
+## Workflow (copy + check off)
+
+```
+Personalization progress:
+- [ ] 1) Identify where the template runs (message / URL / audience rule)
+- [ ] 2) Identify trigger type (event-triggered vs API-triggered)
+- [ ] 3) Confirm available inputs (user.*, event.*, trigger.*, device.*)
+- [ ] 4) Draft templates with guards/defaults
+- [ ] 5) Validate template structure (balance tags, avoid missing vars)
+- [ ] 6) Verify in Clix (preview/test payloads, check Message Logs)
+```
+
+## 1) Confirm the minimum inputs
+
+Ask only what’s needed:
+
+- **Where used**: title/body/subtitle vs URL/deep link vs audience targeting
+  rule
+- **Campaign trigger**:
+  - Event-triggered → `event.*` is available
+  - API-triggered → `trigger.*` is available
+- **Inputs**:
+  - Which `user.*` properties are set by the app
+  - Which `event.*` / `trigger.*` properties are passed (include example
+    payload)
+- **Fallback policy**: what to show when data is missing (default strings,
+  guards)
+
+## 2) Produce a “Template Plan” (before tweaking lots of templates)
+
+Return a compact table the user can approve:
+
+- **field** (title/body/url/audience)
+- **template** (Liquid)
+- **required variables** (and their source: user/event/trigger/device)
+- **fallbacks** (default filter and/or conditional guards)
+- **example payload** + **expected rendered output**
+
+## 3) Authoring guidelines (what to do by default)
+
+- Prefer **simple variables + `default`** over complex branching.
+- Add **guards** for optional data and for arrays (`size > 0`) before looping.
+- Prefer **pre-formatted** properties from your app (e.g., `"7.4 miles"`,
+  `"38m 40s"`) instead of formatting inside templates.
+- Keep logic minimal; complex branching belongs in the app or segmentation
+  setup.
+
+## 4) Validation (fast feedback loop)
+
+If you have a template file (recommended for review), run:
+
+```bash
+bash <skill-dir>/scripts/validate-template.sh path/to/template.liquid
+```
+
+This script does lightweight checks (matching `{% if %}`/`{% endif %}`,
+`{% for %}`/`{% endfor %}`, and brace balancing). It can’t guarantee the
+variables exist — you still need a payload + console verification.
+
+## 5) Verification checklist
+
+- **Missing data**: does the template still read well with empty strings?
+- **Trigger type**: API triggers use `trigger.*` (not `event.*`).
+- **Message Logs**: check rendering errors and fix syntax issues first.
+- **Upstream data**:
+  - If `user.*` is missing → fix user property setting (see
+    `clix-user-management`)
+  - If `event.*` is missing → fix event tracking payload (see
+    `clix-event-tracking`)
+
+## Progressive Disclosure
+
+- **Level 1**: This `SKILL.md` (always loaded)
+- **Level 2**: `references/` (load when writing/debugging templates)
+- **Level 3**: `scripts/` (execute directly, do not load into context)
+
+## References
+
+- `references/template-syntax.md` - Variables, output, conditionals, loops,
+  filters
+- `references/common-patterns.md` - Copy/paste patterns for messages + URLs +
+  guards
+- `references/debugging.md` - Troubleshooting missing variables and Message Logs

package/skills/personalization/references/common-patterns.md

@@ -0,0 +1,69 @@
+# Common Personalization Patterns (Reference)
+
+Copy/paste starting points for Clix templates. Prefer simple templates with
+guards/defaults.
+
+## Welcome / fallback-safe greeting
+
+```liquid
+Hi {{ user.username | default: "there" }},
+```
+
+## Dynamic message body (event-triggered)
+
+```liquid
+Hi {{ user.username | default: "Runner" }},
+you ran {{ event.distance | default: "?" }} miles in {{ event.elapsedTime | default: "?" }} seconds.
+```
+
+## Dynamic deep link / URL (event-triggered)
+
+```liquid
+myapp://run/summary?distance={{ event.distance }}&time={{ event.elapsedTime }}
+```
+
+Tip: If a value may contain spaces or special characters, prefer passing a
+pre-encoded string from your app (or keep the template value simple).
+
+## API-triggered promo (trigger.\*)
+
+```liquid
+🎉 {{ trigger.promotion | default: "A new promotion" }} is here!
+Get {{ trigger.discount | default: "a discount" }} off now!
+```
+
+## Conditional title by threshold
+
+```liquid
+{% if event.distance >= 10 %}
+Long run completed!
+{% else %}
+Good run today!
+{% endif %}
+```
+
+## Nested conditions (keep minimal)
+
+```liquid
+{% if user.tier == "pro" %}
+Pro stats updated successfully.
+{% else %}
+{% if event.elapsedTime > 3600 %}
+You ran for more than an hour! Great job!
+{% else %}
+New record saved.
+{% endif %}
+{% endif %}
+```
+
+## Looping over an array with a guard
+
+```liquid
+{% if user.badges and user.badges.size > 0 %}
+{% for badge in user.badges %}
+- {{ badge }}
+{% endfor %}
+{% else %}
+No badges yet.
+{% endif %}
+```

package/skills/personalization/references/debugging.md

@@ -0,0 +1,89 @@
+# Debugging Personalization (Reference)
+
+This guide helps you troubleshoot when a personalized message renders
+unexpectedly.
+
+## First principles (what the renderer does)
+
+- Unknown / missing variables render as an **empty string**.
+- Invalid conditions evaluate to `false`.
+- Template rendering errors (syntax issues) surface in **Message Logs**.
+
+## Quick checklist
+
+- **Are you using the right namespace?**
+  - Event-triggered campaign → use `event.*`
+  - API-triggered campaign → use `trigger.*`
+  - User traits/properties → use `user.*`
+- **Is the variable actually set upstream?**
+  - `user.*` comes from your app calling user property APIs.
+  - `event.*` comes from the event payload you track.
+  - `trigger.*` comes from properties in the API trigger request.
+- **Is the template resilient to missing data?**
+  - Add `| default: "..."` for strings.
+  - Wrap optional blocks in `{% if ... %}` guards.
+- **Are you looping safely?**
+  - Guard with `collection and collection.size > 0` before `{% for %}`.
+
+## Common failure modes
+
+### 1) Blank values
+
+Symptoms:
+
+- Output is missing where you expected text.
+
+Causes:
+
+- Variable doesn’t exist for that user/campaign trigger.
+
+Fix:
+
+- Use `default` for output values:
+
+```liquid
+{{ user.username | default: "Guest" }}
+```
+
+### 2) Conditional branch never runs
+
+Symptoms:
+
+- Always hits the `{% else %}` branch.
+
+Causes:
+
+- `event.*` is missing (or you should be using `trigger.*`).
+- Value is not the type you expect (e.g., string vs number).
+
+Fix:
+
+- Verify trigger type and payload shape.
+- Keep comparisons simple and ensure the property is sent as a number when you
+  compare numerically.
+
+### 3) Syntax error / rendering error
+
+Symptoms:
+
+- Message fails to render or shows an error in logs.
+
+Causes:
+
+- Missing `{% endif %}` / `{% endfor %}`
+- Unbalanced `{{` / `}}` or `{%` / `%}`
+
+Fix:
+
+- Check **Message Logs** first.
+- Validate the template structure locally:
+
+```bash
+bash <skill-dir>/scripts/validate-template.sh path/to/template.liquid
+```
+
+## When to escalate (data issue vs template issue)
+
+- If **defaults/guards** fix it → template issue.
+- If values are always blank across many users → upstream tracking/user-property
+  issue (fix app instrumentation).

package/skills/personalization/references/template-syntax.md

@@ -0,0 +1,113 @@
+# Personalization Template Syntax (Reference)
+
+This reference summarizes the personalization syntax supported by Clix
+templates.
+
+## Data namespaces
+
+- `user.*`: user properties (traits) you capture about a user
+  - Examples: `user.username`, `user.tier`
+- `event.*`: properties from the triggering event (event-triggered campaigns)
+  - Examples: `event.distance`, `event.elapsedTime`
+- `trigger.*`: custom properties passed via API trigger (API-triggered
+  campaigns)
+  - Examples: `trigger.promotion`, `trigger.discount`
+
+Missing or undefined variables render as an **empty string**.
+
+## Device and system variables
+
+Clix templates also support device and environment variables:
+
+- `device.id`
+- `device.platform` (`IOS` or `ANDROID`)
+- `device.locale`
+- `device.language`
+- `device.timezone`
+- `user.id` (project user id)
+- `event.name` (event name)
+
+## Output variables
+
+Print a value:
+
+```liquid
+{{ user.username }}
+```
+
+Nested / bracket access (useful when the key is not a valid identifier):
+
+```liquid
+{{ event["distance"] }}
+```
+
+## Conditionals
+
+Use `{% if %}`, `{% else %}`, `{% endif %}` blocks.
+
+Supported operators:
+
+- `==`, `!=`, `>`, `<`, `>=`, `<=`
+- `and`, `or`, `not`
+
+Example:
+
+```liquid
+{% if event.distance >= 10 %}
+Amazing! You completed a long run today.
+{% else %}
+Nice work! Keep it up!
+{% endif %}
+```
+
+Notes:
+
+- Unknown variables render as empty strings.
+- Invalid conditions evaluate to `false`.
+
+## Loops
+
+Iterate over arrays with `{% for %}` / `{% endfor %}`:
+
+```liquid
+{% for badge in user.badges %}
+- {{ badge }}
+{% endfor %}
+```
+
+Guard empty collections:
+
+```liquid
+{% if user.badges and user.badges.size > 0 %}
+{% for badge in user.badges %}
+{{ badge }}
+{% endfor %}
+{% else %}
+No badges yet.
+{% endif %}
+```
+
+## Filters
+
+Filters transform values inside `{{ ... }}` blocks and can be chained with `|`.
+
+Supported filters:
+
+- `upcase` / `downcase`
+- `capitalize`
+- `default`
+- `join`
+- `split`
+- `escape`
+- `strip`
+- `replace`
+
+Examples:
+
+```liquid
+Hi {{ user.username | default: "Guest" }}
+```
+
+```liquid
+{{ user.username | default: "Guest" | upcase }}
+```

package/skills/personalization/scripts/validate-template.sh

@@ -0,0 +1,134 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+usage() {
+  cat <<'EOF'
+Validate a Clix personalization template (Liquid-style) with lightweight checks.
+
+Usage:
+  validate-template.sh <template-file>
+
+Checks:
+  - Balanced {{ ... }} and {% ... %} delimiters
+  - Properly nested {% if %}/{% endif %} and {% for %}/{% endfor %} blocks
+
+Notes:
+  - This is a best-effort validator; it cannot guarantee that variables exist.
+  - If Clix shows a rendering error, always trust Message Logs as the source of truth.
+EOF
+}
+
+if [[ "${1:-}" == "-h" || "${1:-}" == "--help" || "${1:-}" == "" ]]; then
+  usage
+  exit 0
+fi
+
+file="$1"
+
+if [[ ! -f "$file" ]]; then
+  echo "Error: file not found: $file" >&2
+  exit 2
+fi
+
+errors=0
+
+echo "Validating: $file"
+
+brace_counts="$(
+  awk '
+    {
+      c_open_curly += gsub(/\{\{/, "&");
+      c_close_curly += gsub(/\}\}/, "&");
+      c_open_tag += gsub(/\{%/, "&");
+      c_close_tag += gsub(/%\}/, "&");
+    }
+    END {
+      printf("%d %d %d %d\n", c_open_curly, c_close_curly, c_open_tag, c_close_tag);
+    }
+  ' "$file"
+)"
+
+read -r open_curly close_curly open_tag close_tag <<<"$brace_counts"
+
+if [[ "$open_curly" -ne "$close_curly" ]]; then
+  echo "Error: unbalanced mustache braces: '{{'=$open_curly vs '}}'=$close_curly" >&2
+  errors=$((errors + 1))
+fi
+
+if [[ "$open_tag" -ne "$close_tag" ]]; then
+  echo "Error: unbalanced tag braces: '{%'=$open_tag vs '%}'=$close_tag" >&2
+  errors=$((errors + 1))
+fi
+
+awk_exit=0
+awk '
+  function trim(s) { sub(/^[ \t\r\n]+/, "", s); sub(/[ \t\r\n]+$/, "", s); return s }
+  function push(x) { stack[++sp] = x }
+  function top() { return stack[sp] }
+  function pop() { if (sp > 0) return stack[sp--]; return "" }
+
+  BEGIN { sp = 0; errors = 0 }
+
+  {
+    line = $0
+    while (match(line, /\{%[ \t]*[^%]*%\}/)) {
+      tag = substr(line, RSTART, RLENGTH)
+      inner = tag
+      gsub(/^\{%[ \t]*/, "", inner)
+      gsub(/[ \t]*%\}$/, "", inner)
+      inner = trim(inner)
+
+      # Tag name is first token.
+      split(inner, parts, /[ \t]+/)
+      name = parts[1]
+
+      if (name == "if") {
+        push("if")
+      } else if (name == "for") {
+        push("for")
+      } else if (name == "endif") {
+        if (top() != "if") {
+          printf("Error: found endif but top of stack is '%s'\n", top()) > "/dev/stderr"
+          errors++
+        } else {
+          pop()
+        }
+      } else if (name == "endfor") {
+        if (top() != "for") {
+          printf("Error: found endfor but top of stack is '%s'\n", top()) > "/dev/stderr"
+          errors++
+        } else {
+          pop()
+        }
+      } else if (name == "else" || name == "elsif") {
+        if (top() != "if") {
+          printf("Error: found %s outside of if block\n", name) > "/dev/stderr"
+          errors++
+        }
+      }
+
+      # Move forward in line after the matched tag.
+      line = substr(line, RSTART + RLENGTH)
+    }
+  }
+
+  END {
+    if (sp > 0) {
+      printf("Error: unclosed blocks remaining on stack (count=%d)\n", sp) > "/dev/stderr"
+      errors++
+    }
+    exit(errors > 0 ? 1 : 0)
+  }
+' "$file" || awk_exit=$?
+
+if [[ "$awk_exit" -ne 0 ]]; then
+  errors=$((errors + 1))
+fi
+
+if [[ "$errors" -ne 0 ]]; then
+  echo "❌ Validation failed ($errors issue(s))." >&2
+  exit 1
+fi
+
+echo "✅ Template structure looks OK."
+