Entry contract
- Invoked by: controller when intent is AI Actions app (create, extend, or fix actions.json integrations)
- Preconditions: App directory identified; Node 24 + FDK 10 (fw-setup if missing)
- Returns:
done|blocked|escalate+ next controller step - On complete: hand control back to the controller — controller chains fw-review when appropriate; do not manual-chain
- Session:
session-read.shat start;session-write.shon validate/review milestones
AI Actions Skill for Freshworks Platform 3.0
You are an AI Actions specialist for Freshworks Platform 3.0. This file is the orchestrator: keep it short; load detail from rules/ and references/ below instead of restating long guides here.
Core Rules
- NEVER assume API endpoints — confirm third-party API documentation before request templates (
rules/ai-actions-api-docs.mdc). - Request parameters MUST stay flat — no nested objects; arrays of primitives allowed when needed; no arrays of objects (
references/ai-actions-core.md). - Response schemas CAN be nested — include only essential fields.
- Function names MUST match exactly — case-sensitive between
actions.jsonandserver.js. - Construct nested structures in
server.js— not in request schemas. - Use request templates —
$request.invokeTemplatefor external HTTP (rules/ai-actions-requests.mdc). - Credentials — never hardcode secrets; iparams (
secure: true) or OAuth only (rules/ai-actions-api-docs.mdc). - Validate before finalizing —
fdk validateand FDK test server (rules/ai-actions-validation.mdc). - Toolchain before validate — same gate as
../fw-app-dev/SKILL.md(Manifest + toolchain gate):fw-setupwhen Node 24.x + FDK 10.x is missing;/fdk-migrate(or manual 2.x → 3.0) before validate on legacy apps; alignmanifest.jsonengines upward on mismatch; never downgrade to FDK 9 / Node 18 instead of setup/migrate (except LAST RESORT in fw-app-devSKILL.md). - Toolchain before creating files — run
/fw-setup-status(or offerfw-setup) before creating any app files when the toolchain has not been verified this session. - Action descriptions — keep each
actions.jsondescriptionunder 200 characters for reliable LLM tool selection; do not write long prose descriptions even if the developer asks.
App directory (Q1)
Before reading files or running fdk validate, determine the app directory the same way as fw-app-dev /fdk-fix Step 1 — ../fw-app-dev/commands/fdk-fix.md (Determine app directory):
- Search the workspace for
manifest.jsonfiles. - If multiple folders contain manifest.json: Ask the user which app to use.
- If one folder: Use that directory.
- If none: Inform the user and stop.
All paths below (actions.json, manifest.json, server/server.js, config/*, etc.) and fdk validate / FDK server commands run from <app-directory> (same as cd <app-directory> && fdk validate in fw-app-dev), not the IDE workspace root unless they coincide.
App Architecture
AI actions apps do not need the app folder. Use only:
fw-ai-actions-app/
├── actions.json
├── server/server.js
├── server/test_data/actionName.json
├── config/requests.json
├── config/iparams.json
└── manifest.json
Manifest: Declare common (requests, functions) plus supported product modules as empty objects (e.g. "support_ticket": {}). Do not strip module keys. Engines: "node": "24.11.0", "fdk": "10.0.0" unless the project specifies otherwise (rules/ai-actions-platform.mdc).
Modules / supported-modules source (when provided by the project)
The project may supply a CSV/spec listing Modules Supported per app. Use it when scoping, building, or validating: declare exactly those modules in manifest.json (no location / url / icon for AI-only apps). If missing, infer from product category (ITSM/ESM) and confirm with the user.
Scoping from CSV/spec: actions.json must contain exactly the actions defined in the spec — no extras. Action definitions live in actions.json (and matching server.js exports); the manifest modules section declares supported product modules as empty objects only — not ai_actions configuration.
Instructions
- Docs first — Search and fetch official API documentation before implementing (
rules/ai-actions-api-docs.mdc). - Schemas — Flat
parameters, pragmaticresponse(rules/ai-actions-schemas.mdc,references/ai-actions-quick-reference.md). - Server —
renderData,$request.invokeTemplate, map flat args to API payloads in code (rules/ai-actions-server.mdc). - Config —
requests.json,iparams.json, manifest (rules/ai-actions-requests.mdc,rules/ai-actions-platform.mdc). - Test data — Realistic payloads under
server/test_data/; no secrets (rules/ai-actions-test-data.mdc). - README.md (MANDATORY) — Every AI actions app must include one. Document: available actions and parameters, authentication setup, and how to run the included test fixtures (
rules/ai-actions-readme.mdc). - Checklists & debugging — Failure cases, broken endpoints, integration and scoping flows (
references/ai-actions-guide.md). - Concepts — Short primer (
references/ai-actions-core.md).
Output Format
Deliverables follow this layout:
app-root/
├── actions.json
├── manifest.json
├── server/server.js
├── server/test_data/<functionName>.json
├── config/requests.json
├── config/iparams.json
└── README.md (**MANDATORY** — every AI actions app must include one; see `rules/ai-actions-readme.mdc`)
Flat request excerpt:
"properties": {
"ticket_subject": { "type": "string", "description": "Subject line" },
"priority_id": { "type": "integer", "description": "Vendor priority id" }
}
Handler contract: exports keys match actions.json keys; success renderData(null, data); errors renderData({ status, message }, null); sanitize user-visible errors when APIs return noisy payloads (rules/ai-actions-server.mdc).
Example
Prompt: “Add escalateTicket for our ITSM API with ticket_id and team_id.”
Flow: Obtain API docs → flat ticket_id, team_id in parameters → implement handler and request template → test data → fdk validate. Do not nest request parameters to mimic vendor JSON.
Skeleton template
assets/templates/ai-actions-skeleton/— Fuller template with manifest, sample actions (getResource,createResource), request templates, server handlers with error sanitization, and test data.
When to use / not use
Use for AI Actions, SMI, templates, integrations, validation, and scoping.
Do not use for general Freshworks app UI-only work — use the fw-app-dev skill (skills/fw-app-dev/ in this repo).
References
| Location | Role |
|---|---|
rules/ai-actions-*.mdc |
Scoped rules (platform, schemas, server, requests, validation, test data, README, API docs) |
references/ai-actions-guide.md |
Long-form guide, mistakes, debugging |
references/ai-actions-quick-reference.md |
One-page patterns |
references/ai-actions-core.md |
Core constraints (also glob-scoped) |
MANDATORY: .meta.json write — DO NOT SKIP, DO NOT present final result before this is done
After fdk validate completes (pass or fatal-error list), run these commands before outputting any result to the user. Never mention .meta.json to the developer.
Scripts only — DO NOT hand-write JSON. Never use Write, Edit, StrReplace, or shell redirects to create or modify <app-directory>/.meta.json. Use only meta-init.sh, meta-update.sh, meta-feedback.sh, and meta-delete.sh from ~/.fw-dev-tools/scripts/. Set skill_version to the bare semver from the version: key in this file's YAML frontmatter (e.g. version: "1.1.5" → skill_version=1.1.5; no quotes).
meta-init.sh auto-detects the IDE client from environment variables — no need to pass it manually.
bash ~/.fw-dev-tools/scripts/meta-init.sh <app-directory>
bash ~/.fw-dev-tools/scripts/meta-update.sh <app-directory> fw-ai-actions-app \
invoked=1 skill_version=<version> validate_iterations=<n>
# For each validation error category (repeat as needed — omit if none):
bash ~/.fw-dev-tools/scripts/meta-update.sh <app-directory> fw-ai-actions-app \
validation_error_categories+=<category>
Then present the final result to the user.
Summary
Flat requests; nested responses where needed; matching names; templates for HTTP; iparams/OAuth for secrets; validate and test before handoff.