salesforce-metadata-mcp 2.5.2 → 2.5.4

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.
Files changed (64) hide show
  1. package/AGENTFORCE.md +65 -287
  2. package/CHANGELOG.md +68 -0
  3. package/README.md +19 -250
  4. package/TOOLS.md +103 -2034
  5. package/dist/index.d.ts +1 -0
  6. package/dist/index.js +4 -4
  7. package/dist/index.js.map +1 -1
  8. package/dist/schemas/index.d.ts +3833 -6
  9. package/dist/schemas/index.d.ts.map +1 -1
  10. package/dist/schemas/index.js +286 -241
  11. package/dist/schemas/index.js.map +1 -1
  12. package/dist/services/deployment.d.ts +4 -0
  13. package/dist/services/deployment.d.ts.map +1 -1
  14. package/dist/services/deployment.js +2 -124
  15. package/dist/services/deployment.js.map +1 -1
  16. package/dist/services/salesforce.d.ts +243 -1
  17. package/dist/services/salesforce.d.ts.map +1 -1
  18. package/dist/services/salesforce.js +1511 -857
  19. package/dist/services/salesforce.js.map +1 -1
  20. package/dist/tools/admin.d.ts +3 -0
  21. package/dist/tools/admin.d.ts.map +1 -0
  22. package/dist/tools/admin.js +3 -15
  23. package/dist/tools/admin.js.map +1 -0
  24. package/dist/tools/agentforce.js +43 -303
  25. package/dist/tools/apex.js +3 -154
  26. package/dist/tools/audit.d.ts +3 -0
  27. package/dist/tools/audit.d.ts.map +1 -0
  28. package/dist/tools/audit.js +2 -8
  29. package/dist/tools/audit.js.map +1 -0
  30. package/dist/tools/automation.js +2 -90
  31. package/dist/tools/data.d.ts +3 -0
  32. package/dist/tools/data.d.ts.map +1 -0
  33. package/dist/tools/data.js +1 -4
  34. package/dist/tools/data.js.map +1 -0
  35. package/dist/tools/deployment.js +5 -148
  36. package/dist/tools/deployment.js.map +1 -1
  37. package/dist/tools/einstein.d.ts +3 -0
  38. package/dist/tools/einstein.d.ts.map +1 -0
  39. package/dist/tools/einstein.js +2 -7
  40. package/dist/tools/einstein.js.map +1 -0
  41. package/dist/tools/experience.js +2 -105
  42. package/dist/tools/index.d.ts.map +1 -1
  43. package/dist/tools/index.js.map +1 -1
  44. package/dist/tools/integrations.js +2 -113
  45. package/dist/tools/monitoring.d.ts +3 -0
  46. package/dist/tools/monitoring.d.ts.map +1 -0
  47. package/dist/tools/monitoring.js +4 -12
  48. package/dist/tools/monitoring.js.map +1 -0
  49. package/dist/tools/objects.js +2 -129
  50. package/dist/tools/omnichannel.d.ts +3 -0
  51. package/dist/tools/omnichannel.d.ts.map +1 -0
  52. package/dist/tools/omnichannel.js +3 -28
  53. package/dist/tools/omnichannel.js.map +1 -0
  54. package/dist/tools/omnistudio.d.ts +3 -0
  55. package/dist/tools/omnistudio.d.ts.map +1 -0
  56. package/dist/tools/omnistudio.js +3 -37
  57. package/dist/tools/omnistudio.js.map +1 -0
  58. package/dist/tools/reports.d.ts +3 -0
  59. package/dist/tools/reports.d.ts.map +1 -0
  60. package/dist/tools/reports.js +3 -3
  61. package/dist/tools/reports.js.map +1 -0
  62. package/dist/tools/security.js +2 -82
  63. package/dist/tools/ui.js +2 -102
  64. package/package.json +3 -3
package/TOOLS.md CHANGED
@@ -1,2124 +1,193 @@
1
1
  # Tools Reference
2
2
 
3
- Complete documentation for all 200+ tools in `salesforce-metadata-mcp` v2.5.2.
3
+ Complete documentation for all 60+ tools in `salesforce-metadata-mcp`.
4
4
 
5
5
  ---
6
6
 
7
- ## Table of Contents
8
-
9
- | Category | Tools |
10
- |----------|-------|
11
- | [Objects & Schema](#objects--schema) | 26 tools |
12
- | [Automation & Flows](#automation--flows) | 15 tools |
13
- | [Apex & Code](#apex--code) | 15 tools |
14
- | [LWC & Components](#lwc--components) | 2 tools |
15
- | [UI & App Builder](#ui--app-builder) | 18 tools |
16
- | [Security & Permissions](#security--permissions) | 12 tools |
17
- | [Data Management](#data-management) | 14 tools |
18
- | [Deployment & Environments](#deployment--environments) | 13 tools |
19
- | [Integrations & Connectivity](#integrations--connectivity) | 12 tools |
20
- | [Experience Cloud](#experience-cloud) | 10 tools |
21
- | [Agentforce](#agentforce) | 16 tools |
22
- | [OmniStudio](#omnistudio) | 19 tools |
23
- | [OmniChannel & Service](#omnichannel--service) | 14 tools |
24
- | [Audit Trail & Monitoring](#audit-trail--monitoring) | 8 tools |
25
- | [Admin & Org Management](#admin--org-management) | 6 tools |
26
- | [Einstein & AI](#einstein--ai) | 3 tools |
27
- | [Reports & Dashboards](#reports--dashboards) | 4 tools |
28
- | [MCP Server Generation](#mcp-server-generation) | 1 tool |
29
-
30
- ---
31
-
32
- ## Objects & Schema
7
+ ## Objects & Fields
33
8
 
34
9
  ### sf_create_custom_object
35
- Creates a Salesforce Custom Object via the Metadata API.
10
+ Creates a new Salesforce Custom Object using the Metadata API.
36
11
 
12
+ **Parameters:**
37
13
  | Parameter | Type | Default | Description |
38
14
  |-----------|------|---------|-------------|
39
- | `fullName` | string | required | API name ending in `__c` (e.g. `Invoice__c`) |
15
+ | `fullName` | string | required | API name ending in `__c`, e.g. `Invoice__c` |
40
16
  | `label` | string | required | Singular display label |
41
17
  | `pluralLabel` | string | required | Plural display label |
42
- | `nameFieldType` | `Text\|AutoNumber` | `Text` | Name field type |
43
- | `autoNumberFormat` | string | — | e.g. `INV-{0000}` |
44
- | `sharingModel` | string | `ReadWrite` | OWD: `ReadWrite`, `Read`, `Private`, `ControlledByParent` |
45
- | `deploymentStatus` | string | `Deployed` | `Deployed` or `InDevelopment` |
18
+ | `description` | string | — | Optional description |
19
+ | `nameFieldLabel` | string | `"Name"` | Label for the standard Name field |
20
+ | `nameFieldType` | `Text\|AutoNumber` | `"Text"` | Name field type |
21
+ | `autoNumberFormat` | string | — | Format for AutoNumber, e.g. `INV-{0000}` |
22
+ | `deploymentStatus` | `Deployed\|InDevelopment` | `"Deployed"` | Deployment status |
23
+ | `sharingModel` | `ReadWrite\|Read\|Private\|...` | `"ReadWrite"` | OWD sharing model |
46
24
  | `enableActivities` | boolean | `true` | Allow Tasks/Events |
47
- | `enableHistory` | boolean | `false` | Field history tracking |
25
+ | `enableHistory` | boolean | `false` | Enable field history tracking |
48
26
  | `enableReports` | boolean | `true` | Available in Reports |
49
- | `enableSearch` | boolean | `true` | Global search |
27
+ | `enableSearch` | boolean | `true` | Searchable |
50
28
 
51
- **Examples:** "Create a custom object called Project__c", "Create a Job Application object with AutoNumber name JOB-{0000}"
29
+ **Example prompts:**
30
+ - "Create a custom object called Project__c with plural label Projects"
31
+ - "Create a Job Application object with AutoNumber name format JOB-{0000}"
32
+ - "Create a custom object called Feedback__c with Private sharing and no activities"
52
33
 
53
34
  ---
54
35
 
55
36
  ### sf_create_custom_field
56
- Creates a custom field on an existing object.
37
+ Creates a new field on an existing object.
57
38
 
39
+ **Parameters:**
58
40
  | Parameter | Type | Description |
59
41
  |-----------|------|-------------|
60
- | `objectName` | string | Parent object (e.g. `Account`, `Invoice__c`) |
61
- | `fieldName` | string | API name ending in `__c` |
42
+ | `objectName` | string | Parent object API name |
43
+ | `fieldName` | string | Field API name ending in `__c` |
62
44
  | `label` | string | Display label |
63
- | `type` | string | `Text`, `Number`, `Currency`, `Picklist`, `Date`, `DateTime`, `Checkbox`, `Lookup`, `MasterDetail`, `LongTextArea`, `Email`, `Phone`, `URL`, `Percent` |
64
- | `required` | boolean | Required field |
65
- | `length` | number | Text length (1-255) |
66
- | `precision` / `scale` | number | For Number/Currency |
67
- | `picklistValues` | object | `{values:[{fullName,default,label}], restricted, sorted}` |
45
+ | `type` | FieldType | Text, Number, Picklist, Lookup, etc. |
46
+ | `required` | boolean | Is field required |
47
+ | `unique` | boolean | Must values be unique |
48
+ | `length` | number | For Text fields (1-255) |
49
+ | `precision` / `scale` | number | For Number/Currency fields |
50
+ | `picklistValues` | object | Required for Picklist/MultiselectPicklist |
68
51
  | `referenceTo` | string | For Lookup/MasterDetail |
52
+ | `deleteConstraint` | string | For Lookup: Cascade/Restrict/SetNull |
69
53
 
70
- **Examples:** "Add a Status picklist to Invoice__c with values Draft, Pending, Approved", "Add an Amount currency field with 2 decimal places"
71
-
72
- ---
73
-
74
- ### sf_add_picklist_values
75
- Adds new values to an existing Picklist or MultiselectPicklist field without removing existing values.
76
-
77
- | Parameter | Type | Description |
78
- |-----------|------|-------------|
79
- | `objectFieldFullName` | string | `ObjectName.FieldName__c` |
80
- | `values` | array | `[{fullName, label, default}]` |
54
+ **Example prompts:**
55
+ - "Add a Status__c picklist field to Invoice__c with values: Draft, Pending, Approved, Rejected"
56
+ - "Add an Amount__c currency field to Opportunity with 2 decimal places"
57
+ - "Add a lookup from Project__c to Account"
81
58
 
82
59
  ---
83
60
 
84
61
  ### sf_create_custom_metadata_type
85
- Creates a Custom Metadata Type (`__mdt`) for storing deployable configuration data.
62
+ Creates a Custom Metadata Type (__mdt) for storing configuration.
86
63
 
64
+ **Parameters:**
87
65
  | Parameter | Type | Description |
88
66
  |-----------|------|-------------|
89
67
  | `fullName` | string | API name ending in `__mdt` |
90
- | `label` / `pluralLabel` | string | Display labels |
68
+ | `label` | string | Singular label |
69
+ | `pluralLabel` | string | Plural label |
70
+ | `description` | string | Optional description |
91
71
  | `fields` | array | Custom fields to add |
92
72
 
93
- ---
94
-
95
- ### sf_create_custom_metadata_record
96
- Creates a record in an existing Custom Metadata Type.
97
-
98
- | Parameter | Type | Description |
99
- |-----------|------|-------------|
100
- | `typeName` | string | e.g. `Config__mdt` |
101
- | `recordName` | string | Record API name |
102
- | `label` | string | Record label |
103
- | `values` | array | `[{field, value}]` |
104
-
105
- ---
106
-
107
- ### sf_create_custom_label
108
- Creates or updates a Custom Label (translatable text string accessible in Apex, LWC, Flows).
109
-
110
- | Parameter | Type | Description |
111
- |-----------|------|-------------|
112
- | `fullName` | string | Label API name |
113
- | `value` | string | Label text |
114
- | `language` | string | ISO code, e.g. `en_US` |
115
- | `categories` | string | Optional category tag |
116
-
117
- ---
118
-
119
- ### sf_create_custom_setting
120
- Creates a Custom Setting object (`__c`) of Hierarchy or List type.
121
-
122
- | Parameter | Type | Description |
123
- |-----------|------|-------------|
124
- | `fullName` | string | API name ending in `__c` |
125
- | `settingType` | `Hierarchy\|List` | Setting type |
126
- | `visibility` | `Public\|Protected` | Package visibility |
127
- | `fields` | array | Fields to add |
128
-
129
- ---
130
-
131
- ### sf_create_global_value_set
132
- Creates a Global Value Set (shared picklist) reusable across multiple fields.
133
-
134
- | Parameter | Type | Description |
135
- |-----------|------|-------------|
136
- | `fullName` | string | API name |
137
- | `masterLabel` | string | Display label |
138
- | `sorted` | boolean | Sort values alphabetically |
139
- | `values` | array | `[{fullName, label, default}]` |
140
-
141
- ---
142
-
143
- ### sf_create_record_type
144
- Creates a Record Type on an object for different page layouts and picklist values.
145
-
146
- | Parameter | Type | Description |
147
- |-----------|------|-------------|
148
- | `objectName` | string | Parent object |
149
- | `fullName` | string | Record type API name |
150
- | `label` | string | Display label |
151
- | `businessProcess` | string | Business process name (Opportunity, Lead, Case) |
152
- | `picklistValues` | array | `[{picklist, values:[]}]` |
153
-
154
- ---
155
-
156
- ### sf_create_business_process
157
- Creates a Business Process defining which picklist values are available for a Record Type.
158
-
159
- | Parameter | Type | Description |
160
- |-----------|------|-------------|
161
- | `objectName` | string | `Opportunity`, `Lead`, or `Case` |
162
- | `processName` | string | Process API name |
163
- | `values` | array | `[{fullName, default}]` |
164
-
165
- ---
166
-
167
- ### sf_create_page_layout
168
- Creates a Page Layout defining fields, sections, and related lists on record pages.
169
-
170
- | Parameter | Type | Description |
171
- |-----------|------|-------------|
172
- | `objectName` | string | Parent object |
173
- | `layoutName` | string | Layout API name |
174
- | `sections` | array | `[{label, columns, fields:[]}]` |
175
- | `relatedLists` | array | Related list names to include |
176
-
177
- ---
178
-
179
- ### sf_create_sharing_rule
180
- Creates a Sharing Rule to extend record access beyond OWD.
181
-
182
- | Parameter | Type | Description |
183
- |-----------|------|-------------|
184
- | `objectName` | string | Parent object |
185
- | `ruleType` | `criteria\|owner` | Criteria-based or ownership-based |
186
- | `accessLevel` | string | `Read` or `Edit` |
187
- | `sharedTo` | string | Role, group, or territory to share to |
188
- | `criteriaItems` | array | For criteria-based rules |
189
-
190
- ---
191
-
192
- ### sf_create_field_dependency
193
- Creates a controlling/dependent picklist field dependency.
194
-
195
- | Parameter | Type | Description |
196
- |-----------|------|-------------|
197
- | `objectName` | string | Parent object |
198
- | `controllingField` | string | Controlling field API name |
199
- | `dependentField` | string | Dependent field API name |
200
- | `valueSettings` | array | `[{controllingFieldValue, dependentValues:[]}]` |
201
-
202
- ---
203
-
204
- ### sf_update_custom_object
205
- Updates properties of an existing custom object (label, plural label, description, feature toggles).
206
-
207
- ---
208
-
209
- ### sf_update_custom_field
210
- Updates an existing custom field's label, description, help text, required, or default value.
211
-
212
- | Parameter | Type | Description |
213
- |-----------|------|-------------|
214
- | `objectApiName` | string | Parent object |
215
- | `fieldApiName` | string | Field API name |
216
- | `label` / `description` / `helpText` | string | Updated values |
217
-
218
- ---
219
-
220
- ### sf_create_relationship_field
221
- Creates a Lookup or Master-Detail relationship field.
222
-
223
- | Parameter | Type | Description |
224
- |-----------|------|-------------|
225
- | `objectName` | string | Child object |
226
- | `fieldName` | string | Field API name |
227
- | `relationType` | `Lookup\|MasterDetail` | Relationship type |
228
- | `referenceTo` | string | Parent object |
229
- | `deleteConstraint` | string | `Cascade`, `Restrict`, or `SetNull` (Lookup only) |
230
-
231
- ---
232
-
233
- ### sf_create_formula_field
234
- Creates a formula field with a calculated value.
235
-
236
- | Parameter | Type | Description |
237
- |-----------|------|-------------|
238
- | `objectName` | string | Parent object |
239
- | `fieldName` | string | Field API name |
240
- | `returnType` | string | `Text`, `Number`, `Currency`, `Date`, `DateTime`, `Checkbox`, `Percent` |
241
- | `formula` | string | Formula expression |
242
-
243
- ---
244
-
245
- ### sf_delete_custom_object ⚠️ Destructive
246
- Permanently deletes a custom object and all its records via Metadata API `deleteMetadata`.
247
-
248
- | Parameter | Type | Description |
249
- |-----------|------|-------------|
250
- | `objectApiName` | string | Full API name ending in `__c` |
251
-
252
- > **Warning:** Irreversible. All records, fields, and configurations for the object are deleted.
253
-
254
- ---
255
-
256
- ### sf_delete_custom_field ⚠️ Destructive
257
- Permanently deletes a custom field from an object.
258
-
259
- | Parameter | Type | Description |
260
- |-----------|------|-------------|
261
- | `objectApiName` | string | Parent object |
262
- | `fieldApiName` | string | Field API name ending in `__c` |
263
-
264
- ---
265
-
266
- ### sf_create_rollup_summary_field
267
- Creates a Roll-Up Summary field on a master object (requires master-detail relationship).
268
-
269
- | Parameter | Type | Description |
270
- |-----------|------|-------------|
271
- | `objectApiName` | string | Master object |
272
- | `fieldName` | string | New field name (no `__c`) |
273
- | `label` | string | Display label |
274
- | `summaryOperation` | `COUNT\|SUM\|MIN\|MAX` | Aggregation type |
275
- | `childObjectApiName` | string | Child (detail) object |
276
- | `fieldToAggregate` | string | Child field to aggregate (not needed for COUNT) |
277
- | `filterCriteria` | string | Optional SOQL-like filter |
278
-
279
- **Example:** "Create a roll-up summary field on Account that sums Opportunity Amount where Stage = 'Closed Won'"
280
-
281
- ---
282
-
283
- ### sf_create_external_id_field
284
- Creates an External ID indexed field for upsert operations.
285
-
286
- | Parameter | Type | Description |
287
- |-----------|------|-------------|
288
- | `objectApiName` | string | Parent object |
289
- | `fieldApiName` | string | Field name (no `__c`) |
290
- | `label` | string | Display label |
291
- | `fieldType` | `Text\|Number\|Email\|Date` | Field data type |
292
- | `unique` | boolean | Enforce uniqueness |
293
- | `caseInsensitive` | boolean | Case-insensitive matching (Text only) |
294
-
295
- ---
296
-
297
- ### sf_enable_object_features
298
- Enables optional features on a custom object.
299
-
300
- | Parameter | Type | Description |
301
- |-----------|------|-------------|
302
- | `objectApiName` | string | API name ending in `__c` |
303
- | `enableHistory` | boolean | Field history tracking |
304
- | `enableActivities` | boolean | Tasks and Events |
305
- | `enableReports` | boolean | Reports availability |
306
- | `enableSearch` | boolean | Global search / SOSL |
307
- | `enableFeeds` | boolean | Chatter feeds |
308
- | `enableBulkApi` | boolean | Bulk API access |
309
-
310
- ---
311
-
312
- ### sf_create_validation_rule
313
- Creates a Validation Rule on any object.
314
-
315
- | Parameter | Type | Description |
316
- |-----------|------|-------------|
317
- | `objectName` | string | Parent object |
318
- | `ruleName` | string | Rule API name |
319
- | `errorConditionFormula` | string | Formula returning `true` when INVALID |
320
- | `errorMessage` | string | Message shown to user |
321
- | `errorDisplayField` | string | Field to display error on |
322
- | `active` | boolean | Active immediately |
323
-
324
- ---
325
-
326
- ### sf_create_flow
327
- Creates a Salesforce Flow via the Metadata API. Supports AutoLaunchedFlow, Screen Flow, RecordTriggeredFlow, ScheduledFlow.
328
-
329
- | Parameter | Type | Description |
330
- |-----------|------|-------------|
331
- | `label` | string | Display label |
332
- | `apiName` | string | API name |
333
- | `flowType` | string | `AutoLaunchedFlow`, `Screen`, `RecordTriggeredFlow`, `ScheduledFlow` |
334
- | `triggerObject` | string | For RecordTriggeredFlow |
335
- | `triggerType` | string | `RecordBeforeSave`, `RecordAfterSave`, `Scheduled` |
336
- | `elements` | array | Flow elements (Decision, GetRecords, CreateRecords, etc.) |
337
- | `variables` | array | Flow variables |
338
- | `status` | string | `Active` or `Draft` |
339
-
340
- ---
341
-
342
- ### sf_create_approval_process
343
- Creates a multi-step Approval Process with entry criteria, approvers, and final actions.
344
-
345
- ---
346
-
347
- ### sf_create_workflow_field_update
348
- Creates a Workflow Field Update action that sets a field to a value or formula result.
349
-
350
- ---
351
-
352
- ## Automation & Flows
353
-
354
- ### sf_activate_flow
355
- Activates the latest version of a Flow via the Tooling API.
356
-
357
- | Parameter | Type | Description |
358
- |-----------|------|-------------|
359
- | `flowApiName` | string | Flow API name |
360
-
361
- ---
362
-
363
- ### sf_update_flow
364
- Updates a Flow's label, description, or API version.
365
-
366
- | Parameter | Type | Description |
367
- |-----------|------|-------------|
368
- | `flowApiName` | string | Flow API name |
369
- | `label` | string | New label (optional) |
370
- | `description` | string | New description (optional) |
371
- | `apiVersion` | string | New API version (optional) |
372
-
373
- ---
374
-
375
- ### sf_clone_flow
376
- Creates a copy of an existing Flow with a new API name.
377
-
378
- | Parameter | Type | Description |
379
- |-----------|------|-------------|
380
- | `sourceFlowApiName` | string | Source flow to copy |
381
- | `newFlowApiName` | string | New flow API name |
382
- | `newLabel` | string | New display label |
383
- | `activateClone` | boolean | Activate immediately (default: `false`) |
384
-
385
- ---
386
-
387
- ### sf_create_flow_test
388
- Creates a Flow Interview Test definition for the Flow Test Manager.
389
-
390
- | Parameter | Type | Description |
391
- |-----------|------|-------------|
392
- | `flowApiName` | string | Flow to test |
393
- | `testName` | string | Test API name |
394
- | `label` | string | Display label |
395
- | `testInputs` | array | `[{variableName, value}]` |
396
- | `testAssertions` | array | `[{variableName, operator, expectedValue}]` |
397
-
398
- ---
399
-
400
- ### sf_create_invocable_action
401
- Registers a custom Invocable Action wrapping an `@InvocableMethod` Apex class.
402
-
403
- | Parameter | Type | Description |
404
- |-----------|------|-------------|
405
- | `actionName` | string | Unique API name |
406
- | `label` | string | Display name in Flow Builder |
407
- | `apexClassName` | string | Apex class with `@InvocableMethod` |
408
-
409
- ---
410
-
411
- ### sf_create_email_alert
412
- Creates a Workflow Email Alert for use in Flows, Approval Processes, or Workflow Rules.
413
-
414
- | Parameter | Type | Description |
415
- |-----------|------|-------------|
416
- | `objectName` | string | Parent object |
417
- | `alertName` | string | Alert API name |
418
- | `template` | string | Email template API name |
419
- | `recipients` | array | `[{type, recipient}]` — type: `user`, `role`, `email` |
420
-
421
- ---
422
-
423
- ### sf_create_platform_event
424
- Creates a Platform Event object (`__e`) for event-driven architecture.
425
-
426
- | Parameter | Type | Description |
427
- |-----------|------|-------------|
428
- | `fullName` | string | API name ending in `__e` |
429
- | `publishBehavior` | string | `PublishAfterCommit` or `PublishImmediately` |
430
- | `fields` | array | Event payload fields |
431
-
432
- ---
433
-
434
- ### sf_create_assignment_rule
435
- Creates an Assignment Rule for Leads or Cases to auto-route to owners/queues.
436
-
437
- ---
438
-
439
- ### sf_create_escalation_rule
440
- Creates a Case Escalation Rule that reassigns unresolved cases after a timeout.
441
-
442
- ---
443
-
444
- ### sf_create_auto_response_rule
445
- Creates an Auto-Response Rule for Web-to-Lead or Web-to-Case confirmation emails.
446
-
447
- ---
448
-
449
- ### sf_create_matching_rule
450
- Creates a Matching Rule to detect potential duplicate records.
451
-
452
- ---
453
-
454
- ### sf_create_duplicate_rule
455
- Creates a Duplicate Rule using Matching Rules to block or warn on duplicates.
456
-
457
- ---
458
-
459
- ### sf_create_apex_email_service
460
- Creates an Apex Email Service that processes inbound emails via an `InboundEmailHandler` class.
461
-
462
- ---
463
-
464
- ### sf_create_scheduled_job
465
- Schedules an existing Schedulable Apex class on a cron expression.
466
-
467
- | Parameter | Type | Description |
468
- |-----------|------|-------------|
469
- | `className` | string | Schedulable Apex class name |
470
- | `jobName` | string | Scheduled job display name |
471
- | `cronExpression` | string | Cron expression, e.g. `0 0 2 * * ?` |
472
-
473
- ---
474
-
475
- ### sf_create_quick_action
476
- Creates a Quick Action (global or object-specific) for record creation, updates, logging calls, or launching flows.
477
-
478
- | Parameter | Type | Description |
479
- |-----------|------|-------------|
480
- | `actionName` | string | API name |
481
- | `actionType` | string | `Create`, `Update`, `LogACall`, `SendEmail`, `Flow` |
482
- | `objectApiName` | string | Object (omit for global) |
483
- | `targetObject` | string | Object to create for Create type |
73
+ **Example prompts:**
74
+ - "Create a Feature_Flag__mdt Custom Metadata Type with a Boolean field IsEnabled__c"
75
+ - "Create an Integration_Config__mdt type with fields for endpoint URL and API key"
484
76
 
485
77
  ---
486
78
 
487
- ## Apex & Code
488
-
489
79
  ### sf_create_apex_class
490
- Deploys an Apex class via Metadata API zip deploy.
80
+ Deploys an Apex class to the org via Metadata API zip deploy.
491
81
 
82
+ **Parameters:**
492
83
  | Parameter | Type | Description |
493
84
  |-----------|------|-------------|
494
- | `className` | string | Class name |
85
+ | `className` | string | Class name (no __c) |
495
86
  | `classBody` | string | Full Apex source code |
496
- | `apiVersion` | string | Default `62.0` |
497
-
498
- **Examples:** "Create an AccountService Apex class", "Create a batch class that deletes records older than 2 years"
499
-
500
- ---
501
-
502
- ### sf_create_apex_trigger
503
- Deploys an Apex Trigger on any object.
504
-
505
- | Parameter | Type | Description |
506
- |-----------|------|-------------|
507
- | `triggerName` | string | Trigger name |
508
- | `objectName` | string | SObject to trigger on |
509
- | `events` | array | `[before insert, after update, ...]` |
510
- | `triggerBody` | string | Code inside the trigger body |
511
-
512
- ---
513
-
514
- ### sf_create_apex_test_class
515
- Deploys an Apex Test class and optionally runs it immediately.
87
+ | `apiVersion` | string | API version, default `62.0` |
516
88
 
517
- | Parameter | Type | Description |
518
- |-----------|------|-------------|
519
- | `className` | string | Test class name |
520
- | `classBody` | string | Full test class source |
521
- | `runAfterDeploy` | boolean | Run tests immediately after deploy |
522
-
523
- ---
89
+ **Example prompts:**
90
+ - "Create an Apex class called AccountService with a method to get all active accounts"
91
+ - "Create a Batch Apex class called DataCleanupBatch that deletes records older than 2 years"
92
+ - "Create a Schedulable class called NightlyReport that generates a report email"
524
93
 
525
- ### sf_run_apex_tests
526
- Runs one or more Apex test classes and returns pass/fail results.
527
-
528
- | Parameter | Type | Description |
529
- |-----------|------|-------------|
530
- | `testClasses` | array | Class names to run |
531
- | `waitMinutes` | number | Timeout (default 5) |
94
+ **Expected output:** Deploy job ID and success/failure message with any compile errors.
532
95
 
533
96
  ---
534
97
 
535
98
  ### sf_execute_anonymous_apex
536
- Executes Apex code immediately via Tooling API `executeAnonymous`.
99
+ Executes Apex code immediately via Tooling API.
537
100
 
101
+ **Parameters:**
538
102
  | Parameter | Type | Description |
539
103
  |-----------|------|-------------|
540
104
  | `apexCode` | string | Apex code to execute |
541
105
 
542
- **Examples:** "Run Apex to set all Contact emails to lowercase", "Execute System.debug(UserInfo.getUserName())"
543
-
544
- ---
106
+ **Example prompts:**
107
+ - "Run this Apex to update all Contact email addresses to lowercase"
108
+ - "Execute: System.debug(UserInfo.getUserName());"
109
+ - "Run anonymous Apex to backfill the missing CreatedDate__c field on all Account records"
545
110
 
546
- ### sf_update_apex_class
547
- Redeploys an existing Apex class with new source code (full replacement).
111
+ **Expected output:** Success/failure, compile errors if any, and debug log if present.
548
112
 
549
113
  ---
550
114
 
551
- ### sf_get_apex_class
552
- Retrieves the source code and metadata of an Apex class via Tooling API.
115
+ ### sf_create_lwc
116
+ Deploys a Lightning Web Component via Metadata API.
553
117
 
118
+ **Parameters:**
554
119
  | Parameter | Type | Description |
555
120
  |-----------|------|-------------|
556
- | `className` | string | Class name |
557
-
558
- ---
559
-
560
- ### sf_get_code_coverage
561
- Retrieves Apex code coverage percentages from the last test run.
121
+ | `componentName` | string | camelCase name, e.g. `accountCard` |
122
+ | `html` | string | Full HTML template content |
123
+ | `javascript` | string | Full JS controller content |
124
+ | `css` | string | Optional CSS |
125
+ | `targets` | array | Where to place the component |
126
+ | `isExposed` | boolean | Available in App Builder |
127
+ | `apiVersion` | string | Default `62.0` |
562
128
 
563
- | Parameter | Type | Description |
564
- |-----------|------|-------------|
565
- | `className` | string | Filter by class name (optional) |
129
+ **Example prompts:**
130
+ - "Create an LWC called opportunityList that shows a table of open opportunities"
131
+ - "Create a contact card LWC with name, email, phone and make it available on Record Pages"
132
+ - "Create an LWC Flow Screen component for collecting address information"
566
133
 
567
134
  ---
568
135
 
569
- ### sf_create_visualforce_page
570
- Deploys a Visualforce page via Metadata API.
136
+ ### sf_create_agent (Agentforce)
137
+ Creates an Agentforce Einstein Copilot agent.
571
138
 
139
+ **Parameters:**
572
140
  | Parameter | Type | Description |
573
141
  |-----------|------|-------------|
574
- | `pageName` | string | Page name (no spaces) |
575
- | `markup` | string | Full Visualforce markup |
576
-
577
- ---
578
-
579
- ### sf_create_aura_component
580
- Deploys an Aura (Lightning Classic) component bundle.
142
+ | `agentName` | string | Agent API name |
143
+ | `label` | string | Display name |
144
+ | `description` | string | Agent description |
145
+ | `type` | string | `EinsteinCopilot` |
146
+ | `company` | string | Company context |
147
+ | `persona` | string | Agent persona description |
148
+ | `tone` | `Formal\|Neutral\|Casual` | Communication tone |
149
+ | `instructions` | string | System-level instructions |
581
150
 
582
- | Parameter | Type | Description |
583
- |-----------|------|-------------|
584
- | `componentName` | string | Component name |
585
- | `markup` | string | `.cmp` markup |
586
- | `controller` | string | Optional JS controller |
587
- | `helper` | string | Optional helper |
588
- | `style` | string | Optional CSS |
151
+ **Example prompts:**
152
+ - "Create an Agentforce agent called SalesBot for helping sales reps close deals"
153
+ - "Create a customer service agent with a formal tone for handling support cases"
589
154
 
590
155
  ---
591
156
 
592
- ### sf_search_apex
593
- Searches Apex class and trigger source code for a keyword across the org.
157
+ ### sf_deploy_metadata
158
+ Deploys metadata components via SOAP deploy.
594
159
 
160
+ **Parameters:**
595
161
  | Parameter | Type | Description |
596
162
  |-----------|------|-------------|
597
- | `searchTerm` | string | Text to search for (case-insensitive) |
598
- | `searchIn` | `classes\|triggers\|both` | Where to search (default: `classes`) |
599
- | `limit` | number | Max results (default 50) |
163
+ | `components` | array | `[{type, name}]` to deploy |
164
+ | `checkOnly` | boolean | Validate without deploying |
165
+ | `runTests` | array | Test classes to run |
166
+ | `rollbackOnError` | boolean | Rollback on any failure |
167
+ | `waitMinutes` | number | Timeout (default 10 min) |
600
168
 
601
- **Example:** "Find all Apex classes that reference the field Annual_Revenue__c"
169
+ **Example prompts:**
170
+ - "Deploy the AccountService Apex class and AccountTrigger to the org"
171
+ - "Validate the deployment of these components without making changes"
172
+ - "Deploy MyFlow and MyClass, running MyClassTest during deployment"
602
173
 
603
174
  ---
604
175
 
605
- ### sf_get_apex_logs
606
- Lists recent Apex debug log entries.
607
-
608
- | Parameter | Type | Description |
609
- |-----------|------|-------------|
610
- | `username` | string | Filter by user (optional) |
611
- | `limit` | number | Max entries (default 20) |
612
- | `operation` | string | Filter by operation type (optional) |
613
-
614
- ---
615
-
616
- ### sf_get_apex_log_body
617
- Retrieves the full content of an Apex debug log.
618
-
619
- | Parameter | Type | Description |
620
- |-----------|------|-------------|
621
- | `logId` | string | 18-char ApexLog record ID |
622
- | `maxLines` | number | Lines to return (default 500) |
623
-
624
- ---
625
-
626
- ### sf_create_apex_batch
627
- Generates and deploys a complete `Database.Batchable` Apex batch class.
628
-
629
- | Parameter | Type | Description |
630
- |-----------|------|-------------|
631
- | `className` | string | Batch class name |
632
- | `query` | string | SOQL query for `start()` method |
633
- | `executeBody` | string | Code for `execute()` method body |
634
- | `finishBody` | string | Optional `finish()` code |
635
- | `batchSize` | number | Default batch size (1-2000, default 200) |
636
-
637
- **Example:** "Create a batch class that sets IsArchived__c = true on Leads last modified over 180 days ago"
638
-
639
- ---
640
-
641
- ### sf_create_apex_scheduler
642
- Generates and deploys a `Schedulable` Apex class, with optional immediate scheduling.
643
-
644
- | Parameter | Type | Description |
645
- |-----------|------|-------------|
646
- | `className` | string | Scheduler class name |
647
- | `executeBody` | string | Code for `execute()` method body |
648
- | `scheduleOnCreate` | boolean | Also schedule immediately |
649
- | `cronExpression` | string | Cron schedule (required if `scheduleOnCreate: true`) |
650
- | `jobName` | string | Scheduled job name |
651
-
652
- ---
653
-
654
- ## LWC & Components
655
-
656
- ### sf_create_lwc
657
- Creates and deploys a Lightning Web Component.
658
-
659
- | Parameter | Type | Description |
660
- |-----------|------|-------------|
661
- | `componentName` | string | camelCase name, e.g. `accountCard` |
662
- | `html` | string | HTML template |
663
- | `javascript` | string | JS controller |
664
- | `css` | string | Optional CSS |
665
- | `targets` | array | `lightning__AppPage`, `lightning__RecordPage`, `lightning__HomePage`, `lightningCommunity__Page`, `lightning__UtilityBar`, `lightning__FlowScreen` |
666
- | `isExposed` | boolean | Available in App Builder |
667
- | `apiVersion` | string | Default `62.0` |
668
-
669
- **Examples:** "Create an LWC that shows a table of open opportunities", "Create a contact card component available on Record Pages"
670
-
671
- ---
672
-
673
- ### sf_update_lwc
674
- Updates an existing LWC with new HTML, JS, or CSS (full redeploy).
675
-
676
- ---
677
-
678
- ## UI & App Builder
679
-
680
- ### sf_create_lightning_app
681
- Creates a Lightning App with navigation bar, utility bar, and logo.
682
-
683
- | Parameter | Type | Description |
684
- |-----------|------|-------------|
685
- | `fullName` | string | App API name |
686
- | `label` | string | Display name |
687
- | `navType` | `Standard\|Console` | Navigation type |
688
- | `navItems` | array | Navigation items (objects, home, reports, etc.) |
689
- | `utilityItems` | array | Utility bar components |
690
-
691
- ---
692
-
693
- ### sf_create_tab
694
- Creates a Custom Tab for a custom object.
695
-
696
- | Parameter | Type | Description |
697
- |-----------|------|-------------|
698
- | `fullName` | string | Tab API name |
699
- | `sobjectName` | string | Object API name |
700
- | `motif` | string | Icon, e.g. `Custom64: Coin` |
701
-
702
- ---
703
-
704
- ### sf_create_compact_layout
705
- Creates a Compact Layout defining fields shown in the record highlights panel.
706
-
707
- | Parameter | Type | Description |
708
- |-----------|------|-------------|
709
- | `objectName` | string | Object API name |
710
- | `fullName` | string | Layout API name |
711
- | `fields` | array | Up to 10 field API names |
712
-
713
- ---
714
-
715
- ### sf_assign_compact_layout
716
- Sets the default Compact Layout for an object.
717
-
718
- ---
719
-
720
- ### sf_create_list_view
721
- Creates a List View (saved filter with columns) for any object.
722
-
723
- | Parameter | Type | Description |
724
- |-----------|------|-------------|
725
- | `objectName` | string | Object API name |
726
- | `fullName` | string | View API name |
727
- | `label` | string | Display label |
728
- | `columns` | array | Field API names to show |
729
- | `filters` | array | `[{field, operation, value}]` |
730
- | `filterScope` | string | `Everything`, `Mine`, `Queue`, etc. |
731
- | `sharedTo` | string | `AllUsers`, `Roles`, `Groups` |
732
-
733
- ---
734
-
735
- ### sf_create_email_template
736
- Creates an HTML or text email template with merge field support.
737
-
738
- | Parameter | Type | Description |
739
- |-----------|------|-------------|
740
- | `fullName` | string | `FolderName/TemplateName` |
741
- | `subject` | string | Email subject |
742
- | `htmlValue` | string | HTML body |
743
- | `body` | string | Plain text body |
744
- | `type` | string | `html`, `text`, `custom` |
745
- | `relatedEntityType` | string | Object for merge fields |
746
-
747
- ---
748
-
749
- ### sf_create_static_resource
750
- Creates a Static Resource from text content (JS, CSS, JSON, etc.).
751
-
752
- | Parameter | Type | Description |
753
- |-----------|------|-------------|
754
- | `fullName` | string | Resource name |
755
- | `content` | string | File content |
756
- | `contentType` | string | MIME type, e.g. `application/javascript` |
757
-
758
- ---
759
-
760
- ### sf_create_custom_notification_type
761
- Creates a Custom Notification Type for in-app and mobile push notifications.
762
-
763
- ---
764
-
765
- ### sf_create_report_type
766
- Creates a Custom Report Type defining available objects and fields in Report Builder.
767
-
768
- | Parameter | Type | Description |
769
- |-----------|------|-------------|
770
- | `fullName` | string | Report type API name |
771
- | `baseObject` | string | Primary object |
772
- | `relationships` | array | Related objects to include |
773
- | `category` | string | `Accounts`, `Opportunities`, etc. |
774
-
775
- ---
776
-
777
- ### sf_create_dashboard
778
- Creates a Dashboard with chart, metric, table, and gauge components.
779
-
780
- | Parameter | Type | Description |
781
- |-----------|------|-------------|
782
- | `fullName` | string | `FolderName/DashboardName` |
783
- | `title` | string | Dashboard title |
784
- | `components` | array | `[{type, reportApiName, header, columnSpan, rowSpan}]` |
785
- | `runningUser` | string | Running user for shared visibility |
786
-
787
- ---
788
-
789
- ### sf_update_page_layout
790
- Updates a Page Layout's label or properties.
791
-
792
- ---
793
-
794
- ### sf_assign_page_layout
795
- Assigns a Page Layout to one or more Profiles for an object.
796
-
797
- | Parameter | Type | Description |
798
- |-----------|------|-------------|
799
- | `objectName` | string | Object API name |
800
- | `layoutName` | string | Layout API name |
801
- | `profiles` | array | Profile API names |
802
-
803
- ---
804
-
805
- ### sf_create_lightning_record_page
806
- Creates a Lightning Record Page (FlexiPage) for an object.
807
-
808
- | Parameter | Type | Description |
809
- |-----------|------|-------------|
810
- | `apiName` | string | FlexiPage API name |
811
- | `label` | string | Display label |
812
- | `sobjectType` | string | Object API name |
813
- | `template` | string | `RecordPage_Default`, `RecordPage_OneColumn`, `RecordPage_ThreeColumn` |
814
- | `regions` | array | `[{name, mode, components:[{name, properties:{}}]}]` |
815
-
816
- ---
817
-
818
- ### sf_create_lightning_home_page
819
- Creates a Lightning Home Page (FlexiPage) for a Lightning App.
820
-
821
- ---
822
-
823
- ### sf_create_lightning_app_page
824
- Creates a Lightning App Page (FlexiPage) for use as a tab in a Lightning App.
825
-
826
- | Parameter | Type | Description |
827
- |-----------|------|-------------|
828
- | `apiName` | string | FlexiPage API name |
829
- | `label` | string | Display label |
830
- | `template` | string | `AppDefaultTemplate`, `OneRegion`, `TwoColumn_LeftSidebar`, `TwoColumn_RightSidebar`, `ThreeColumn` |
831
-
832
- ---
833
-
834
- ### sf_update_lightning_page
835
- Updates an existing Lightning Page (FlexiPage) label.
836
-
837
- ---
838
-
839
- ### sf_assign_lightning_page
840
- Assigns a Lightning Page to an Experience Cloud site.
841
-
842
- ---
843
-
844
- ### sf_create_letterhead
845
- Creates an email Letterhead for Classic email template branding (header/footer colors, fonts, logo).
846
-
847
- | Parameter | Type | Description |
848
- |-----------|------|-------------|
849
- | `fullName` | string | Letterhead API name |
850
- | `name` | string | Display name |
851
- | `headerColor` | string | Hex color, e.g. `#0070D2` |
852
- | `footerColor` | string | Hex color |
853
- | `bodyColor` | string | Hex color |
854
- | `fontName` | string | Font face |
855
- | `footerText` | string | Optional footer text |
856
-
857
- ---
858
-
859
- ## Security & Permissions
860
-
861
- ### sf_create_permission_set
862
- Creates a Permission Set with object, field, Apex class, and user permissions.
863
-
864
- | Parameter | Type | Description |
865
- |-----------|------|-------------|
866
- | `fullName` | string | Permission set API name |
867
- | `label` | string | Display label |
868
- | `objectPermissions` | array | `[{object, allowRead, allowCreate, allowEdit, allowDelete, viewAllRecords, modifyAllRecords}]` |
869
- | `fieldPermissions` | array | `[{field, readable, editable}]` |
870
- | `apexClassAccesses` | array | `[{apexClass, enabled}]` |
871
- | `userPermissions` | array | `[{name, enabled}]` |
872
-
873
- ---
874
-
875
- ### sf_update_permission_set
876
- Adds or modifies object and field permissions on an existing Permission Set.
877
-
878
- ---
879
-
880
- ### sf_create_permission_set_group
881
- Creates a Permission Set Group combining multiple Permission Sets.
882
-
883
- | Parameter | Type | Description |
884
- |-----------|------|-------------|
885
- | `fullName` | string | Group API name |
886
- | `label` | string | Display label |
887
- | `permissionSets` | array | Permission set API names to include |
888
-
889
- ---
890
-
891
- ### sf_create_muting_permission_set
892
- Creates a Muting Permission Set that removes permissions within a Permission Set Group.
893
-
894
- ---
895
-
896
- ### sf_assign_permission_set
897
- Assigns a Permission Set to a user by username or user ID.
898
-
899
- | Parameter | Type | Description |
900
- |-----------|------|-------------|
901
- | `permissionSetName` | string | Permission set API name |
902
- | `username` | string | User email/username |
903
- | `userId` | string | User record ID (alternative) |
904
-
905
- ---
906
-
907
- ### sf_create_role
908
- Creates a Role in the Salesforce role hierarchy.
909
-
910
- | Parameter | Type | Description |
911
- |-----------|------|-------------|
912
- | `fullName` | string | Role API name |
913
- | `name` | string | Display name |
914
- | `parentRole` | string | Parent role API name (optional) |
915
- | `opportunityAccessLevel` | string | `Edit`, `Read`, `None` |
916
-
917
- ---
918
-
919
- ### sf_create_queue
920
- Creates a Queue for routing records (Cases, Leads, etc.) to teams.
921
-
922
- | Parameter | Type | Description |
923
- |-----------|------|-------------|
924
- | `fullName` | string | Queue API name |
925
- | `name` | string | Display name |
926
- | `email` | string | Queue notification email |
927
- | `supportedObjects` | array | Object API names the queue supports |
928
- | `queueMembers` | array | User or group members |
929
-
930
- ---
931
-
932
- ### sf_create_named_credential
933
- Creates a Named Credential for authenticated outbound callouts.
934
-
935
- | Parameter | Type | Description |
936
- |-----------|------|-------------|
937
- | `fullName` | string | Credential API name |
938
- | `label` | string | Display label |
939
- | `endpoint` | string | Base URL |
940
- | `protocol` | string | `NoAuthentication`, `Password`, `OAuth` |
941
- | `username` / `password` | string | For Password protocol |
942
-
943
- ---
944
-
945
- ### sf_set_field_level_security
946
- Sets read/edit FLS for a field across Profiles and/or Permission Sets.
947
-
948
- | Parameter | Type | Description |
949
- |-----------|------|-------------|
950
- | `fieldApiName` | string | `ObjectName.FieldName__c` |
951
- | `profiles` | array | Profile names |
952
- | `permissionSets` | array | Permission set names |
953
- | `readable` | boolean | Allow reading |
954
- | `editable` | boolean | Allow editing |
955
-
956
- ---
957
-
958
- ### sf_set_org_wide_defaults
959
- Sets the org-wide default sharing model for an object.
960
-
961
- | Parameter | Type | Description |
962
- |-----------|------|-------------|
963
- | `objectApiName` | string | Object API name |
964
- | `internalAccess` | string | `Private`, `Read`, `ReadWrite`, `ControlledByParent` |
965
- | `externalAccess` | string | External sharing setting (optional) |
966
-
967
- ---
968
-
969
- ### sf_clone_profile
970
- Creates a new Profile by cloning an existing one.
971
-
972
- | Parameter | Type | Description |
973
- |-----------|------|-------------|
974
- | `sourceProfileName` | string | Profile to clone from |
975
- | `newProfileName` | string | New profile name |
976
-
977
- ---
978
-
979
- ### sf_update_profile
980
- Updates object permissions, FLS, tab visibility, and app visibility on an existing Profile.
981
-
982
- ---
983
-
984
- ## Data Management
985
-
986
- ### sf_create_user
987
- Creates a new Salesforce user.
988
-
989
- | Parameter | Type | Description |
990
- |-----------|------|-------------|
991
- | `username` | string | Must be unique, email-like |
992
- | `lastName` | string | Last name |
993
- | `email` | string | Email address |
994
- | `profileName` | string | Profile display name |
995
- | `roleApiName` | string | Role DeveloperName (optional) |
996
- | `firstName` | string | First name (optional) |
997
-
998
- ---
999
-
1000
- ### sf_update_user
1001
- Updates an existing user's properties.
1002
-
1003
- | Parameter | Type | Description |
1004
- |-----------|------|-------------|
1005
- | `username` | string | User to update |
1006
- | `isActive` | boolean | Activate/deactivate |
1007
- | `title` / `department` / `phone` | string | Profile fields |
1008
-
1009
- ---
1010
-
1011
- ### sf_query_records
1012
- Executes a SOQL query and returns results.
1013
-
1014
- | Parameter | Type | Description |
1015
- |-----------|------|-------------|
1016
- | `soql` | string | Full SOQL string, OR use individual params: |
1017
- | `objectApiName` | string | Object to query |
1018
- | `fields` | array | Field API names |
1019
- | `whereClause` | string | WHERE condition |
1020
- | `orderBy` | string | ORDER BY clause |
1021
- | `limit` | number | Max records |
1022
-
1023
- ---
1024
-
1025
- ### sf_create_record
1026
- Creates a single SObject record via REST API.
1027
-
1028
- | Parameter | Type | Description |
1029
- |-----------|------|-------------|
1030
- | `objectApiName` | string | Object API name |
1031
- | `fields` | object | `{FieldApiName: value}` |
1032
-
1033
- ---
1034
-
1035
- ### sf_update_record
1036
- Updates an existing record by ID.
1037
-
1038
- | Parameter | Type | Description |
1039
- |-----------|------|-------------|
1040
- | `objectApiName` | string | Object API name |
1041
- | `recordId` | string | 15 or 18 char record ID |
1042
- | `fields` | object | Fields to update |
1043
-
1044
- ---
1045
-
1046
- ### sf_upsert_record
1047
- Creates or updates a record using an External ID field for matching.
1048
-
1049
- | Parameter | Type | Description |
1050
- |-----------|------|-------------|
1051
- | `objectApiName` | string | Object API name |
1052
- | `externalIdField` | string | External ID field API name |
1053
- | `externalIdValue` | string | Value to match on |
1054
- | `fields` | object | Field values to set |
1055
-
1056
- ---
1057
-
1058
- ### sf_get_record
1059
- Retrieves a single record by 15 or 18 char record ID.
1060
-
1061
- | Parameter | Type | Description |
1062
- |-----------|------|-------------|
1063
- | `objectApiName` | string | Object API name |
1064
- | `recordId` | string | Record ID |
1065
- | `fields` | array | Fields to return (optional — all if omitted) |
1066
-
1067
- ---
1068
-
1069
- ### sf_delete_record ⚠️
1070
- Deletes a single SObject record by ID.
1071
-
1072
- | Parameter | Type | Description |
1073
- |-----------|------|-------------|
1074
- | `objectApiName` | string | Object API name |
1075
- | `recordId` | string | 15 or 18 char record ID |
1076
-
1077
- ---
1078
-
1079
- ### sf_bulk_import_records
1080
- Bulk imports records using Bulk API 2.0 (insert, upsert, update, delete).
1081
-
1082
- | Parameter | Type | Description |
1083
- |-----------|------|-------------|
1084
- | `objectApiName` | string | Object API name |
1085
- | `operation` | string | `insert`, `upsert`, `update`, `delete` |
1086
- | `csvData` | string | CSV with header row |
1087
- | `externalIdField` | string | Upsert key field (for upsert) |
1088
-
1089
- ---
1090
-
1091
- ### sf_export_records
1092
- Exports Salesforce records as CSV data via SOQL.
1093
-
1094
- | Parameter | Type | Description |
1095
- |-----------|------|-------------|
1096
- | `soql` | string | SOQL query |
1097
- | `includeHeader` | boolean | Include CSV header (default `true`) |
1098
- | `maxRecords` | number | Max records (default 50000) |
1099
-
1100
- ---
1101
-
1102
- ### sf_search_records
1103
- Cross-object text search using SOSL.
1104
-
1105
- | Parameter | Type | Description |
1106
- |-----------|------|-------------|
1107
- | `searchTerm` | string | Text to search |
1108
- | `objects` | array | `[{objectName, fields:[]}]` |
1109
- | `searchGroup` | string | `ALL FIELDS`, `NAME FIELDS`, `EMAIL FIELDS`, `PHONE FIELDS` |
1110
- | `limit` | number | Max per object (default 20) |
1111
-
1112
- **Example:** "Search for 'Acme' across Accounts, Contacts, and Opportunities"
1113
-
1114
- ---
1115
-
1116
- ### sf_send_email
1117
- Sends an email via Salesforce's emailSimple invocable action.
1118
-
1119
- | Parameter | Type | Description |
1120
- |-----------|------|-------------|
1121
- | `toAddresses` | array | Recipient email addresses |
1122
- | `subject` | string | Email subject |
1123
- | `body` / `htmlBody` | string | Email body |
1124
- | `whatId` | string | Related record ID (links as activity) |
1125
- | `whoId` | string | Contact/Lead record ID |
1126
-
1127
- ---
1128
-
1129
- ### sf_assign_queue_member
1130
- Adds a user to an existing Queue.
1131
-
1132
- ---
1133
-
1134
- ### sf_create_public_group
1135
- Creates a Public Group for sharing rules or email distribution.
1136
-
1137
- ---
1138
-
1139
- ## Deployment & Environments
1140
-
1141
- ### sf_deploy_metadata
1142
- Deploys metadata components via SOAP Metadata API.
1143
-
1144
- | Parameter | Type | Description |
1145
- |-----------|------|-------------|
1146
- | `components` | array | `[{type, name}]` to deploy |
1147
- | `checkOnly` | boolean | Validate without deploying |
1148
- | `runTests` | array | Test classes to run |
1149
- | `rollbackOnError` | boolean | Rollback on failure |
1150
- | `testLevel` | string | `RunSpecifiedTests`, `RunLocalTests`, `RunAllTestsInOrg` |
1151
- | `waitMinutes` | number | Timeout (default 10) |
1152
-
1153
- ---
1154
-
1155
- ### sf_validate_deployment
1156
- Validate-only deployment — checks components without making changes.
1157
-
1158
- ---
1159
-
1160
- ### sf_check_deploy_status
1161
- Checks the status of an in-progress deployment by async job ID.
1162
-
1163
- ---
1164
-
1165
- ### sf_retrieve_metadata
1166
- Initiates a metadata retrieve operation and returns the async job ID.
1167
-
1168
- ---
1169
-
1170
- ### sf_list_metadata
1171
- Lists all components of a metadata type in the org (API names, file names, last modified dates).
1172
-
1173
- | Parameter | Type | Description |
1174
- |-----------|------|-------------|
1175
- | `metadataType` | string | e.g. `ApexClass`, `Flow`, `CustomObject` |
1176
-
1177
- ---
1178
-
1179
- ### sf_compare_orgs
1180
- Compares metadata between two orgs using SF CLI aliases.
1181
-
1182
- | Parameter | Type | Description |
1183
- |-----------|------|-------------|
1184
- | `sourceAlias` | string | Source org SF CLI alias |
1185
- | `targetAlias` | string | Target org SF CLI alias |
1186
- | `metadataTypes` | array | Types to compare (default: ApexClass, Flow, CustomObject, PermissionSet, LightningComponentBundle) |
1187
-
1188
- > Requires SF CLI installed and both orgs authenticated via `sf org login`.
1189
-
1190
- ---
1191
-
1192
- ### sf_rollback_deployment
1193
- Cancels an in-progress deployment by async job ID.
1194
-
1195
- | Parameter | Type | Description |
1196
- |-----------|------|-------------|
1197
- | `deployId` | string | Async job ID from sf_deploy_metadata |
1198
-
1199
- > Note: Only cancels `Pending` or `InProgress` deployments. Completed deployments cannot be rolled back via API.
1200
-
1201
- ---
1202
-
1203
- ### sf_create_scratch_org
1204
- Creates a scratch org using SF CLI (requires Dev Hub).
1205
-
1206
- | Parameter | Type | Description |
1207
- |-----------|------|---------|
1208
- | `orgAlias` | string | Alias for the new scratch org |
1209
- | `devHubAlias` | string | Dev Hub org alias (default: `DevHub`) |
1210
- | `edition` | string | `Developer`, `Enterprise`, etc. |
1211
- | `duration` | number | Days until expiry (1-30, default 7) |
1212
- | `features` | array | Scratch org features |
1213
-
1214
- ---
1215
-
1216
- ### sf_create_sandbox
1217
- Creates a new sandbox (Developer, Developer_Pro, Partial, or Full).
1218
-
1219
- | Parameter | Type | Description |
1220
- |-----------|------|-------------|
1221
- | `sandboxName` | string | Sandbox name (max 10 chars) |
1222
- | `sandboxType` | string | `Developer`, `Developer_Pro`, `Partial`, `Full` |
1223
-
1224
- ---
1225
-
1226
- ### sf_refresh_sandbox ⚠️
1227
- Refreshes an existing sandbox to match current production state. **All sandbox data/metadata is lost.**
1228
-
1229
- | Parameter | Type | Description |
1230
- |-----------|------|-------------|
1231
- | `sandboxName` | string | Sandbox to refresh |
1232
-
1233
- ---
1234
-
1235
- ### sf_export_package_xml
1236
- Generates a `package.xml` manifest by listing org components.
1237
-
1238
- | Parameter | Type | Description |
1239
- |-----------|------|-------------|
1240
- | `metadataTypes` | array | Types to include (default: common types) |
1241
- | `apiVersion` | string | API version for package.xml |
1242
- | `includeAll` | boolean | Use wildcards (`*`) instead of listing components |
1243
-
1244
- ---
1245
-
1246
- ### sf_create_outbound_change_set
1247
- Creates an Outbound Change Set container for sandbox → production deployment.
1248
-
1249
- ---
1250
-
1251
- ### sf_add_to_change_set
1252
- Adds metadata components to an existing Change Set.
1253
-
1254
- ---
1255
-
1256
- ## Integrations & Connectivity
1257
-
1258
- ### sf_create_connected_app
1259
- Creates a Connected App for OAuth 2.0 authentication.
1260
-
1261
- | Parameter | Type | Description |
1262
- |-----------|------|-------------|
1263
- | `fullName` | string | App API name |
1264
- | `label` | string | Display name |
1265
- | `contactEmail` | string | Contact email |
1266
- | `callbackUrls` | array | OAuth callback URLs |
1267
- | `scopes` | array | OAuth scopes: `api`, `web`, `full`, `offline_access`, etc. |
1268
-
1269
- ---
1270
-
1271
- ### sf_create_named_credential
1272
- (See [Security & Permissions](#security--permissions))
1273
-
1274
- ---
1275
-
1276
- ### sf_create_remote_site_setting
1277
- Whitelists an external URL for Apex HTTP callouts.
1278
-
1279
- | Parameter | Type | Description |
1280
- |-----------|------|-------------|
1281
- | `fullName` | string | Setting API name |
1282
- | `url` | string | External URL to whitelist |
1283
- | `isActive` | boolean | Active (default `true`) |
1284
-
1285
- ---
1286
-
1287
- ### sf_create_csp_setting
1288
- Creates a Content Security Policy trusted site for LWC external resources.
1289
-
1290
- | Parameter | Type | Description |
1291
- |-----------|------|-------------|
1292
- | `endpointUrl` | string | External URL to trust |
1293
- | `cspDirectives` | array | `connect-src`, `script-src`, `style-src`, `img-src`, `frame-src`, `font-src` |
1294
-
1295
- ---
1296
-
1297
- ### sf_create_external_data_source
1298
- Creates an External Data Source for Salesforce Connect (OData 2.0/4.0, Apex, SimpleURL).
1299
-
1300
- ---
1301
-
1302
- ### sf_create_external_object
1303
- Creates an External Object (`__x`) linked to an External Data Source.
1304
-
1305
- ---
1306
-
1307
- ### sf_create_outbound_message
1308
- Creates a Workflow Outbound Message that POSTs XML to an external SOAP endpoint.
1309
-
1310
- ---
1311
-
1312
- ### sf_create_auth_provider
1313
- Creates an Auth Provider for third-party OAuth 2.0 SSO (Google, Salesforce, custom).
1314
-
1315
- ---
1316
-
1317
- ### sf_create_certificate
1318
- Creates a self-signed Certificate for callout signing, SAML assertions, or Named Credential encryption.
1319
-
1320
- | Parameter | Type | Description |
1321
- |-----------|------|-------------|
1322
- | `fullName` | string | Certificate API name |
1323
- | `keySize` | `2048\|4096` | Key size |
1324
- | `expirationDate` | string | ISO date, e.g. `2030-01-01` |
1325
- | `privateKeyExportable` | boolean | Allow private key export |
1326
-
1327
- ---
1328
-
1329
- ### sf_create_event_relay
1330
- Creates an EventRelayConfig to relay Platform Events or CDC events to Amazon EventBridge or another event bus.
1331
-
1332
- | Parameter | Type | Description |
1333
- |-----------|------|-------------|
1334
- | `eventChannel` | string | Platform Event or CDC channel (e.g. `MyEvent__e`) |
1335
- | `destinationType` | `AmazonEventBridge\|EventBus` | Destination type |
1336
- | `destinationResourceName` | string | ARN or bus name |
1337
- | `state` | `RUN\|STOP\|PAUSE` | Initial relay state |
1338
-
1339
- ---
1340
-
1341
- ### sf_create_platform_event_subscription
1342
- Creates an Apex trigger that subscribes to a Platform Event channel.
1343
-
1344
- | Parameter | Type | Description |
1345
- |-----------|------|-------------|
1346
- | `eventApiName` | string | Platform Event API name ending in `__e` |
1347
- | `triggerName` | string | Apex trigger name |
1348
- | `triggerBody` | string | Trigger body code (operates on `List<EventApiName>`) |
1349
-
1350
- ---
1351
-
1352
- ### sf_create_change_data_capture
1353
- Enables Change Data Capture for one or more Salesforce objects.
1354
-
1355
- | Parameter | Type | Description |
1356
- |-----------|------|-------------|
1357
- | `objectApiNames` | array | Objects to enable CDC for, e.g. `['Account', 'Contact']` |
1358
-
1359
- > After enabling, subscribe to `<ObjectName>ChangeEvent` channels via Streaming API.
1360
-
1361
- ---
1362
-
1363
- ### sf_create_rest_resource
1364
- Creates and deploys an Apex REST resource (`@RestResource`) class.
1365
-
1366
- | Parameter | Type | Description |
1367
- |-----------|------|-------------|
1368
- | `className` | string | Apex class name |
1369
- | `urlMapping` | string | URL path, e.g. `/v1/orders/*` |
1370
- | `methods` | array | `GET`, `POST`, `PUT`, `PATCH`, `DELETE` |
1371
- | `getBody` / `postBody` / `putBody` / `deleteBody` | string | Method implementation code |
1372
-
1373
- ---
1374
-
1375
- ## Experience Cloud
1376
-
1377
- ### sf_create_experience_site
1378
- Creates an Experience Cloud site using a specified template.
1379
-
1380
- | Parameter | Type | Description |
1381
- |-----------|------|-------------|
1382
- | `siteName` | string | Site API name |
1383
- | `label` | string | Display name |
1384
- | `template` | string | `CustomerService`, `Partner`, `LWR`, `Aloha`, `Microsites` |
1385
- | `urlPathPrefix` | string | URL path (e.g. `customers`) |
1386
- | `status` | string | `Live`, `DownForMaintenance`, `UnderConstruction` |
1387
-
1388
- ---
1389
-
1390
- ### sf_create_experience_page
1391
- Creates a page within an existing Experience Cloud site.
1392
-
1393
- ---
1394
-
1395
- ### sf_publish_experience_site
1396
- Publishes a site to make all pending changes live.
1397
-
1398
- ---
1399
-
1400
- ### sf_update_experience_site
1401
- Updates site settings (description, guest access, guest profile).
1402
-
1403
- ---
1404
-
1405
- ### sf_create_navigation_menu
1406
- Creates a Navigation Menu for an Experience Cloud site.
1407
-
1408
- | Parameter | Type | Description |
1409
- |-----------|------|-------------|
1410
- | `siteName` | string | Site API name |
1411
- | `menuName` | string | Menu API name |
1412
- | `items` | array | `[{label, type, url, page}]` |
1413
-
1414
- ---
1415
-
1416
- ### sf_add_experience_site_members
1417
- Adds user profiles or permission sets as site member groups.
1418
-
1419
- ---
1420
-
1421
- ### sf_set_experience_site_branding
1422
- Applies branding tokens (colors, fonts, logo) to a site.
1423
-
1424
- ---
1425
-
1426
- ### sf_create_experience_container
1427
- Creates a container region within an Experience Cloud page.
1428
-
1429
- | Parameter | Type | Description |
1430
- |-----------|------|-------------|
1431
- | `siteName` | string | Site API name |
1432
- | `pageName` | string | Page name |
1433
- | `containerName` | string | Container API name |
1434
- | `region` | string | Page region: `main`, `sidebar`, `header` |
1435
-
1436
- ---
1437
-
1438
- ### sf_set_experience_site_login
1439
- Configures login, self-registration, and SSO settings for an Experience site.
1440
-
1441
- | Parameter | Type | Description |
1442
- |-----------|------|-------------|
1443
- | `siteName` | string | Site API name |
1444
- | `loginPageUrl` | string | Custom login page URL |
1445
- | `selfRegistrationEnabled` | boolean | Allow self-registration |
1446
- | `allowInternalUserLogin` | boolean | Allow internal users |
1447
- | `loginOptions` | array | SSO auth provider names |
1448
-
1449
- ---
1450
-
1451
- ### sf_create_cms_content
1452
- Creates a CMS content item in a Salesforce CMS workspace.
1453
-
1454
- | Parameter | Type | Description |
1455
- |-----------|------|-------------|
1456
- | `workspaceName` | string | CMS workspace name |
1457
- | `contentType` | string | `cms_document`, `cms_image`, `news`, or custom type |
1458
- | `title` | string | Content title |
1459
- | `body` | string | Content body |
1460
- | `publishStatus` | `Draft\|Published` | Publication status |
1461
-
1462
- ---
1463
-
1464
- ## Agentforce
1465
-
1466
- > **Creation Order:** flows → actions → topics → planner → agent → activate
1467
-
1468
- ### sf_create_agent
1469
- Creates an Agentforce Agent (Bot metadata).
1470
-
1471
- | Parameter | Type | Description |
1472
- |-----------|------|-------------|
1473
- | `agentName` | string | Bot API name |
1474
- | `label` | string | Display name |
1475
- | `type` | `EinsteinCopilot\|ExternalCopilot` | Agent type (immutable after creation) |
1476
- | `plannerName` | string | GenAiPlannerBundle API name |
1477
- | `description` | string | Agent description |
1478
- | `persona` | string | Agent persona |
1479
- | `company` | string | Company context |
1480
- | `tone` | `Formal\|Neutral\|Casual` | Communication tone |
1481
-
1482
- ---
1483
-
1484
- ### sf_create_agent_topic
1485
- Creates a Topic (GenAiPlugin) defining an agent's area of expertise.
1486
-
1487
- | Parameter | Type | Description |
1488
- |-----------|------|-------------|
1489
- | `topicName` | string | GenAiPlugin API name |
1490
- | `label` | string | Display label |
1491
- | `description` | string | Routing description (how LLM decides to route here) |
1492
- | `scope` | string | Scope of this topic |
1493
- | `instructions` | array | Step-by-step instructions |
1494
- | `actions` | array | Agent action API names to include |
1495
- | `escalationEnabled` | boolean | Allow escalation to human |
1496
-
1497
- ---
1498
-
1499
- ### sf_create_agent_action
1500
- Creates an Agentforce Action (GenAiFunction) linked to a Flow or Apex class.
1501
-
1502
- | Parameter | Type | Description |
1503
- |-----------|------|-------------|
1504
- | `actionName` | string | GenAiFunction API name |
1505
- | `label` | string | Display label |
1506
- | `description` | string | LLM-facing description |
1507
- | `invocationTargetType` | `Flow\|ApexClass` | Action backend |
1508
- | `flowApiName` | string | Flow API name (for Flow actions) |
1509
- | `apexClassName` | string | Apex class (for ApexClass actions) |
1510
- | `inputs` | array | `[{name, type, description, required}]` |
1511
- | `outputs` | array | `[{name, type, description}]` |
1512
-
1513
- > Schema files are auto-generated. Without them the LLM cannot invoke the action.
1514
-
1515
- ---
1516
-
1517
- ### sf_create_agent_planner
1518
- Creates a GenAiPlannerBundle connecting topics to the agent's planning engine.
1519
-
1520
- | Parameter | Type | Description |
1521
- |-----------|------|-------------|
1522
- | `plannerName` | string | Planner API name |
1523
- | `label` | string | Display label |
1524
- | `topics` | array | GenAiPlugin API names |
1525
- | `dataLibraryName` | string | Knowledge base name (optional) |
1526
-
1527
- ---
1528
-
1529
- ### sf_activate_agent
1530
- Activates an Agentforce Agent.
1531
-
1532
- ---
1533
-
1534
- ### sf_deactivate_agent
1535
- Deactivates an agent (required before modifying topics/actions).
1536
-
1537
- ---
1538
-
1539
- ### sf_get_agent
1540
- Retrieves an agent's full configuration including topics, actions, and planners.
1541
-
1542
- ---
1543
-
1544
- ### sf_list_agents
1545
- Lists all Agentforce Agents in the org.
1546
-
1547
- ---
1548
-
1549
- ### sf_update_agent_topic
1550
- Updates an existing topic's description, instructions, or actions.
1551
-
1552
- ---
1553
-
1554
- ### sf_update_agent_action
1555
- Updates an action and regenerates its LLM-facing input/output schema files.
1556
-
1557
- ---
1558
-
1559
- ### sf_delete_agent
1560
- Deletes an agent and optionally its topics and actions.
1561
-
1562
- | Parameter | Type | Description |
1563
- |-----------|------|-------------|
1564
- | `agentApiName` | string | Bot API name |
1565
- | `deleteTopics` | boolean | Also delete GenAiPlugin topics |
1566
- | `deleteActions` | boolean | Also delete GenAiFunction actions |
1567
-
1568
- ---
1569
-
1570
- ### sf_test_agent
1571
- Sends a test message to an agent and returns its response.
1572
-
1573
- | Parameter | Type | Description |
1574
- |-----------|------|-------------|
1575
- | `agentApiName` | string | Bot API name |
1576
- | `message` | string | Test message to send |
1577
-
1578
- ---
1579
-
1580
- ### sf_get_agent_logs
1581
- Queries ConversationDefinitionEventLog for agent routing and action execution events.
1582
-
1583
- ---
1584
-
1585
- ### sf_create_agent_channel
1586
- Creates a BotChannel connecting an agent to a deployment channel.
1587
-
1588
- | Parameter | Type | Description |
1589
- |-----------|------|-------------|
1590
- | `agentApiName` | string | Bot API name |
1591
- | `channelType` | string | `EmbeddedService`, `Slack`, `MicrosoftTeams`, `WhatsApp`, `SMS`, `CustomChannel` |
1592
- | `channelName` | string | Channel API name |
1593
- | `isActive` | boolean | Activate immediately (default `true`) |
1594
-
1595
- ---
1596
-
1597
- ### sf_clone_agent
1598
- Clones an Agentforce Agent including all topics, actions, and planner bundle.
1599
-
1600
- | Parameter | Type | Description |
1601
- |-----------|------|-------------|
1602
- | `sourceAgentApiName` | string | Agent to clone |
1603
- | `newAgentApiName` | string | New agent API name |
1604
- | `newAgentLabel` | string | New display label |
1605
- | `activateClone` | boolean | Activate after creation (default `false`) |
1606
-
1607
- ---
1608
-
1609
- ### sf_export_agent
1610
- Exports a complete agent configuration as JSON (Bot + planner + topics + actions).
1611
-
1612
- | Parameter | Type | Description |
1613
- |-----------|------|-------------|
1614
- | `agentApiName` | string | Agent to export |
1615
-
1616
- ---
1617
-
1618
- ## OmniStudio
1619
-
1620
- ### FlexCards
1621
-
1622
- #### sf_create_flexcard
1623
- Creates an OmniStudio FlexCard (OmniUiCard metadata).
1624
-
1625
- | Parameter | Type | Description |
1626
- |-----------|------|-------------|
1627
- | `cardName` | string | FlexCard API name |
1628
- | `label` | string | Display label |
1629
- | `dataSourceType` | string | `SOQL`, `DataRaptor`, `IntegrationProcedure`, `Apex`, `None` |
1630
- | `dataSourceName` | string | Query, DataRaptor name, or IP key |
1631
- | `fields` | array | Fields to display |
1632
- | `actions` | array | Actions (navigate, launch OmniScript, open URL) |
1633
-
1634
- #### sf_update_flexcard
1635
- Updates an existing FlexCard definition.
1636
-
1637
- #### sf_activate_flexcard
1638
- Activates a FlexCard (sets `isActive=true`).
1639
-
1640
- #### sf_get_flexcard
1641
- Retrieves a FlexCard's full configuration.
1642
-
1643
- ---
1644
-
1645
- ### OmniScripts
1646
-
1647
- #### sf_create_omniscript
1648
- Creates an OmniScript guided interaction flow.
1649
-
1650
- | Parameter | Type | Description |
1651
- |-----------|------|-------------|
1652
- | `type` | string | Script type (e.g. `AccountOpening`) |
1653
- | `subType` | string | Script subtype (e.g. `Personal`) |
1654
- | `language` | string | Language code (e.g. `English`) |
1655
- | `isLwcEnabled` | boolean | Deploy as LWC (recommended) |
1656
- | `elements` | array | Script elements (steps, actions, blocks) |
1657
-
1658
- #### sf_update_omniscript
1659
- Updates OmniScript metadata properties.
1660
-
1661
- #### sf_activate_omniscript
1662
- Activates an OmniScript (identified by Type + SubType + Language).
1663
-
1664
- #### sf_get_omniscript
1665
- Retrieves an OmniScript's configuration.
1666
-
1667
- ---
1668
-
1669
- ### DataRaptors
1670
-
1671
- #### sf_create_dataraptor
1672
- Creates a DataRaptor interface for Extract, Transform, or Load operations.
1673
-
1674
- | Parameter | Type | Description |
1675
- |-----------|------|-------------|
1676
- | `interfaceName` | string | DataRaptor API name |
1677
- | `interfaceType` | `Extract\|Transform\|Load` | Operation type |
1678
- | `fieldMappings` | array | `[{sourceField, targetField, dataType, formula}]` |
1679
- | `filterCriteria` | string | WHERE clause (Extract only) |
1680
-
1681
- #### sf_get_dataraptor
1682
- Retrieves a DataRaptor's configuration.
1683
-
1684
- ---
1685
-
1686
- ### Integration Procedures
1687
-
1688
- #### sf_create_integration_procedure
1689
- Creates an OmniStudio Integration Procedure (server-side orchestration).
1690
-
1691
- | Parameter | Type | Description |
1692
- |-----------|------|-------------|
1693
- | `procedureName` | string | Procedure name |
1694
- | `subType` | string | Sub-type (fullName = Name_SubType) |
1695
- | `elements` | array | `[{name, type, properties}]` — DataRaptor, HTTPAction, Response, Loop, etc. |
1696
- | `isActive` | boolean | Activate immediately |
1697
-
1698
- #### sf_update_integration_procedure / sf_get_integration_procedure / sf_activate_integration_procedure
1699
- Update, retrieve, or activate an Integration Procedure.
1700
-
1701
- ---
1702
-
1703
- ### Calculation Matrix & Procedure
1704
-
1705
- #### sf_create_calculation_matrix
1706
- Creates a Calculation Matrix (decision table) for rule-based lookups.
1707
-
1708
- | Parameter | Type | Description |
1709
- |-----------|------|-------------|
1710
- | `matrixName` | string | Matrix API name |
1711
- | `inputVariables` | array | Input variable names |
1712
- | `outputVariables` | array | Output variable names |
1713
- | `rows` | array | `[{inputs:{var:val}, outputs:{var:val}}]` |
1714
-
1715
- #### sf_create_calculation_procedure
1716
- Creates a Calculation Procedure orchestrating multiple calculation steps.
1717
-
1718
- ---
1719
-
1720
- ### Export / Import
1721
-
1722
- #### sf_export_omnistudio_component
1723
- Exports any OmniStudio component's metadata as a JSON string.
1724
-
1725
- | Parameter | Type | Description |
1726
- |-----------|------|-------------|
1727
- | `componentType` | string | `FlexCard`, `OmniScript`, `DataRaptor`, `IntegrationProcedure`, `CalculationMatrix`, `CalculationProcedure` |
1728
- | `componentName` | string | Component API name / fullName |
1729
-
1730
- #### sf_import_omnistudio_component
1731
- Imports an OmniStudio component from previously exported JSON.
1732
-
1733
- | Parameter | Type | Description |
1734
- |-----------|------|-------------|
1735
- | `componentType` | string | Component type |
1736
- | `exportedJson` | string | JSON from `sf_export_omnistudio_component` |
1737
- | `newComponentName` | string | Optional new name (for renaming on import) |
1738
-
1739
- ---
1740
-
1741
- #### sf_create_document_generation
1742
- Creates an OmniStudio Document Generation template configuration.
1743
-
1744
- | Parameter | Type | Description |
1745
- |-----------|------|-------------|
1746
- | `templateName` | string | Config API name |
1747
- | `label` | string | Display label |
1748
- | `objectApiName` | string | Salesforce object to generate for |
1749
- | `templateType` | `Word\|PDF\|Excel` | Document format |
1750
- | `dataSourceType` | `DataRaptor\|IntegrationProcedure` | Data source type |
1751
- | `dataSourceName` | string | DataRaptor or IP API name |
1752
-
1753
- ---
1754
-
1755
- ## OmniChannel & Service
1756
-
1757
- ### sf_create_service_channel
1758
- Creates an OmniChannel Service Channel connecting an object to the routing engine.
1759
-
1760
- | Parameter | Type | Description |
1761
- |-----------|------|-------------|
1762
- | `channelName` | string | API name |
1763
- | `channelType` | string | `Case`, `Chat`, `Messaging`, `Voice`, `Email`, `Custom` |
1764
- | `relatedObjectApiName` | string | SObject to route (required for Custom) |
1765
- | `capacity` | number | Max simultaneous items per agent |
1766
-
1767
- ---
1768
-
1769
- ### sf_create_routing_configuration
1770
- Creates a Routing Configuration defining how work is assigned to agents.
1771
-
1772
- | Parameter | Type | Description |
1773
- |-----------|------|-------------|
1774
- | `configName` | string | API name |
1775
- | `routingModel` | string | `LeastActive`, `MostAvailable`, `ExternalRouting` |
1776
- | `capacity` | number | Capacity consumed per work item |
1777
- | `priority` | number | Routing priority (1=highest) |
1778
- | `pushTimeout` | number | Seconds before re-queuing unanswered items |
1779
-
1780
- ---
1781
-
1782
- ### sf_create_queue_routing_config
1783
- Links a Routing Configuration to a Queue.
1784
-
1785
- ---
1786
-
1787
- ### sf_create_presence_configuration
1788
- Creates a Presence Configuration controlling which channels agents can handle.
1789
-
1790
- | Parameter | Type | Description |
1791
- |-----------|------|-------------|
1792
- | `configName` | string | Config API name |
1793
- | `capacity` | number | Total capacity units |
1794
- | `serviceChannels` | array | Channel API names |
1795
-
1796
- ---
1797
-
1798
- ### sf_create_presence_status
1799
- Creates a Presence Status (Online, Busy, Offline) for agents.
1800
-
1801
- ---
1802
-
1803
- ### sf_assign_presence_status
1804
- Grants access to a Presence Status for Profiles and/or Permission Sets.
1805
-
1806
- ---
1807
-
1808
- ### sf_create_skill
1809
- Creates a Skill for OmniChannel skill-based routing or Field Service.
1810
-
1811
- ---
1812
-
1813
- ### sf_assign_skill_to_agent
1814
- Assigns a Skill to a service agent with a proficiency level.
1815
-
1816
- | Parameter | Type | Description |
1817
- |-----------|------|-------------|
1818
- | `skillName` | string | Skill DeveloperName |
1819
- | `username` | string | Agent username |
1820
- | `skillLevel` | number | Proficiency 0-10 |
1821
-
1822
- ---
1823
-
1824
- ### sf_create_service_territory
1825
- Creates a Field Service Service Territory (geographic/organizational area).
1826
-
1827
- ---
1828
-
1829
- ### sf_create_work_type
1830
- Creates a Field Service Work Type with default duration and skill requirements.
1831
-
1832
- ---
1833
-
1834
- ### sf_create_messaging_channel
1835
- Creates a digital messaging channel (SMS, WhatsApp, Facebook, etc.).
1836
-
1837
- | Parameter | Type | Description |
1838
- |-----------|------|-------------|
1839
- | `channelName` | string | API name |
1840
- | `channelType` | string | `SMS`, `WhatsApp`, `Facebook`, `AppleBusinessChat`, `WebChat`, etc. |
1841
- | `routingType` | `Queue\|Bot` | Routing destination |
1842
- | `queueName` | string | Queue to route to |
1843
- | `botName` | string | Bot to handle initially |
1844
-
1845
- ---
1846
-
1847
- ### sf_create_chat_button
1848
- Creates a Live Chat button for website embedding.
1849
-
1850
- ---
1851
-
1852
- ### sf_create_embedded_service
1853
- Creates an Embedded Service deployment bundling chat/messaging into a web snippet.
1854
-
1855
- ---
1856
-
1857
- ### sf_create_bot_routing
1858
- Configures an Einstein Bot to transfer conversations to a human agent queue.
1859
-
1860
- ---
1861
-
1862
- ## Audit Trail & Monitoring
1863
-
1864
- ### sf_get_setup_audit_trail
1865
- Queries `SetupAuditTrail` for org configuration change history (last 6 months).
1866
-
1867
- | Parameter | Type | Description |
1868
- |-----------|------|-------------|
1869
- | `limit` | number | Max records (default 50) |
1870
- | `userId` | string | Filter by user ID |
1871
- | `section` | string | Filter by Setup section |
1872
- | `lookbackDays` | number | Days to look back (default 7) |
1873
-
1874
- ---
1875
-
1876
- ### sf_get_login_history
1877
- Queries `LoginHistory` for user login activity.
1878
-
1879
- | Parameter | Type | Description |
1880
- |-----------|------|-------------|
1881
- | `username` | string | Filter by username |
1882
- | `lookbackHours` | number | Hours to look back (default 24) |
1883
- | `status` | string | `Success`, `Failed`, etc. |
1884
- | `limit` | number | Max records (default 100) |
1885
-
1886
- ---
1887
-
1888
- ### sf_get_event_logs
1889
- Fetches and parses `EventLogFile` entries (Login, API, Report, Flow, Apex, LightningPageView, etc.).
1890
-
1891
- | Parameter | Type | Description |
1892
- |-----------|------|-------------|
1893
- | `eventType` | string | Log type (e.g. `Login`, `ApexExecution`, `FlowExecution`) |
1894
- | `lookbackHours` | number | Hours to look back (default 24) |
1895
- | `limit` | number | Max files (default 10) |
1896
-
1897
- ---
1898
-
1899
- ### sf_get_field_history
1900
- Queries field-level change history on a specific record.
1901
-
1902
- | Parameter | Type | Description |
1903
- |-----------|------|-------------|
1904
- | `objectApiName` | string | Object with history tracking enabled |
1905
- | `recordId` | string | Record ID to get history for |
1906
- | `limit` | number | Max history entries (default 50) |
1907
-
1908
- ---
1909
-
1910
- ### sf_get_org_limits
1911
- Retrieves current API and governor limit usage via the Limits REST API.
1912
-
1913
- Returns all limits sorted by percent used (most consumed first).
1914
-
1915
- ---
1916
-
1917
- ### sf_get_flow_errors
1918
- Retrieves Flow interview fault records with error messages and related record IDs.
1919
-
1920
- | Parameter | Type | Description |
1921
- |-----------|------|-------------|
1922
- | `flowApiName` | string | Filter to specific flow (optional) |
1923
- | `lookbackHours` | number | Hours to look back (default 24) |
1924
- | `limit` | number | Max records (default 50) |
1925
-
1926
- ---
1927
-
1928
- ### sf_get_apex_test_results
1929
- Queries Apex test results from recent test runs via Tooling API.
1930
-
1931
- | Parameter | Type | Description |
1932
- |-----------|------|-------------|
1933
- | `className` | string | Filter by test class name (optional) |
1934
- | `outcome` | string | `Pass`, `Fail`, `Skip` (optional) |
1935
- | `limit` | number | Max results (default 100) |
1936
-
1937
- ---
1938
-
1939
- ### sf_get_deployment_history
1940
- Retrieves recent deployment history with status, component counts, and errors.
1941
-
1942
- | Parameter | Type | Description |
1943
- |-----------|------|-------------|
1944
- | `limit` | number | Deployments to return (default 20) |
1945
- | `status` | string | Filter: `Succeeded`, `Failed`, `Canceled`, `InProgress` |
1946
-
1947
- ---
1948
-
1949
- ## Admin & Org Management
1950
-
1951
- ### sf_create_user_role_hierarchy
1952
- Creates a UserRole in the Salesforce role hierarchy.
1953
-
1954
- | Parameter | Type | Description |
1955
- |-----------|------|-------------|
1956
- | `roleName` | string | Role DeveloperName |
1957
- | `label` | string | Display name |
1958
- | `parentRoleName` | string | Parent role API name (omit for top-level) |
1959
-
1960
- > Note: `sf_create_role` in Security also creates roles. `sf_create_user_role_hierarchy` is an alias with the same outcome.
1961
-
1962
- ---
1963
-
1964
- ### sf_reset_user_password
1965
- Resets a user's password and sends a password-reset email.
1966
-
1967
- | Parameter | Type | Description |
1968
- |-----------|------|-------------|
1969
- | `username` | string | User email/username |
1970
- | `userId` | string | User record ID (alternative) |
1971
- | `sendEmail` | boolean | Send reset email (default `true`) |
1972
-
1973
- ---
1974
-
1975
- ### sf_freeze_user
1976
- Freezes or unfreezes a user account (blocks login without deactivating).
1977
-
1978
- | Parameter | Type | Description |
1979
- |-----------|------|-------------|
1980
- | `username` | string | User to freeze |
1981
- | `freeze` | boolean | `true` to freeze, `false` to unfreeze |
1982
-
1983
- ---
1984
-
1985
- ### sf_create_territory
1986
- Creates an Enterprise Territory Management (ETM) Territory2.
1987
-
1988
- | Parameter | Type | Description |
1989
- |-----------|------|-------------|
1990
- | `territoryName` | string | Territory DeveloperName |
1991
- | `label` | string | Display name |
1992
- | `territoryType` | string | Territory2Type DeveloperName |
1993
- | `parentTerritoryName` | string | Parent territory (optional) |
1994
-
1995
- > Requires ETM enabled in the org.
1996
-
1997
- ---
1998
-
1999
- ### sf_assign_territory_to_user
2000
- Assigns a user to an ETM territory via `UserTerritory2Association`.
2001
-
2002
- | Parameter | Type | Description |
2003
- |-----------|------|-------------|
2004
- | `username` | string | User to assign |
2005
- | `territoryName` | string | Territory DeveloperName |
2006
- | `roleInTerritory` | string | `Salesperson`, `Manager`, `BusinessUser` |
2007
-
2008
- ---
2009
-
2010
- ### sf_create_forecast_hierarchy
2011
- Configures a Collaborative Forecasting hierarchy manager relationship.
2012
-
2013
- | Parameter | Type | Description |
2014
- |-----------|------|-------------|
2015
- | `managerUsername` | string | Forecast manager's username |
2016
- | `reporteeUsername` | string | Managed user's username |
2017
- | `forecastingType` | string | Forecasting type DeveloperName (e.g. `OpportunityRevenue`) |
2018
-
2019
- ---
2020
-
2021
- ## Einstein & AI
2022
-
2023
- ### sf_create_einstein_prediction
2024
- Creates an Einstein Prediction Builder definition (MLPredictionDefinition metadata).
2025
-
2026
- | Parameter | Type | Description |
2027
- |-----------|------|-------------|
2028
- | `predictionName` | string | API name |
2029
- | `label` | string | Display label |
2030
- | `objectApiName` | string | Object to predict on |
2031
- | `predictionType` | `BinaryClassification\|Regression` | Model type |
2032
- | `targetField` | string | Field to predict |
2033
- | `segmentField` | string | Optional segment filter field |
2034
-
2035
- ---
2036
-
2037
- ### sf_create_next_best_action
2038
- Creates a Next Best Action recommendation strategy (RecommendationStrategy metadata).
2039
-
2040
- | Parameter | Type | Description |
2041
- |-----------|------|-------------|
2042
- | `strategyName` | string | Strategy API name |
2043
- | `label` | string | Display label |
2044
- | `contextObjectName` | string | Object the strategy applies to |
2045
- | `recommendations` | array | `[{name, label, actionReference, acceptLabel, rejectLabel}]` |
2046
-
2047
- ---
2048
-
2049
- ### sf_create_einstein_bot
2050
- Creates a classic Einstein Bot with ML domain and conversation dialogs.
2051
-
2052
- | Parameter | Type | Description |
2053
- |-----------|------|-------------|
2054
- | `botName` | string | Bot API name |
2055
- | `label` | string | Display label |
2056
- | `description` | string | Bot description |
2057
- | `mlDomain` | string | Einstein ML domain name |
2058
- | `defaultLocale` | string | Language code (default `en_US`) |
2059
- | `welcomeMessage` | string | Greeting message |
2060
- | `dialogs` | array | Conversation dialogs |
2061
-
2062
- ---
2063
-
2064
- ## Reports & Dashboards
2065
-
2066
- ### sf_create_report
2067
- Creates a Salesforce Report (Tabular, Summary, Matrix, or Joined).
2068
-
2069
- | Parameter | Type | Description |
2070
- |-----------|------|-------------|
2071
- | `fullName` | string | `FolderName/ReportName` |
2072
- | `name` | string | Display name |
2073
- | `reportType` | string | Report type API name (e.g. `Accounts`, `Opportunities`) |
2074
- | `format` | string | `Tabular`, `Summary`, `Matrix`, `MultiBlock` |
2075
- | `columns` | array | Field API names to show |
2076
- | `filters` | array | `[{field, operator, value}]` |
2077
- | `groupingsRow` | array | Summary/Matrix row groupings |
2078
-
2079
- ---
2080
-
2081
- ### sf_update_dashboard
2082
- Updates an existing Dashboard's title or description.
2083
-
2084
- ---
2085
-
2086
- ### sf_create_report_folder
2087
- Creates a folder for organizing Reports or Dashboards.
2088
-
2089
- | Parameter | Type | Description |
2090
- |-----------|------|-------------|
2091
- | `name` | string | Folder API name |
2092
- | `label` | string | Display name |
2093
- | `accessType` | string | `Hidden`, `Shared`, `Public` |
2094
- | `folderType` | `Report\|Dashboard` | Folder type |
2095
-
2096
- ---
2097
-
2098
- ### sf_share_report_folder
2099
- Shares a Report or Dashboard folder with users, roles, or groups.
2100
-
2101
- | Parameter | Type | Description |
2102
- |-----------|------|-------------|
2103
- | `folderName` | string | Folder API name |
2104
- | `shares` | array | `[{sharedTo, sharedToType, accessLevel}]` — types: `User`, `Role`, `Group`; levels: `View`, `Edit`, `Manage` |
2105
-
2106
- ---
2107
-
2108
- ## MCP Server Generation
2109
-
2110
176
  ### sf_create_mcp_server
2111
177
  Generates a complete MCP server project on disk.
2112
178
 
179
+ **Parameters:**
2113
180
  | Parameter | Type | Description |
2114
181
  |-----------|------|-------------|
2115
- | `serverName` | string | NPM package name |
2116
- | `outputDirectory` | string | Absolute path for the project |
182
+ | `serverName` | string | Server package name |
183
+ | `outputDirectory` | string | Absolute path to output directory |
2117
184
  | `description` | string | Server description |
2118
185
  | `salesforceInstanceUrl` | string | Pre-configure org URL |
2119
186
 
2120
- **Example:** "Create a new MCP server called my-sf-integration in /home/user/projects/my-server"
187
+ **Example prompts:**
188
+ - "Create a new MCP server called my-sf-integration in C:/projects/my-server"
189
+ - "Generate a Salesforce MCP server project targeting https://myorg.salesforce.com"
2121
190
 
2122
191
  ---
2123
192
 
2124
- *See [README.md](README.md) for setup instructions, [CHANGELOG.md](CHANGELOG.md) for release notes, and [AGENTFORCE.md](AGENTFORCE.md) for Agentforce-specific guidance.*
193
+ *For the complete list of all 60+ tools, see [README.md](README.md).*