@sentientui/mcp 0.27.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +12 -5
- package/README.md +15 -3
- package/dist/{chunk-K2UZ3IVC.js → chunk-Q7RW5Q4X.js} +1024 -426
- package/dist/index.cjs +1024 -426
- package/dist/index.js +1 -1
- package/dist/lib.cjs +1034 -429
- package/dist/lib.js +11 -4
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -7,13 +7,13 @@ SentientUI is a UI personalization platform that assigns visitors to variant com
|
|
|
7
7
|
**Audiences — and what makes each one serve.** When a visitor fits several, the order is declared › retargeting › discovered › campaign › arrival › everyone.
|
|
8
8
|
|
|
9
9
|
- **Everyone** (key `unknown`) — every visitor no other audience claims; usually most of the traffic.
|
|
10
|
-
- **Declared persona** (a bare key such as `developer`) — a role the site already knows, e.g. from sign-in. It serves **only on visits where the site declares it**: the `persona` prop on `<AdaptiveRoot>` / `<AdaptiveProvider>`, `init({ persona })` in `@sentientui/core`, or `window.sentient.persona` on the script tag (a string, or a function read once at start-up). The value must be exactly a key from the dashboard's
|
|
10
|
+
- **Declared persona** (a bare key such as `developer`) — a role the site already knows, e.g. from sign-in. It serves **only on visits where the site declares it**: the `persona` prop on `<AdaptiveRoot>` / `<AdaptiveProvider>`, `init({ persona })` in `@sentientui/core`, or `window.sentient.persona` on the script tag (a string, or a function read once at start-up). The value must be exactly a key from the dashboard's Audiences → Personas list. Adding a persona there only names it: one the site never sends has no visitors, and versions written for it reach nobody. Undeclared visitors are never guessed into a declared persona — for anonymous traffic use campaigns, arrival types or discovered audiences.
|
|
11
11
|
- **Discovered audience** (`d-…`) — found in real behaviour; it serves only after it is promoted, which needs evidence that it wants something different.
|
|
12
12
|
- **Campaign, arrival type, retargeting group** (`c-…`, `a-…`, `r-…`) — visitors who arrived on a named campaign's link, arrived a certain way, or were moved into a retargeting group after a campaign. A version restricted to one of these ("Show to", `manage_tests` `restrict_versions`) is shown only to them. A declared persona cannot be a "Show to" target.
|
|
13
13
|
- **Behaviour groups** (`get_persona_breakdown` `behaviourGroups`) — visitors whose visit patterns look alike ("Behaviour group 2"). Reporting only: they are **not** personas or audiences, nothing is shown to them, and they are never named after an audience. `get_persona_breakdown` `personas` counts the audience each visit was actually **served as** — the same number as the Matrix share in `get_cell_matrix`.
|
|
14
14
|
- **Names never target.** A version's display name, or a key in code `variants`, does not choose who sees it. To give one audience one version every time, pin it (`manage_approvals` `pin`, or the dashboard's "Always show this to …"). Pinned visitors stop teaching the optimizer for that component.
|
|
15
15
|
|
|
16
|
-
**Hybrid components need Migrate first.** An `<Adaptive>` with children **and** `variants` whose id already ran a variants test keeps serving that old test. Generated or dashboard-written versions for it do not serve — even when approved — until it is migrated (dashboard
|
|
16
|
+
**Hybrid components need Migrate first.** An `<Adaptive>` with children **and** `variants` whose id already ran a variants test keeps serving that old test. Generated or dashboard-written versions for it do not serve — even when approved — until it is migrated (dashboard Components → the component → Migrate…, or `manage_tests` `migrate_component`). Check before you generate for one.
|
|
17
17
|
|
|
18
18
|
**Funnels need a source per step.** A funnel is an ordered list of goal ids, and every step must have something that sends it — a page-visit goal, a click or form goal, `useGoal` in the browser, or `trackServerGoal` from the backend. A step nothing sends never fills, and the funnel reads as broken. Join a component to a funnel with `<Adaptive id="…" funnel="<funnelId>">`.
|
|
19
19
|
|
|
@@ -94,6 +94,13 @@ Every write tool changes what real visitors see or what the project accepts —
|
|
|
94
94
|
| `list_guardrail_events` | read | Every variant still paused by a guardrail; `days` narrows to recent pauses |
|
|
95
95
|
| `get_persona_breakdown` | read | Visitors per audience they were served as (30 days, the Matrix share) + behaviour groups (not audiences) |
|
|
96
96
|
| `get_stage_breakdown` | read | E-commerce funnel stages: stage mix (observed vs hinted), arrival channel x stage, stage moves between visits, tested holdout lift per first-visit context and channel (the headline lift's always-valid test, all-time, alpha split over 23 series), versions per context with evidence (windowed, observational) |
|
|
97
|
+
| `get_known_people` | read | Known people: visitors split into new, returning and already past the main goal (one per person), first-time vs repeat main-goal conversions, and the stored known-people list by how each was learnt (reporting only) |
|
|
98
|
+
| `get_main_funnel` | read | The main funnel: people at each step on the way to the main goal — Arrived, the funnel's steps, the main goal — for new and returning visitors, with people who already converted left out, drop-off per step and step health |
|
|
99
|
+
| `get_page_groups` | read | Page groups: the site's pages in named groups, where each sits on the main funnel, and per group the people who viewed it, the components that live there (where they were actually shown), layouts served, plus site-wide components |
|
|
100
|
+
| `get_plan` | read | Sentient's plan: tests running (day and a status word per version), winners waiting for a decision, proposals with their reason and the versions that could be tested, and what was learned |
|
|
101
|
+
| `get_test` | read | One test: its versions, the people counted and how many reached the goal, a status word per version, and how it ended |
|
|
102
|
+
| `get_page_elements` | read | The elements the site check found (buttons, headlines, forms), each with the id manage_generation open_pr needs to send a change to your code |
|
|
103
|
+
| `get_needs_you` | read | Needs you: versions waiting for approval, failed work, winners to keep, changes with your developers (pull request, checks, review) and what just finished |
|
|
97
104
|
| `get_layout_stats` | read | Per-persona layout order + bandit pulls/reward (cumulative state, not windowed) |
|
|
98
105
|
| `get_insights` | read | Ranked measured findings (tier + sample, low-sample flagged; `limit`, default 10) + (Growth) AI narrations, which are unmeasured |
|
|
99
106
|
| `refresh_insights` | write | Async trigger — wait ~15s then call `get_insights`. Starter+ and an editor/admin role |
|
|
@@ -113,11 +120,11 @@ Every write tool changes what real visitors see or what the project accepts —
|
|
|
113
120
|
| `get_site_styles` | read | Captured site styles per role, whether colors were measured, last scan, audit score |
|
|
114
121
|
| `get_region_history` | read | A region's published versions and whether it is still found on the live page |
|
|
115
122
|
| `manage_generation` | write | Generate and edit written versions: queue generation, auto-fill, rewrite depth, regions, campaign versions, pull requests (Generate area) |
|
|
116
|
-
| `manage_approvals` | write | Approve or reject generated versions, require approval, publish, roll back or pin a region version, promote a variant (Approve and publish area) |
|
|
117
|
-
| `manage_tests` | write |
|
|
123
|
+
| `manage_approvals` | write | Approve or reject generated versions, require approval, publish, roll back or pin a region version, promote a variant, keep a test's winner (Approve and publish area) |
|
|
124
|
+
| `manage_tests` | write | Propose, start, stop or skip a test and turn down a winner; archive or restore components and regions, lift guardrail pauses, proof window, observation-only mode, restrict versions by context (Run tests area) |
|
|
118
125
|
| `manage_goals` | write | Edit, publish or archive goals and funnels, set a goal role, confirm or dismiss discovered goals and goal-name warnings (Goals and funnels area) |
|
|
119
126
|
| `manage_campaigns` | write | Campaigns, retargeting and audiences: create, update, promote or roll back, plus stage and search settings (Campaigns and audiences area) |
|
|
120
|
-
| `manage_settings` | write | Project settings: edit the project, origins, webhooks, site styles, report shares, previews, models, test events (Project settings area); accept, dismiss or save a structured insight is always allowed |
|
|
127
|
+
| `manage_settings` | write | Project settings: edit the project, origins, webhooks, site styles, report shares, previews, models, test events, who counts as already converted (gate setting, import of known people) (Project settings area); accept, dismiss or save a structured insight is always allowed |
|
|
121
128
|
| `get_integration_guide` | read | SDK setup guide (static) |
|
|
122
129
|
<!-- mcp-tools:end -->
|
|
123
130
|
|
package/README.md
CHANGED
|
@@ -108,6 +108,13 @@ A demo token is provisioned automatically — 10 calls/month, read-only (write t
|
|
|
108
108
|
| `list_guardrail_events` | read | Every variant currently paused by a guardrail (pass `days` to see only pauses from the last N days) |
|
|
109
109
|
| `get_persona_breakdown` | read | Visitors per audience they were served as (30 days — the Matrix share), plus behaviour groups (visitors who behaved alike — never audiences) |
|
|
110
110
|
| `get_stage_breakdown` | read | E-commerce funnel stages: stage mix, arrival channel x stage, stage moves between visits, tested holdout lift per first-visit context and channel (all-time), and versions per context (windowed, observational) |
|
|
111
|
+
| `get_known_people` | read | Known people: visitors split into new, returning and already past the main goal (one per person), first-time vs repeat main-goal conversions, and the stored known-people list by how each was learnt (reporting only) |
|
|
112
|
+
| `get_main_funnel` | read | The main funnel: people at each step on the way to the main goal — Arrived, the funnel's steps, the main goal — for new and returning visitors, with people who already converted left out, drop-off per step and step health |
|
|
113
|
+
| `get_page_groups` | read | Page groups: the site's pages in named groups, where each sits on the main funnel, and per group the people who viewed it, the components that live there (where they were actually shown), layouts served, plus site-wide components |
|
|
114
|
+
| `get_plan` | read | Sentient's plan: tests running (day and a status word per version), winners waiting for a decision, proposals with their reason and the versions that could be tested, and what was learned |
|
|
115
|
+
| `get_test` | read | One test: its versions, the people counted and how many reached the goal, a status word per version, and how it ended |
|
|
116
|
+
| `get_page_elements` | read | The elements the site check found (buttons, headlines, forms), each with the id manage_generation open_pr needs to send a change to your code |
|
|
117
|
+
| `get_needs_you` | read | Needs you: versions waiting for approval, failed work, winners to keep, changes with your developers (pull request, checks, review) and what just finished |
|
|
111
118
|
| `get_layout_stats` | read | Per-persona section order with bandit pulls and reward (cumulative state) |
|
|
112
119
|
| `get_insights` | read | Ranked measured findings with their sample (low samples flagged), plus AI narrations marked unmeasured |
|
|
113
120
|
| `refresh_insights` | write | Regenerate AI insights — needs Starter or higher and an editor/admin role (a paid model call); advisor recommendations are Growth+ |
|
|
@@ -127,11 +134,11 @@ A demo token is provisioned automatically — 10 calls/month, read-only (write t
|
|
|
127
134
|
| `get_site_styles` | read | Captured site styles per role, whether colors were measured, last scan, audit score |
|
|
128
135
|
| `get_region_history` | read | A region's published versions and whether it is still found on the live page |
|
|
129
136
|
| `manage_generation` | write | Generate and edit written versions: queue generation, auto-fill, rewrite depth, regions, campaign versions, pull requests (Generate area) |
|
|
130
|
-
| `manage_approvals` | write | Approve or reject generated versions, require approval, publish, roll back or pin a region version, promote a variant (Approve and publish area) |
|
|
131
|
-
| `manage_tests` | write |
|
|
137
|
+
| `manage_approvals` | write | Approve or reject generated versions, require approval, publish, roll back or pin a region version, promote a variant, keep a test's winner (Approve and publish area) |
|
|
138
|
+
| `manage_tests` | write | Propose, start, stop or skip a test and turn down a winner; archive or restore components and regions, lift guardrail pauses, proof window, observation-only mode, restrict versions by context (Run tests area) |
|
|
132
139
|
| `manage_goals` | write | Edit, publish or archive goals and funnels, set a goal role, confirm or dismiss discovered goals and goal-name warnings (Goals and funnels area) |
|
|
133
140
|
| `manage_campaigns` | write | Campaigns, retargeting and audiences: create, update, promote or roll back, plus stage and search settings (Campaigns and audiences area) |
|
|
134
|
-
| `manage_settings` | write | Project settings: edit the project, origins, webhooks, site styles, report shares, previews, models, test events (Project settings area); accept, dismiss or save a structured insight is always allowed |
|
|
141
|
+
| `manage_settings` | write | Project settings: edit the project, origins, webhooks, site styles, report shares, previews, models, test events, who counts as already converted (gate setting, import of known people) (Project settings area); accept, dismiss or save a structured insight is always allowed |
|
|
135
142
|
| `get_integration_guide` | read | SDK setup guide (static — same for every project) |
|
|
136
143
|
<!-- mcp-tools:end -->
|
|
137
144
|
|
|
@@ -162,6 +169,9 @@ It applies from when it is turned on: earlier visits can't be separated, because
|
|
|
162
169
|
|
|
163
170
|
## Example prompts
|
|
164
171
|
|
|
172
|
+
The whole loop — setup, goals, versions, pull requests, tests — can run from your agent. The tool-by-tool order is in [Run Sentient from your agent](https://sentient-ui.com/docs#run-from-agent).
|
|
173
|
+
|
|
174
|
+
|
|
165
175
|
- *"What projects do I have?"*
|
|
166
176
|
- *"Show me the CVR trends for the hero banner this week"*
|
|
167
177
|
- *"Are any variants paused by the guardrail right now?"*
|
|
@@ -169,6 +179,8 @@ It applies from when it is turned on: earlier visits can't be separated, because
|
|
|
169
179
|
- *"Refresh insights for project X"*
|
|
170
180
|
- *"Optimize my hero CTA — pull the brief and add a new variant in the code"*
|
|
171
181
|
- *"Create a new variant called 'short-copy' for the pricing CTA"*
|
|
182
|
+
- *"What should we test next? Start it with the shorter version."*
|
|
183
|
+
- *"Is anything waiting for me? How is our pull request doing?"*
|
|
172
184
|
|
|
173
185
|
## Configuration
|
|
174
186
|
|