picked 0.0.107-next.1 → 0.0.107-next.2

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.
@@ -64,9 +64,7 @@ You can also do this task with the [Management API](/reference/management-api/sc
64
64
  | Add a Reference field | [`contentModelUpdate`](/reference/management-api/schema/cms-models#contentmodelupdate) | [`update_content_model`](/reference/tools/mcp#update_content_model) | `tools.update_content_model({ content_model_id, schema })` |
65
65
  | Find the target entry | [`contentEntries`](/reference/management-api/schema/cms-models#contententries) | [`list_content_entries`](/reference/tools/mcp#list_content_entries) | `tools.list_content_entries({ workspace_id, content_model_id })` |
66
66
  | Choose a target on an entry | [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | [`update_content_entry`](/reference/tools/mcp#update_content_entry) | `tools.update_content_entry({ content_entry_id, data })` |
67
- | Delete a target | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | [`guide_delete_content_entry`](/reference/tools/mcp#guide_delete_content_entry) | `tools.guide_delete_content_entry({ content_entry_id })` |
68
-
69
- The MCP server does not delete an entry. `guide_delete_content_entry` gives the link to the entry in the dashboard, where you delete it.
67
+ | Delete a target | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | [`delete_content_entry`](/reference/tools/mcp#delete_content_entry) | `tools.delete_content_entry({ content_entry_id })` |
70
68
 
71
69
  ## Related
72
70
 
@@ -95,9 +95,7 @@ You can also do this task with the [Management API](/reference/management-api/sc
95
95
  | Bind an entry to a page or a step | [`stepUpdate`](/reference/management-api/schema/step#stepupdate) | [`update_step`](/reference/tools/mcp#update_step) | `tools.update_step({ step_id, layout_content_entry_id })` |
96
96
  | Edit the entry data | [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | [`update_content_entry`](/reference/tools/mcp#update_content_entry) | `tools.update_content_entry({ content_entry_id, data })` |
97
97
  | Find the entries that are not valid | [`workspaceContentEntryValidation`](/reference/management-api/schema/cms-models#workspacecontententryvalidation) | [`validate_workspace_content_entries`](/reference/tools/mcp#validate_workspace_content_entries) | `tools.validate_workspace_content_entries({ workspace_id })` |
98
- | Delete an entry | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | [`guide_delete_content_entry`](/reference/tools/mcp#guide_delete_content_entry) | `tools.guide_delete_content_entry({ content_entry_id })` |
99
-
100
- The MCP server does not delete an entry. `guide_delete_content_entry` gives the link to the entry in the dashboard, where you delete it.
98
+ | Delete an entry | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | [`delete_content_entry`](/reference/tools/mcp#delete_content_entry) | `tools.delete_content_entry({ content_entry_id })` |
101
99
 
102
100
  ## Related
103
101
 
@@ -21,7 +21,7 @@ so you can share the link.
21
21
  | The visitor | `userId` | `userId:sess_7x2k9q3m1n4a` |
22
22
  | The visit that captured the lead | `session.field` | `session.utm_source:google` |
23
23
 
24
- A path of two parts is a label, unless it starts with `session.`: that path reads the visit.
24
+ A path of two parts is a label, unless it starts with `session.`: that path reads the visit. A `session.` path needs `ORGANIZATION_SESSIONS_READ`.
25
25
  A label namespace and a label key cannot contain a full stop. A path of one part is the key
26
26
  of a field, unless the name is `createdAt` or `userId`.
27
27
 
@@ -102,6 +102,7 @@ On a narrow screen, the page shows the cards on three tabs.
102
102
  | Surface | Scopes |
103
103
  | ---------------------- | ------------------------------------------------------------------------------------------------------------ |
104
104
  | Leads, Lead | `ORGANIZATION_LEADS_READ` |
105
+ | **Session** columns, **Session** card, report tabs | `ORGANIZATION_SESSIONS_READ` |
105
106
  | Saved views | `ORGANIZATION_PROJECTS_READ` to see them, and `ORGANIZATION_PROJECTS_UPDATE` to save, change and delete them |
106
107
  | The labels of a lead | Refer to [Owners](/reference/dashboard/labels#owners). |
107
108
  | **Workflow runs** card | Refer to [Access](/reference/dashboard/workflow-runs#access). |
@@ -68,7 +68,7 @@ These are the scopes:
68
68
  | `organization_projects/delete` | `ORGANIZATION_PROJECTS_DELETE` | Delete a project |
69
69
 
70
70
  A scope on content inside a project also gives `organization_projects/read`. The
71
- workspace, integration, lead, action run, and report scopes all give it. They do
71
+ workspace, integration, lead, session, action run, and report scopes all give it. They do
72
72
  not give `organization_projects/create`, `organization_projects/update`, or
73
73
  `organization_projects/delete`.
74
74
 
@@ -98,6 +98,18 @@ not give `organization_projects/create`, `organization_projects/update`, or
98
98
  | `organization_reports/update` | `ORGANIZATION_REPORTS_UPDATE` | Update the settings of a report |
99
99
  | `organization_reports/delete` | `ORGANIZATION_REPORTS_DELETE` | Delete a report |
100
100
 
101
+ ### Organization sessions
102
+
103
+ | Scope | GraphQL Enum | Description |
104
+ | ---------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------- |
105
+ | `organization_sessions/read` | `ORGANIZATION_SESSIONS_READ` | Read the analytics sessions of a project, and the Leads and Sessions reports on the project |
106
+
107
+ A lead scope does not give `organization_sessions/read`. A client manager can hold it at
108
+ the account level, which gives it in every organization.
109
+
110
+ The owner and member roles do not include a lead scope or `organization_sessions/read`. You
111
+ must grant them to each person who must see leads or sessions.
112
+
101
113
  ## Roles
102
114
 
103
115
  Each member of an organization holds one of two roles:
@@ -23,7 +23,7 @@ type AnalyticsSession {
23
23
  """
24
24
  What the visit adds up to: when it started and ended, how the visitor arrived, and their device
25
25
  and location.
26
- Scope: `ORGANIZATION_LEADS_READ`.
26
+ Scope: `ORGANIZATION_SESSIONS_READ`.
27
27
  """
28
28
  summary: AnalyticsSessionSummary! @auth
29
29
  """
@@ -31,7 +31,7 @@ type AnalyticsSession {
31
31
  event, or on its latest event when it captured no lead: `last` ends the page there, `first`
32
32
  starts it there, and with neither the page is the 20 events ending there. A page holds at most
33
33
  100 events. The newest events can take a few minutes to arrive.
34
- Scope: `ORGANIZATION_LEADS_READ`.
34
+ Scope: `ORGANIZATION_SESSIONS_READ`.
35
35
  """
36
36
  events(first: Int, after: String, last: Int, before: String): AnalyticsEventConnection! @auth
37
37
  """
@@ -42,7 +42,7 @@ type AnalyticsSession {
42
42
  lead: Lead @auth
43
43
  """
44
44
  The Session reports on the visit: the overview, the journey and the event log, in that order.
45
- Scope: `ORGANIZATION_LEADS_READ`.
45
+ Scope: `ORGANIZATION_SESSIONS_READ`.
46
46
  """
47
47
  reports: [AnalyticsSessionReport!]! @auth
48
48
  }
@@ -180,6 +180,10 @@ enum Scope {
180
180
  ORGANIZATION_LEADS_UPDATE
181
181
  """Delete leads and their labels."""
182
182
  ORGANIZATION_LEADS_DELETE
183
+ """
184
+ View a project's analytics sessions, and the Leads and Sessions reports.
185
+ """
186
+ ORGANIZATION_SESSIONS_READ
183
187
  """Read the action run a workflow was started by."""
184
188
  ORGANIZATION_ACTION_RUNS_READ
185
189
  """Record a response against an action run."""
@@ -80,7 +80,7 @@ type Lead {
80
80
  """
81
81
  The visit in which the visitor gave the lead. Null when the lead has no capture event, or when
82
82
  analytics holds no event for it yet or the capture happened outside production.
83
- Scope: `ORGANIZATION_LEADS_READ`.
83
+ Scope: `ORGANIZATION_SESSIONS_READ`.
84
84
  """
85
85
  session: AnalyticsSession @auth
86
86
  """When the lead was captured."""
@@ -248,7 +248,7 @@ type Project {
248
248
  The Leads reports on the project, in order: how leads are acquired, the journeys behind them,
249
249
  and how visits convert to leads. Each is a signed embed URL locked to the project, with an
250
250
  editable date range.
251
- Scope: `ORGANIZATION_LEADS_READ` or `ORGANIZATION_REPORTS_READ`.
251
+ Scope: `ORGANIZATION_SESSIONS_READ`.
252
252
  """
253
253
  leadReports: [LeadReport!]! @auth
254
254
  """
@@ -272,13 +272,13 @@ type Project {
272
272
  The Sessions reports on the project, in order: how its sessions arrive, the journeys they take,
273
273
  and which of them convert. Each is a signed embed URL locked to the project, with an editable
274
274
  date range.
275
- Scope: `ORGANIZATION_LEADS_READ` or `ORGANIZATION_REPORTS_READ`.
275
+ Scope: `ORGANIZATION_SESSIONS_READ`.
276
276
  """
277
277
  analyticsSessionsReports: [AnalyticsSessionsReport!]! @auth
278
278
  """
279
279
  One visitor session on the project's sites, across all of its events, anchored on its latest
280
280
  lead capture, else on its latest timeline event. Null when no event of it is recorded.
281
- Scope: `ORGANIZATION_LEADS_READ`.
281
+ Scope: `ORGANIZATION_SESSIONS_READ`.
282
282
  """
283
283
  analyticsSession(
284
284
  """The ID of the session."""
@@ -289,7 +289,7 @@ type Project {
289
289
  inside `window`, and its `summary` adds up those events alone. `first` and `after` read older
290
290
  sessions, `last` and `before` newer ones, at most 100 a page. The newest events can take a few
291
291
  minutes to arrive.
292
- Scope: `ORGANIZATION_LEADS_READ`.
292
+ Scope: `ORGANIZATION_SESSIONS_READ`.
293
293
  """
294
294
  analyticsSessions(
295
295
  first: Int
@@ -322,7 +322,7 @@ type Project {
322
322
  """
323
323
  Suggests up to four session searches for what was typed into a sessions search box, each with
324
324
  how many sessions it keeps within the window. Requires the `lead-search-suggestions` feature flag.
325
- Scope: `ORGANIZATION_LEADS_READ`.
325
+ Scope: `ORGANIZATION_SESSIONS_READ`.
326
326
  """
327
327
  analyticsSessionSearchSuggestions(
328
328
  """What was typed, at most 200 characters."""
@@ -31,6 +31,11 @@ Reads the live version of the project, and the draft of a workspace with its exp
31
31
 
32
32
  Reads the brief that the project owner wrote about the project, its goals and its entry points.
33
33
 
34
+ #### `get_project_settings`
35
+
36
+ Gives the name, the time zone, and the stored settings of a project, with the link to the
37
+ project settings page. You change the settings in the dashboard.
38
+
34
39
  #### `guide_create_organisation`
35
40
 
36
41
  Gives the link to create an organization in the dashboard. The MCP server cannot create an organization.
@@ -39,6 +44,42 @@ Gives the link to create an organization in the dashboard. The MCP server cannot
39
44
 
40
45
  Gives the link to create a project in the dashboard. The MCP server cannot create a project.
41
46
 
47
+ ### Workspaces
48
+
49
+ #### `create_workspace`
50
+
51
+ Creates an empty draft workspace in a project.
52
+
53
+ #### `update_workspace`
54
+
55
+ Changes the name of a workspace.
56
+
57
+ #### `duplicate_workspace`
58
+
59
+ Copies a workspace into a new draft workspace in the same project. Use the copy to make
60
+ a large change without a risk to the workspace that you edit.
61
+
62
+ #### `archive_workspace`
63
+
64
+ Removes a workspace from the default list of workspaces. The contents do not change. You
65
+ cannot archive the live workspace.
66
+
67
+ #### `unarchive_workspace`
68
+
69
+ Puts an archived workspace back in the list as a draft.
70
+
71
+ #### `export_workspace`
72
+
73
+ Gives a workspace as a bundle that you can import. The bundle can be large.
74
+
75
+ #### `import_workspace`
76
+
77
+ Creates a draft workspace from a bundle, in the same project or in a different project.
78
+ If the content uses assets, upload the assets to the project first and give `asset_map`.
79
+ If the tool refuses the bundle, it creates nothing and gives all the errors.
80
+
81
+ You cannot delete or publish a workspace with these tools. Do these in the dashboard.
82
+
42
83
  ### Documentation
43
84
 
44
85
  #### `get_schema_info`
@@ -71,9 +112,9 @@ Creates an experience.
71
112
 
72
113
  Creates, updates, or deletes steps, conditions, actions, fields, nodes, and edges as one operation.
73
114
 
74
- #### `guide_delete_experience`
115
+ #### `delete_experience`
75
116
 
76
- Gives the link to the experience in the dashboard, where you delete it.
117
+ Deletes an experience from the workspace draft. Live visitors see the change after you publish the workspace.
77
118
 
78
119
  ### Steps, fields, conditions, and actions
79
120
 
@@ -89,9 +130,9 @@ Reads a step, with its fields.
89
130
 
90
131
  Renames a step, or binds it to the content entry that it renders.
91
132
 
92
- #### `guide_delete_step`
133
+ #### `delete_step`
93
134
 
94
- Gives the link to the step in the dashboard, where you delete it.
135
+ Deletes a step from the workspace draft. You cannot delete a step that a flow uses. Live visitors see the change after you publish the workspace.
95
136
 
96
137
  #### `list_fields`
97
138
 
@@ -101,9 +142,14 @@ Lists the fields in a workspace. A step ID filters the list.
101
142
 
102
143
  Reads a field, with its options and the steps that use it.
103
144
 
104
- #### `guide_delete_field`
145
+ #### `create_field`
105
146
 
106
- Gives the link to the field in the dashboard, where you delete it.
147
+ Creates a field in a workspace. To show the field to visitors, add it to a step with
148
+ `update_experience_flow`.
149
+
150
+ #### `delete_field`
151
+
152
+ Deletes a field from the workspace draft. You cannot delete a field that a step uses. Live visitors see the change after you publish the workspace.
107
153
 
108
154
  #### `list_conditions`
109
155
 
@@ -121,6 +167,11 @@ Lists the actions in a workspace.
121
167
 
122
168
  Reads an action.
123
169
 
170
+ #### `create_action`
171
+
172
+ Creates an action in a workspace, with the fields that it gets. The action runs when a
173
+ flow gets to it: add it to a flow with `update_experience_flow`.
174
+
124
175
  ### Feature flags
125
176
 
126
177
  #### `list_features`
@@ -139,6 +190,10 @@ Creates a feature flag.
139
190
 
140
191
  Updates the name, description, state, or weight of a feature flag.
141
192
 
193
+ #### `delete_feature`
194
+
195
+ Deletes a feature flag from the workspace draft. Live visitors see the change after you publish the workspace.
196
+
142
197
  ### Content
143
198
 
144
199
  #### `list_content_models`
@@ -157,6 +212,11 @@ Creates a content model.
157
212
 
158
213
  Renames a content model, or changes its schema. A schema change migrates the entries of the model.
159
214
 
215
+ #### `delete_content_model`
216
+
217
+ Deletes a content model from the workspace draft. You cannot delete a content model
218
+ while a content entry uses it. Live visitors see the change after you publish the workspace.
219
+
160
220
  #### `list_content_blocks`
161
221
 
162
222
  Lists the content blocks in a workspace.
@@ -173,6 +233,10 @@ Creates a content block.
173
233
 
174
234
  Renames a content block, or changes its schema. The entries do not change.
175
235
 
236
+ #### `delete_content_block`
237
+
238
+ Deletes a content block from the workspace draft. Live visitors see the change after you publish the workspace.
239
+
176
240
  #### `list_content_entries`
177
241
 
178
242
  Lists the content entries in a workspace. Give the ID of a content model to show only its entries.
@@ -189,9 +253,10 @@ Creates a content entry of a content model.
189
253
 
190
254
  Changes the data of a content entry.
191
255
 
192
- #### `guide_delete_content_entry`
256
+ #### `delete_content_entry`
193
257
 
194
- Gives the link to the content entry in the dashboard, where you delete it.
258
+ Deletes a content entry from the workspace draft. You cannot delete an entry that a
259
+ step or a different entry uses. Live visitors see the change after you publish the workspace.
195
260
 
196
261
  #### `validate_workspace_content_entries`
197
262
 
@@ -215,6 +280,11 @@ Gives a URL to upload the file of an asset to.
215
280
 
216
281
  Records the asset after you upload its file.
217
282
 
283
+ #### `delete_asset`
284
+
285
+ Deletes an asset from the project, with its files. You cannot delete an asset that a
286
+ published version uses. The deletion occurs immediately.
287
+
218
288
  ### Design systems
219
289
 
220
290
  #### `list_design_systems`
@@ -233,6 +303,37 @@ Creates a design system from a Markdown asset.
233
303
 
234
304
  Renames a design system, or replaces its Markdown asset.
235
305
 
306
+ #### `delete_design_system`
307
+
308
+ Deletes a design system from the project. The deletion occurs immediately.
309
+
310
+ ### Preview environments
311
+
312
+ A preview environment is a site with the Picked SDK installed, for example your
313
+ production site or your test site. A preview opens on it.
314
+
315
+ #### `list_preview_environments`
316
+
317
+ Lists the preview environments of a project, with the URL of each site. Give a URL to
318
+ `get_preview_url` to see your unpublished work on that site.
319
+
320
+ #### `create_preview_environment`
321
+
322
+ Adds a preview environment to a project.
323
+
324
+ #### `update_preview_environment`
325
+
326
+ Changes the name or the URL of a preview environment. You cannot delete a preview
327
+ environment with the MCP server. Delete it in the dashboard.
328
+
329
+ ### Integrations
330
+
331
+ #### `list_external_apis`
332
+
333
+ Lists the external APIs of a project. A workflow `http` node can call only a URL on one
334
+ of these APIs. The list shows the name, the origin, and the type of the credential of each API.
335
+ It does not show a credential value. You register an API in the dashboard.
336
+
236
337
  ### Workflows
237
338
 
238
339
  A workflow runs a graph of nodes when its trigger occurs. The trigger is a domain
@@ -262,9 +363,10 @@ Renames a workflow, and sets its visit cap.
262
363
 
263
364
  Creates, updates, or deletes nodes and edges as one operation.
264
365
 
265
- #### `guide_delete_workflow`
366
+ #### `delete_workflow`
266
367
 
267
- Gives the link to the workflow in the dashboard, where you delete it.
368
+ Deletes a workflow from the workspace draft. The published workflow continues to run
369
+ until you publish the workspace.
268
370
 
269
371
  #### `list_workflow_runs`
270
372
 
@@ -311,6 +413,15 @@ Gives the number of leads that match a search, and a link to the leads list in t
311
413
  dashboard. It does not give the leads. Use `list_lead_fields` first to get the fields
312
414
  that you can search by.
313
415
 
416
+ ### Analytics reports
417
+
418
+ #### `list_analytics_reports`
419
+
420
+ Lists the Metabase reports of a project: the Leads and Sessions dashboards, and the reports
421
+ that you added to the project. Each report has its Metabase ID and the parameters that
422
+ limit it to the project, for example `project_id`. To read the data, use the Metabase MCP
423
+ server with the ID, and filter by all these parameters.
424
+
314
425
  ### Publish
315
426
 
316
427
  #### `get_preview_url`
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "picked",
3
3
  "description": "The Picked SDK front door: the client, the picked.config helpers, and the picked CLI in one install",
4
- "version": "0.0.107-next.1",
4
+ "version": "0.0.107-next.2",
5
5
  "bin": {
6
6
  "picked": "dist/esm/bin.js"
7
7
  },
8
8
  "dependencies": {
9
- "@picked/cli": "0.0.107-next.1",
10
- "@picked/config": "0.0.107-next.1"
9
+ "@picked/cli": "0.0.107-next.2",
10
+ "@picked/config": "0.0.107-next.2"
11
11
  },
12
12
  "devDependencies": {
13
13
  "@picked/client": "workspace:*",
@@ -64,7 +64,7 @@
64
64
  "main": "./dist/cjs/index.js",
65
65
  "module": "./dist/esm/index.js",
66
66
  "peerDependencies": {
67
- "@picked/client": "0.0.107-next.1"
67
+ "@picked/client": "0.0.107-next.2"
68
68
  },
69
69
  "private": false,
70
70
  "publishConfig": {