@wokuapp/ai-toolkit 0.2.2 → 0.4.0

package/.claude-plugin/marketplace.json

@@ -11,7 +11,7 @@
       "name": "woku",
       "source": "./",
       "description": "Design a listening program for your customer journey, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
-      "version": "0.2.1",
+      "version": "0.4.0",
       "author": { "name": "woku" },
       "license": "MIT",
       "homepage": "https://woku.app",

package/.claude-plugin/plugin.json

@@ -1,7 +1,7 @@
 {
   "name": "woku",
   "description": "Voice-of-customer for Claude Code. Design a listening program for your customer journey, run the fast VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server. Bundles the woku method so the agent acts as a CX consultant.",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "author": {
     "name": "woku"
   },

package/.codex-plugin/plugin.json

@@ -1,6 +1,6 @@
 {
   "name": "woku",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Voice-of-customer for OpenAI Codex. Design a listening program, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
   "author": {
     "name": "woku"

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.4.0
+
+Follow the admin period picker, search box and Sends tab. The woku skill documents `from`/`to` on `get_woku_report`, `get_folder_report` and `get_company_nps_report` (period reports generated on demand, with `periodFrom`/`periodTo`), the custom `from`/`to` range on `get_folder_tools_metrics`, the `q` text search on `list_woku_reviews`, `list_nps_responses`, `list_csat_responses` and `list_ces_responses`, and the read-only `invitations` toolset (`get_invitation_stats`, `list_invitations_by_tool`, `list_invitation_recipients`). It adds the reports the admin opens and the MCP now serves (`get_nps_tool_report`, `get_csat_report`, `get_ces_report`, `scope` on `get_company_nps_report`, `regenerate` on every report tool), and the SDK skills drop `quarantines`, which left the public API. Requires the server and SDK releases that ship them.
+
+## 0.3.0
+
+Also the per-tool metrics of a folder (`get_folder_tools_metrics`, `folders.metrics`), tracker chips on `search_voc_tools` and `tools.list` (`trackers`) and `integrationProvider` on integration folders.
+
+Cover folders and the unified tools view: the woku skill documents the MCP tools
+`search_voc_tools`, `get_voc_tools_stats`, `move_voc_tools`, `update_folder` (also sets the folder's `whatsappAlertRecipients`),
+`delete_folder`, `get_folder_report` (`scope: "all"`, `format: "csv"`), `folderId`
+on `create_nps_tool`, `create_csat_tool` and `create_ces_tool`, and the
+`organize_listening` playbook, flows with ordered steps (`create_flow`, `update_flow`, `get_flow` with `steps`), and journeys in folders (`get_journey_folders_status`, `organize_journey_folders`, `folderId` and `momentFolders` on journeys). The JavaScript and Python SDK skills add the
+`folders` and `tools` resources. Requires the server and SDK releases that ship them. The skills also cover the folder PDF in the SDKs (`folders.pdf`) and the folders paging (`foldersLimit`, `foldersCursor`) of `search_voc_tools` and `tools.list`.
+
 ## 0.2.2
 
 Reconcile journey/MCP workflows, reviewed proposals, local media, SDK v4 methods,

package/README.md

@@ -100,6 +100,26 @@ Every connection is bound to one company, chosen when you approve access. Read t
 
 MIT. See [LICENSE](./LICENSE).
 
+### Periods, search and sends update (0.4.0)
+
+The woku skill follows the admin period picker, search box and Sends tab: `from`/`to`
+on `get_woku_report`, `get_folder_report` and `get_company_nps_report` (the period report
+is generated on demand), a custom `from`/`to` range on `get_folder_tools_metrics`, `q`
+text search on `list_woku_reviews`, `list_nps_responses`, `list_csat_responses` and
+`list_ces_responses`, and the read-only `invitations` toolset (`get_invitation_stats`,
+`list_invitations_by_tool`, `list_invitation_recipients`). The report tools add
+`get_nps_tool_report`, `get_csat_report` and `get_ces_report`, and take `regenerate`.
+The SDK skills drop `quarantines`. Verify the server and SDK releases before using them.
+
+### Folders and tools update (0.3.0)
+
+The skills now cover the folder tree that holds wokus and NPS, CSAT and CES tools:
+the MCP tools `search_voc_tools` (with tracker chips), `get_voc_tools_stats`, `get_folder_tools_metrics`, `move_voc_tools`,
+`update_folder`, `delete_folder`, `get_folder_report` (`scope: "all"`, `format: "csv"`),
+`get_journey_folders_status`, `organize_journey_folders`, flow `steps` in `create_flow` and `update_flow`, `folderId` on the `create_*_tool` tools, the `organize_listening` playbook of
+`woku_guide`, and the SDK `folders` and `tools` resources in JavaScript and Python.
+Verify the installed SDK and server release before using them.
+
 ### Journey guidance update (0.2.2)
 
 The bundled skills now route coordinated evaluations through journeys, preserve a

package/openclaw.plugin.json

@@ -2,7 +2,7 @@
   "id": "woku-ai-toolkit",
   "name": "woku AI Toolkit",
   "description": "Voice-of-customer for your agent. Design a listening program, run the VoC instruments (NPS, CSAT, CES, wokus), and turn every signal into a support ticket or an action plan, through woku's MCP server.",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "skills": [
     "./skills"
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wokuapp/ai-toolkit",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "woku AI Toolkit: connect your agent to woku's voice-of-customer platform. Design VoC programs and turn customer feedback into support tickets and action plans, through woku's MCP server.",
   "author": "woku",
   "license": "MIT",

package/skills/woku/SKILL.md

@@ -56,6 +56,39 @@ Read tools need no special permission. Write tools require the `mcp:write` scope
    reminders are enabled; a stopped or completed cycle may be followed by another,
    but never two open evaluations for the same subject in the same journey.
 
+## Flows with steps
+
+A flow is an ordered sequence of steps a respondent answers one after another. `create_flow` and `update_flow` take `steps`: 1 to 20 `{ type, toolId }` where `type` is `woku`, `nps`, `csat` or `ces` (each tool once, all of the company; for the company-level NPS use the company id as `toolId`). The older `wokusIds` and `npsId` still work. `get_flow` and `list_flows` return `steps`. Flows live outside folders. Call `woku_guide` with topic `flows`.
+
+## Organize the listening in folders
+
+One folder tree holds wokus and NPS, CSAT and CES tools together. Call `woku_guide` with topic `organize_listening` first.
+
+- `search_voc_tools` lists a folder level or searches the whole company (any type, case and accent insensitive, cursor paginated) and returns folders with stats, tools with their native-scale headline and counts per type.
+- `search_voc_tools` also takes `trackers` (`"name:value"` chips, up to 10; a tool must have every one; the tracker name is matched exactly and the value partially and ignoring case, so `482` also matches `00482`; company-wide, no folders; a chip without name or value is an error) to find tools by tracker.
+- `get_folder_tools_metrics` gives, for a folder and its subfolders, per-tool figures for 7, 30 (default) or 90 days, or a custom `from`/`to` range of days (`YYYY-MM-DD`, both inclusive, up to 731 days), against the period before (0 = whole history) and the histogram of scores. It returns `toolCount` and the busiest tools (`limit`, default 50); the daily sums only with `includeDaily: true`. Use it for trends and to find the weakest tools; never average across types.
+- `get_voc_tools_stats` gives reviews and the headline of each type (woku stars, NPS score, CSAT satisfied %, CES mean) for the company or one folder. Never average across types: the scales differ.
+- `create_folder`, `update_folder` (rename, recolor, or set `whatsappAlertRecipients`: the WhatsApp numbers alerted when a comment of any tool in the folder is an improvement) and `move_voc_tools` (items of mixed types, `folderId: null` for the root) organize the tree; `create_nps_tool`, `create_csat_tool` and `create_ces_tool` accept `folderId`.
+- `get_folder_report` with `scope: "all"` returns the mixed AI report of a folder and its subfolders, and with `format: "csv"` the responses as CSV text. `search_voc_tools` accepts `foldersLimit` and `foldersCursor` to page the folders ("see more"; `foldersNextCursor` in the result). The folder PDF is binary, so it is only on the API and the SDKs (`GET /v1/folders/{id}/pdf`).
+- Journeys can live in folders (`Viajes > journey > moment`): `get_journey_folders_status` shows whether the company organizes them and what is pending, and `organize_journey_folders` switches it on and runs a background pass that only moves tools without a folder (propose it and wait for approval; it returns a conflict while a pass is running). `get_journey` and `list_journeys` show `folderId` and `momentFolders`, and folders created by woku carry an `origin` (`journeys-root`, `journey`, `journey-moment`, `integration`; integration folders also carry `integrationProvider`, for example `shopify`); read `origin`, `integrationProvider` and the stats of a folder with `search_voc_tools`, not with `get_folder` or `list_folders`, which only count wokus.
+- `delete_folder` needs `confirm: true`; nothing inside is deleted, the content moves up to the parent. Moving or deleting folders is a user decision: propose the new structure and wait for approval.
+
+## Periods and text search
+
+The tools follow the admin period picker and search box.
+
+- The report tools return what the admin report page shows: `get_woku_report`, `get_folder_report` (also with `scope: "all"`), `get_company_nps_report` (`scope: "general"` keeps only the company's own NPS survey), `get_nps_tool_report`, and `get_csat_report` / `get_ces_report` (one tool with its id, the whole company without it). A report is generated when missing or stale and cached; `regenerate: true` rebuilds it like the admin "Regenerate report" button and needs the `mcp:write` scope.
+- All of them take `from`/`to` (`YYYY-MM-DD`, UTC, both inclusive, given together) to restrict the AI report to the reviews of that period. A period report is generated on demand (it can take a few seconds), carries `periodFrom`/`periodTo`, and a period without reviews returns an empty report, not an error. The CSV ignores the period.
+- `list_woku_reviews`, `list_nps_responses`, `list_csat_responses` and `list_ces_responses` take `q` to keep only the responses whose comment contains that text (case and accent insensitive, 2 to 100 characters), plus their `from`/`to` range.
+
+## Sends
+
+Read-only tools of the `invitations` toolset show the invitations the company sent by email and WhatsApp (admin, API, MCP and integrations):
+
+- `get_invitation_stats` gives, for an optional `from`/`to` period, the sent, delivered and answered invitations, the response rate and the ones never sent by reason (`no_whatsapp_credits`, `notifications_disabled`, `provider_error`).
+- `list_invitations_by_tool` gives, per tool, the invitations sent by email and by WhatsApp, the ones not sent and the answered ones.
+- `list_invitation_recipients` lists who got a tool's invitations and what happened to each one; use `status: "invited"` to find who has not answered yet before proposing a reminder with the `send_*` tools.
+
 Tickets use email destinations; plans use groups of platform users. Tickets and
 Data Studio are Corporate capabilities. Do not expose retired reports, alerts,
 goals, data-source or data-flow management through examples; instrument reports

package/skills/woku-sdk-javascript/SKILL.md

@@ -71,7 +71,8 @@ await woku.actionPlans.complete('plan_123');
 
 Namespaces: `trackers`, `npsTools` / `csatTools` / `cesTools`, `nps` / `csat` /
 `ces`, `wokus`, `forms`, `flows`, `actionPlans`, `actionPlanGroups`, `tickets`,
-`ticketDestinations`, `dispatches`, `reports`, `company`, `quarantines`, `journeys`, `media`.
+`ticketDestinations`, `dispatches`, `reports`, `company`, `journeys`, `media`,
+`folders`, `tools`, `journeyFolders`.
 
 ## Pagination, errors, retries
 
@@ -96,6 +97,43 @@ user to the SDK page at https://woku.app/docs/en/development/sdk-javascript and
 API reference at https://woku.app/docs/en/development/api. There is an equivalent
 Python SDK (`woku`) documented at /development/sdk-python.
 
+## Folders and tools
+
+One folder tree holds wokus and NPS, CSAT and CES tools. Needs the SDK release that ships `folders` and `tools`; verify the installed version.
+
+```ts
+const folder = await woku.folders.create({ name: 'Post-sale' });
+await woku.csatTools.create({ name: 'Delivery', question: 'How satisfied are you?', folderId: folder.id });
+
+for await (const tool of await woku.tools.list({ folderId: folder.id, types: ['csat', 'nps'] })) {
+  console.log(tool.type, tool.name, tool.headline.value);
+}
+const stats = await woku.tools.stats({ folderId: folder.id }); // native scales, never averaged across types
+const tagged = await woku.tools.list({ trackers: ['TRR:00482'] }); // tracker chips 'name:value', company-wide
+const metrics = await woku.folders.metrics(folder.id, { days: 30 }); // per tool, period vs the previous one; 0 = all history
+await woku.tools.move({ items: [{ type: 'csat', id: toolId }], folderId: null }); // null = root
+const csv: string = await woku.folders.csv(folder.id);
+const pdf: Uint8Array = await woku.folders.pdf(folder.id, { lang: 'en' }); // folder report as PDF bytes
+await woku.folders.delete(folder.id); // content moves up to the parent, nothing is deleted
+```
+
+Journeys in folders: `await woku.journeyFolders.status()` and `await woku.journeyFolders.organize()` (background pass, 409 while running); `journeys.get` returns `folderId` and `momentFolders`, and folders expose `origin`.
+
+`folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv`, `pdf`. `tools`: `list` (cursor iterable; `foldersLimit` pages the folders with `page.hasMoreFolders()` / `page.getMoreFolders()`), `stats`, `move`. `npsTools` / `csatTools` / `cesTools` accept `folderId` on `create` and have `move(id, { folderId })`.
+
+## Flows
+
+```ts
+const flow = await woku.flows.create({
+  name: 'Post-sale',
+  steps: [{ type: 'nps', toolId: npsToolId }, { type: 'csat', toolId: csatToolId }, { type: 'woku', toolId: wokuId }],
+});
+await woku.flows.update(flow._id, { steps: [{ type: 'csat', toolId: csatToolId }] });
+await woku.flows.delete(flow._id); // its tools and responses stay
+```
+
+`flows`: `list`, `get`, `create`, `update`, `delete`. 1 to 20 steps, each tool once; for an `nps` step the company id as `toolId` is the company-level NPS. Needs the SDK release that ships flow writes.
+
 ## Customer journeys and media
 
 Prefer an actual journey when the task coordinates several business moments.

package/skills/woku-sdk-python/SKILL.md

@@ -73,7 +73,7 @@ woku.action_plans.complete("plan_123")
 Namespaces: `trackers`, `nps_tools` / `csat_tools` / `ces_tools`, `nps` / `csat`
 / `ces`, `wokus`, `forms`, `flows`, `action_plans`, `action_plan_groups`,
 `tickets`, `ticket_destinations`, `dispatches`, `reports`, `company`,
-`quarantines`.
+`folders`, `tools`, `journey_folders`.
 
 ## Async
 
@@ -119,6 +119,42 @@ user to the SDK page at https://woku.app/docs/en/development/sdk-python and the
 reference at https://woku.app/docs/en/development/api. There is an equivalent
 JavaScript SDK (`@wokuapp/sdk`) documented at /development/sdk-javascript.
 
+## Folders and tools
+
+One folder tree holds wokus and NPS, CSAT and CES tools. Needs the SDK release that ships `folders` and `tools`; verify the installed version.
+
+```python
+folder = woku.folders.create({"name": "Post-sale"})
+woku.csat_tools.create({"name": "Delivery", "question": "How satisfied are you?", "folderId": folder["id"]})
+
+for tool in woku.tools.list({"folderId": folder["id"], "types": ["csat", "nps"]}):
+    print(tool["type"], tool["name"], tool["headline"]["value"])
+stats = woku.tools.stats({"folderId": folder["id"]})  # native scales, never averaged across types
+tagged = woku.tools.list({"trackers": ["TRR:00482"]})  # tracker chips "name:value", company-wide
+metrics = woku.folders.metrics(folder["id"], {"days": 30})  # per tool, period vs the previous one; 0 = all history
+woku.tools.move({"items": [{"type": "csat", "id": tool_id}], "folderId": None})  # None = root
+csv_text = woku.folders.csv(folder["id"])
+pdf_bytes = woku.folders.pdf(folder["id"], {"lang": "en"})  # folder report as PDF bytes
+woku.folders.delete(folder["id"])  # content moves up to the parent, nothing is deleted
+```
+
+Journeys in folders: `woku.journey_folders.status()` and `woku.journey_folders.organize()` (background pass, `ConflictError` while running); `journeys.get` returns `folderId` and `momentFolders`, and folders expose `origin`.
+
+`folders`: `list`, `get`, `create`, `update`, `move`, `delete`, `report`, `csv`, `pdf`. `tools`: `list` (iterates across cursor pages; `foldersLimit` pages the folders with `has_more_folders()` / `get_more_folders()`), `stats`, `move`. `nps_tools` / `csat_tools` / `ces_tools` accept `folderId` on `create` and have `move(tool_id, {"folderId": ...})`. `AsyncWoku` mirrors all of it.
+
+## Flows
+
+```python
+flow = woku.flows.create({
+    "name": "Post-sale",
+    "steps": [{"type": "nps", "toolId": nps_tool_id}, {"type": "csat", "toolId": csat_tool_id}, {"type": "woku", "toolId": woku_id}],
+})
+woku.flows.update(flow["_id"], {"steps": [{"type": "csat", "toolId": csat_tool_id}]})
+woku.flows.delete(flow["_id"])  # its tools and responses stay
+```
+
+`flows`: `list`, `get`, `create`, `update`, `delete`. 1 to 20 steps, each tool once; for an `nps` step the company id as `toolId` is the company-level NPS. `AsyncWoku` mirrors it. Needs the SDK release that ships flow writes.
+
 ## Customer journeys and media
 
 Prefer an actual journey when the task coordinates several business moments.