@salesforce/plugin-agent 2.2.2 → 2.2.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.
- package/README.md +41 -41
- package/lib/agentActivation.js +1 -1
- package/lib/agentActivation.js.map +1 -1
- package/lib/agentTestCache.d.ts +1 -1
- package/lib/agentTestCache.js +1 -1
- package/lib/agentTestCache.js.map +1 -1
- package/lib/commands/agent/generate/agent-spec.js +1 -1
- package/lib/commands/agent/generate/agent-spec.js.map +1 -1
- package/lib/commands/agent/generate/test-spec.js +2 -2
- package/lib/commands/agent/generate/test-spec.js.map +1 -1
- package/lib/commands/agent/mcp/create.js.map +1 -1
- package/lib/commands/agent/mcp/update.js +1 -4
- package/lib/commands/agent/mcp/update.js.map +1 -1
- package/lib/commands/agent/publish/authoring-bundle.js.map +1 -1
- package/lib/commands/agent/test/create.js +17 -14
- package/lib/commands/agent/test/create.js.map +1 -1
- package/lib/commands/agent/test/resume.js +1 -1
- package/lib/commands/agent/test/resume.js.map +1 -1
- package/lib/commands/agent/test/run-eval.js +1 -1
- package/lib/commands/agent/test/run-eval.js.map +1 -1
- package/lib/commands/agent/test/run.js.map +1 -1
- package/lib/commands/agent/trace/read.js.map +1 -1
- package/lib/components/agent-preview-react.js +4 -2
- package/lib/components/agent-preview-react.js.map +1 -1
- package/lib/flags.js +1 -1
- package/lib/flags.js.map +1 -1
- package/lib/handleTestResults.js +0 -4
- package/lib/handleTestResults.js.map +1 -1
- package/oclif.manifest.json +1678 -1678
- package/package.json +20 -11
package/oclif.manifest.json
CHANGED
|
@@ -426,13 +426,14 @@
|
|
|
426
426
|
"preview:agent"
|
|
427
427
|
]
|
|
428
428
|
},
|
|
429
|
-
"agent:
|
|
429
|
+
"agent:adl:create": {
|
|
430
430
|
"aliases": [],
|
|
431
431
|
"args": {},
|
|
432
|
-
"description": "
|
|
432
|
+
"description": "Creates a new data library in the target org. The --source-type flag determines the type of library: SFDRIVE (file upload), KNOWLEDGE (Salesforce Knowledge articles), or RETRIEVER (existing active Custom Retriever).\n\nFor SFDRIVE libraries, creation provisions the full Data Cloud pipeline (DLO → DMO → SearchIndex → Retriever). Upload files with `sf agent adl upload` after creation.",
|
|
433
433
|
"examples": [
|
|
434
|
-
"Create an
|
|
435
|
-
"Create
|
|
434
|
+
"Create an SFDRIVE library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"My Docs\" --developer-name My_Docs --source-type sfdrive",
|
|
435
|
+
"Create a KNOWLEDGE library with index fields:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"KB Library\" --developer-name KB_Library --source-type knowledge --primary-index-field1 Title --primary-index-field2 Summary",
|
|
436
|
+
"Create a RETRIEVER library:\n<%= config.bin %> <%= command.id %> --target-org myOrg --name \"Existing Retriever\" --developer-name Existing_Retriever --source-type retriever --retriever-id 0ppXX0000000001"
|
|
436
437
|
],
|
|
437
438
|
"flags": {
|
|
438
439
|
"json": {
|
|
@@ -471,109 +472,134 @@
|
|
|
471
472
|
"char": "n",
|
|
472
473
|
"name": "name",
|
|
473
474
|
"required": true,
|
|
474
|
-
"summary": "
|
|
475
|
+
"summary": "Display name for the data library (max 80 characters).",
|
|
475
476
|
"hasDynamicHelp": false,
|
|
476
477
|
"multiple": false,
|
|
477
478
|
"type": "option"
|
|
478
479
|
},
|
|
479
|
-
"
|
|
480
|
-
"name": "
|
|
481
|
-
"
|
|
480
|
+
"developer-name": {
|
|
481
|
+
"name": "developer-name",
|
|
482
|
+
"required": true,
|
|
483
|
+
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
482
484
|
"hasDynamicHelp": false,
|
|
483
485
|
"multiple": false,
|
|
484
486
|
"type": "option"
|
|
485
487
|
},
|
|
486
|
-
"
|
|
487
|
-
"name": "
|
|
488
|
-
"
|
|
488
|
+
"source-type": {
|
|
489
|
+
"name": "source-type",
|
|
490
|
+
"required": true,
|
|
491
|
+
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
489
492
|
"hasDynamicHelp": false,
|
|
490
493
|
"multiple": false,
|
|
494
|
+
"options": [
|
|
495
|
+
"sfdrive",
|
|
496
|
+
"knowledge",
|
|
497
|
+
"retriever"
|
|
498
|
+
],
|
|
491
499
|
"type": "option"
|
|
492
500
|
},
|
|
493
|
-
"
|
|
494
|
-
"name": "
|
|
495
|
-
"
|
|
496
|
-
"summary": "URL of the external MCP server.",
|
|
501
|
+
"description": {
|
|
502
|
+
"name": "description",
|
|
503
|
+
"summary": "Description of the data library (max 255 characters).",
|
|
497
504
|
"hasDynamicHelp": false,
|
|
498
505
|
"multiple": false,
|
|
499
506
|
"type": "option"
|
|
500
507
|
},
|
|
501
|
-
"
|
|
502
|
-
"name": "
|
|
503
|
-
"summary": "
|
|
504
|
-
"default": "NO_AUTH",
|
|
508
|
+
"index-mode": {
|
|
509
|
+
"name": "index-mode",
|
|
510
|
+
"summary": "Index mode for SFDRIVE libraries: basic or enhanced.",
|
|
505
511
|
"hasDynamicHelp": false,
|
|
506
512
|
"multiple": false,
|
|
507
513
|
"options": [
|
|
508
|
-
"
|
|
509
|
-
"
|
|
514
|
+
"basic",
|
|
515
|
+
"enhanced"
|
|
510
516
|
],
|
|
511
517
|
"type": "option"
|
|
512
518
|
},
|
|
513
|
-
"
|
|
514
|
-
"name": "
|
|
515
|
-
"summary": "
|
|
519
|
+
"retriever-id": {
|
|
520
|
+
"name": "retriever-id",
|
|
521
|
+
"summary": "ID of an active Custom Retriever (required for RETRIEVER source type; retriever must be active).",
|
|
516
522
|
"hasDynamicHelp": false,
|
|
517
523
|
"multiple": false,
|
|
518
524
|
"type": "option"
|
|
519
525
|
},
|
|
520
|
-
"
|
|
521
|
-
"name": "
|
|
522
|
-
"summary": "
|
|
526
|
+
"primary-index-field1": {
|
|
527
|
+
"name": "primary-index-field1",
|
|
528
|
+
"summary": "Primary index field 1 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
523
529
|
"hasDynamicHelp": false,
|
|
524
530
|
"multiple": false,
|
|
525
531
|
"type": "option"
|
|
526
532
|
},
|
|
527
|
-
"
|
|
528
|
-
"name": "
|
|
529
|
-
"summary": "
|
|
533
|
+
"primary-index-field2": {
|
|
534
|
+
"name": "primary-index-field2",
|
|
535
|
+
"summary": "Primary index field 2 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
530
536
|
"hasDynamicHelp": false,
|
|
531
537
|
"multiple": false,
|
|
532
538
|
"type": "option"
|
|
533
539
|
},
|
|
534
|
-
"
|
|
535
|
-
"name": "
|
|
536
|
-
"summary": "
|
|
540
|
+
"content-fields": {
|
|
541
|
+
"name": "content-fields",
|
|
542
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
543
|
+
"hasDynamicHelp": false,
|
|
544
|
+
"multiple": false,
|
|
545
|
+
"type": "option"
|
|
546
|
+
},
|
|
547
|
+
"data-category-ids": {
|
|
548
|
+
"name": "data-category-ids",
|
|
549
|
+
"summary": "Comma-separated list of data category selection IDs for KNOWLEDGE libraries. Mutually exclusive with --data-category-names (provide one or the other, not both).",
|
|
550
|
+
"hasDynamicHelp": false,
|
|
551
|
+
"multiple": false,
|
|
552
|
+
"type": "option"
|
|
553
|
+
},
|
|
554
|
+
"data-category-names": {
|
|
555
|
+
"name": "data-category-names",
|
|
556
|
+
"summary": "Comma-separated list of data category names in qualified format (e.g., \"Group_API_Name.Category\"). Mutually exclusive with --data-category-ids (provide one or the other, not both).",
|
|
537
557
|
"hasDynamicHelp": false,
|
|
538
558
|
"multiple": false,
|
|
539
559
|
"type": "option"
|
|
560
|
+
},
|
|
561
|
+
"wait": {
|
|
562
|
+
"char": "w",
|
|
563
|
+
"name": "wait",
|
|
564
|
+
"summary": "Wait N minutes for indexing to complete (KNOWLEDGE libraries). SFDRIVE libraries require upload before indexing; RETRIEVER libraries are ready immediately.",
|
|
565
|
+
"hasDynamicHelp": true,
|
|
566
|
+
"multiple": false,
|
|
567
|
+
"type": "option"
|
|
540
568
|
}
|
|
541
569
|
},
|
|
542
570
|
"hasDynamicHelp": true,
|
|
543
571
|
"hiddenAliases": [],
|
|
544
|
-
"id": "agent:
|
|
572
|
+
"id": "agent:adl:create",
|
|
545
573
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
546
574
|
"pluginName": "@salesforce/plugin-agent",
|
|
547
575
|
"pluginType": "core",
|
|
548
|
-
"state": "preview",
|
|
549
576
|
"strict": true,
|
|
550
|
-
"summary": "Create an
|
|
577
|
+
"summary": "Create an Agentforce Data Library.",
|
|
551
578
|
"enableJsonFlag": true,
|
|
552
579
|
"isESM": true,
|
|
553
580
|
"relativePath": [
|
|
554
581
|
"lib",
|
|
555
582
|
"commands",
|
|
556
583
|
"agent",
|
|
557
|
-
"
|
|
584
|
+
"adl",
|
|
558
585
|
"create.js"
|
|
559
586
|
],
|
|
560
587
|
"aliasPermutations": [],
|
|
561
588
|
"permutations": [
|
|
562
|
-
"agent:
|
|
563
|
-
"
|
|
564
|
-
"
|
|
565
|
-
"agent:create:
|
|
566
|
-
"create:agent:
|
|
567
|
-
"create:
|
|
589
|
+
"agent:adl:create",
|
|
590
|
+
"adl:agent:create",
|
|
591
|
+
"adl:create:agent",
|
|
592
|
+
"agent:create:adl",
|
|
593
|
+
"create:agent:adl",
|
|
594
|
+
"create:adl:agent"
|
|
568
595
|
]
|
|
569
596
|
},
|
|
570
|
-
"agent:
|
|
597
|
+
"agent:adl:delete": {
|
|
571
598
|
"aliases": [],
|
|
572
599
|
"args": {},
|
|
573
|
-
"description": "Permanently
|
|
600
|
+
"description": "Permanently deletes a data library and all associated files and indexing data.",
|
|
574
601
|
"examples": [
|
|
575
|
-
"Delete
|
|
576
|
-
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
602
|
+
"Delete a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
577
603
|
],
|
|
578
604
|
"flags": {
|
|
579
605
|
"json": {
|
|
@@ -608,57 +634,49 @@
|
|
|
608
634
|
"multiple": false,
|
|
609
635
|
"type": "option"
|
|
610
636
|
},
|
|
611
|
-
"
|
|
637
|
+
"library-id": {
|
|
612
638
|
"char": "i",
|
|
613
|
-
"name": "
|
|
639
|
+
"name": "library-id",
|
|
614
640
|
"required": true,
|
|
615
|
-
"summary": "ID
|
|
641
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
616
642
|
"hasDynamicHelp": false,
|
|
617
643
|
"multiple": false,
|
|
618
644
|
"type": "option"
|
|
619
|
-
},
|
|
620
|
-
"no-prompt": {
|
|
621
|
-
"name": "no-prompt",
|
|
622
|
-
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
623
|
-
"allowNo": false,
|
|
624
|
-
"type": "boolean"
|
|
625
645
|
}
|
|
626
646
|
},
|
|
627
647
|
"hasDynamicHelp": true,
|
|
628
648
|
"hiddenAliases": [],
|
|
629
|
-
"id": "agent:
|
|
649
|
+
"id": "agent:adl:delete",
|
|
630
650
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
631
651
|
"pluginName": "@salesforce/plugin-agent",
|
|
632
652
|
"pluginType": "core",
|
|
633
|
-
"state": "preview",
|
|
634
653
|
"strict": true,
|
|
635
|
-
"summary": "Delete an
|
|
654
|
+
"summary": "Delete an Agentforce Data Library.",
|
|
636
655
|
"enableJsonFlag": true,
|
|
637
656
|
"isESM": true,
|
|
638
657
|
"relativePath": [
|
|
639
658
|
"lib",
|
|
640
659
|
"commands",
|
|
641
660
|
"agent",
|
|
642
|
-
"
|
|
661
|
+
"adl",
|
|
643
662
|
"delete.js"
|
|
644
663
|
],
|
|
645
664
|
"aliasPermutations": [],
|
|
646
665
|
"permutations": [
|
|
647
|
-
"agent:
|
|
648
|
-
"
|
|
649
|
-
"
|
|
650
|
-
"agent:delete:
|
|
651
|
-
"delete:agent:
|
|
652
|
-
"delete:
|
|
666
|
+
"agent:adl:delete",
|
|
667
|
+
"adl:agent:delete",
|
|
668
|
+
"adl:delete:agent",
|
|
669
|
+
"agent:delete:adl",
|
|
670
|
+
"delete:agent:adl",
|
|
671
|
+
"delete:adl:agent"
|
|
653
672
|
]
|
|
654
673
|
},
|
|
655
|
-
"agent:
|
|
674
|
+
"agent:adl:get": {
|
|
656
675
|
"aliases": [],
|
|
657
676
|
"args": {},
|
|
658
|
-
"description": "
|
|
677
|
+
"description": "Returns the full detail of a data library including its grounding source configuration, status, and retriever ID.",
|
|
659
678
|
"examples": [
|
|
660
|
-
"
|
|
661
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
679
|
+
"Get details of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
662
680
|
],
|
|
663
681
|
"flags": {
|
|
664
682
|
"json": {
|
|
@@ -693,11 +711,11 @@
|
|
|
693
711
|
"multiple": false,
|
|
694
712
|
"type": "option"
|
|
695
713
|
},
|
|
696
|
-
"
|
|
714
|
+
"library-id": {
|
|
697
715
|
"char": "i",
|
|
698
|
-
"name": "
|
|
716
|
+
"name": "library-id",
|
|
699
717
|
"required": true,
|
|
700
|
-
"summary": "
|
|
718
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
701
719
|
"hasDynamicHelp": false,
|
|
702
720
|
"multiple": false,
|
|
703
721
|
"type": "option"
|
|
@@ -705,39 +723,38 @@
|
|
|
705
723
|
},
|
|
706
724
|
"hasDynamicHelp": true,
|
|
707
725
|
"hiddenAliases": [],
|
|
708
|
-
"id": "agent:
|
|
726
|
+
"id": "agent:adl:get",
|
|
709
727
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
710
728
|
"pluginName": "@salesforce/plugin-agent",
|
|
711
729
|
"pluginType": "core",
|
|
712
|
-
"state": "preview",
|
|
713
730
|
"strict": true,
|
|
714
|
-
"summary": "
|
|
731
|
+
"summary": "Get details of an Agentforce Data Library.",
|
|
715
732
|
"enableJsonFlag": true,
|
|
716
733
|
"isESM": true,
|
|
717
734
|
"relativePath": [
|
|
718
735
|
"lib",
|
|
719
736
|
"commands",
|
|
720
737
|
"agent",
|
|
721
|
-
"
|
|
722
|
-
"
|
|
738
|
+
"adl",
|
|
739
|
+
"get.js"
|
|
723
740
|
],
|
|
724
741
|
"aliasPermutations": [],
|
|
725
742
|
"permutations": [
|
|
726
|
-
"agent:
|
|
727
|
-
"
|
|
728
|
-
"
|
|
729
|
-
"agent:
|
|
730
|
-
"
|
|
731
|
-
"
|
|
743
|
+
"agent:adl:get",
|
|
744
|
+
"adl:agent:get",
|
|
745
|
+
"adl:get:agent",
|
|
746
|
+
"agent:get:adl",
|
|
747
|
+
"get:agent:adl",
|
|
748
|
+
"get:adl:agent"
|
|
732
749
|
]
|
|
733
750
|
},
|
|
734
|
-
"agent:
|
|
751
|
+
"agent:adl:list": {
|
|
735
752
|
"aliases": [],
|
|
736
753
|
"args": {},
|
|
737
|
-
"description": "
|
|
754
|
+
"description": "Returns all data libraries in the target org, including their source type, status, and library ID.",
|
|
738
755
|
"examples": [
|
|
739
|
-
"
|
|
740
|
-
"
|
|
756
|
+
"List all data libraries in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
757
|
+
"List data libraries and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --json"
|
|
741
758
|
],
|
|
742
759
|
"flags": {
|
|
743
760
|
"json": {
|
|
@@ -772,51 +789,52 @@
|
|
|
772
789
|
"multiple": false,
|
|
773
790
|
"type": "option"
|
|
774
791
|
},
|
|
775
|
-
"
|
|
776
|
-
"
|
|
777
|
-
"
|
|
778
|
-
"required": true,
|
|
779
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
792
|
+
"source-type": {
|
|
793
|
+
"name": "source-type",
|
|
794
|
+
"summary": "Filter by source type: sfdrive, knowledge, or retriever.",
|
|
780
795
|
"hasDynamicHelp": false,
|
|
781
796
|
"multiple": false,
|
|
797
|
+
"options": [
|
|
798
|
+
"sfdrive",
|
|
799
|
+
"knowledge",
|
|
800
|
+
"retriever"
|
|
801
|
+
],
|
|
782
802
|
"type": "option"
|
|
783
803
|
}
|
|
784
804
|
},
|
|
785
805
|
"hasDynamicHelp": true,
|
|
786
806
|
"hiddenAliases": [],
|
|
787
|
-
"id": "agent:
|
|
807
|
+
"id": "agent:adl:list",
|
|
788
808
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
789
809
|
"pluginName": "@salesforce/plugin-agent",
|
|
790
810
|
"pluginType": "core",
|
|
791
|
-
"state": "preview",
|
|
792
811
|
"strict": true,
|
|
793
|
-
"summary": "
|
|
812
|
+
"summary": "List Agentforce Data Libraries in an org.",
|
|
794
813
|
"enableJsonFlag": true,
|
|
795
814
|
"isESM": true,
|
|
796
815
|
"relativePath": [
|
|
797
816
|
"lib",
|
|
798
817
|
"commands",
|
|
799
818
|
"agent",
|
|
800
|
-
"
|
|
801
|
-
"
|
|
819
|
+
"adl",
|
|
820
|
+
"list.js"
|
|
802
821
|
],
|
|
803
822
|
"aliasPermutations": [],
|
|
804
823
|
"permutations": [
|
|
805
|
-
"agent:
|
|
806
|
-
"
|
|
807
|
-
"
|
|
808
|
-
"agent:
|
|
809
|
-
"
|
|
810
|
-
"
|
|
824
|
+
"agent:adl:list",
|
|
825
|
+
"adl:agent:list",
|
|
826
|
+
"adl:list:agent",
|
|
827
|
+
"agent:list:adl",
|
|
828
|
+
"list:agent:adl",
|
|
829
|
+
"list:adl:agent"
|
|
811
830
|
]
|
|
812
831
|
},
|
|
813
|
-
"agent:
|
|
832
|
+
"agent:adl:status": {
|
|
814
833
|
"aliases": [],
|
|
815
834
|
"args": {},
|
|
816
|
-
"description": "Returns the
|
|
835
|
+
"description": "Returns the current indexing status including stage details (DATA_STREAM, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER) and any errors.",
|
|
817
836
|
"examples": [
|
|
818
|
-
"
|
|
819
|
-
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
837
|
+
"Get status of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --target-org myOrg"
|
|
820
838
|
],
|
|
821
839
|
"flags": {
|
|
822
840
|
"json": {
|
|
@@ -851,70 +869,58 @@
|
|
|
851
869
|
"multiple": false,
|
|
852
870
|
"type": "option"
|
|
853
871
|
},
|
|
854
|
-
"
|
|
855
|
-
"
|
|
856
|
-
"
|
|
857
|
-
"
|
|
858
|
-
"
|
|
859
|
-
"type": "option"
|
|
860
|
-
},
|
|
861
|
-
"type": {
|
|
862
|
-
"name": "type",
|
|
863
|
-
"summary": "Filter the MCP servers by type.",
|
|
872
|
+
"library-id": {
|
|
873
|
+
"char": "i",
|
|
874
|
+
"name": "library-id",
|
|
875
|
+
"required": true,
|
|
876
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
864
877
|
"hasDynamicHelp": false,
|
|
865
878
|
"multiple": false,
|
|
866
|
-
"options": [
|
|
867
|
-
"EXTERNAL"
|
|
868
|
-
],
|
|
869
879
|
"type": "option"
|
|
870
880
|
},
|
|
871
|
-
"
|
|
872
|
-
"name": "
|
|
873
|
-
"summary": "
|
|
874
|
-
"
|
|
875
|
-
"
|
|
876
|
-
"options": [
|
|
877
|
-
"ACTIVE",
|
|
878
|
-
"DISCONNECTED"
|
|
879
|
-
],
|
|
880
|
-
"type": "option"
|
|
881
|
+
"include-artifacts": {
|
|
882
|
+
"name": "include-artifacts",
|
|
883
|
+
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
884
|
+
"allowNo": false,
|
|
885
|
+
"type": "boolean"
|
|
881
886
|
}
|
|
882
887
|
},
|
|
883
888
|
"hasDynamicHelp": true,
|
|
884
889
|
"hiddenAliases": [],
|
|
885
|
-
"id": "agent:
|
|
890
|
+
"id": "agent:adl:status",
|
|
886
891
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
887
892
|
"pluginName": "@salesforce/plugin-agent",
|
|
888
893
|
"pluginType": "core",
|
|
889
|
-
"state": "preview",
|
|
890
894
|
"strict": true,
|
|
891
|
-
"summary": "
|
|
895
|
+
"summary": "Get indexing status of an Agentforce Data Library.",
|
|
892
896
|
"enableJsonFlag": true,
|
|
893
897
|
"isESM": true,
|
|
894
898
|
"relativePath": [
|
|
895
899
|
"lib",
|
|
896
900
|
"commands",
|
|
897
901
|
"agent",
|
|
898
|
-
"
|
|
899
|
-
"
|
|
902
|
+
"adl",
|
|
903
|
+
"status.js"
|
|
900
904
|
],
|
|
901
905
|
"aliasPermutations": [],
|
|
902
906
|
"permutations": [
|
|
903
|
-
"agent:
|
|
904
|
-
"
|
|
905
|
-
"
|
|
906
|
-
"agent:
|
|
907
|
-
"
|
|
908
|
-
"
|
|
907
|
+
"agent:adl:status",
|
|
908
|
+
"adl:agent:status",
|
|
909
|
+
"adl:status:agent",
|
|
910
|
+
"agent:status:adl",
|
|
911
|
+
"status:agent:adl",
|
|
912
|
+
"status:adl:agent"
|
|
909
913
|
]
|
|
910
914
|
},
|
|
911
|
-
"agent:
|
|
915
|
+
"agent:adl:update": {
|
|
912
916
|
"aliases": [],
|
|
913
917
|
"args": {},
|
|
914
|
-
"description": "Updates
|
|
918
|
+
"description": "Updates the label, description, or other mutable properties of an existing data library.",
|
|
915
919
|
"examples": [
|
|
916
|
-
"Update the label
|
|
917
|
-
"Update the
|
|
920
|
+
"Update the label of a data library:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --name \"New Name\" --target-org myOrg",
|
|
921
|
+
"Update the description:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --description \"Updated description\" --target-org myOrg",
|
|
922
|
+
"Update Knowledge library content fields (triggers re-indexing):\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --content-fields \"Answer**c,Summary**c\" --target-org myOrg",
|
|
923
|
+
"Restrict Knowledge library to public articles:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg"
|
|
918
924
|
],
|
|
919
925
|
"flags": {
|
|
920
926
|
"json": {
|
|
@@ -949,102 +955,177 @@
|
|
|
949
955
|
"multiple": false,
|
|
950
956
|
"type": "option"
|
|
951
957
|
},
|
|
952
|
-
"
|
|
958
|
+
"library-id": {
|
|
953
959
|
"char": "i",
|
|
954
|
-
"name": "
|
|
960
|
+
"name": "library-id",
|
|
955
961
|
"required": true,
|
|
956
|
-
"summary": "ID
|
|
962
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
957
963
|
"hasDynamicHelp": false,
|
|
958
964
|
"multiple": false,
|
|
959
965
|
"type": "option"
|
|
960
966
|
},
|
|
961
|
-
"
|
|
962
|
-
"
|
|
963
|
-
"
|
|
967
|
+
"name": {
|
|
968
|
+
"char": "n",
|
|
969
|
+
"name": "name",
|
|
970
|
+
"summary": "New display name for the data library (max 80 characters).",
|
|
964
971
|
"hasDynamicHelp": false,
|
|
965
972
|
"multiple": false,
|
|
966
973
|
"type": "option"
|
|
967
974
|
},
|
|
968
975
|
"description": {
|
|
969
976
|
"name": "description",
|
|
970
|
-
"summary": "New description for the
|
|
977
|
+
"summary": "New description for the data library (max 255 characters).",
|
|
971
978
|
"hasDynamicHelp": false,
|
|
972
979
|
"multiple": false,
|
|
973
980
|
"type": "option"
|
|
974
981
|
},
|
|
975
|
-
"
|
|
976
|
-
"name": "
|
|
977
|
-
"summary": "
|
|
982
|
+
"content-fields": {
|
|
983
|
+
"name": "content-fields",
|
|
984
|
+
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (triggers re-indexing).",
|
|
978
985
|
"hasDynamicHelp": false,
|
|
979
986
|
"multiple": false,
|
|
980
987
|
"type": "option"
|
|
981
988
|
},
|
|
982
|
-
"
|
|
983
|
-
"name": "
|
|
984
|
-
"summary": "
|
|
989
|
+
"restrict-to-public-articles": {
|
|
990
|
+
"name": "restrict-to-public-articles",
|
|
991
|
+
"summary": "Restrict to public Knowledge articles only (KNOWLEDGE libraries, triggers re-indexing).",
|
|
992
|
+
"allowNo": true,
|
|
993
|
+
"type": "boolean"
|
|
994
|
+
},
|
|
995
|
+
"data-category-rule": {
|
|
996
|
+
"name": "data-category-rule",
|
|
997
|
+
"summary": "Enable or disable data category filtering for KNOWLEDGE libraries. Use --no-data-category-rule to disable.",
|
|
998
|
+
"allowNo": true,
|
|
999
|
+
"type": "boolean"
|
|
1000
|
+
},
|
|
1001
|
+
"retriever-id": {
|
|
1002
|
+
"name": "retriever-id",
|
|
1003
|
+
"summary": "Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).",
|
|
985
1004
|
"hasDynamicHelp": false,
|
|
986
1005
|
"multiple": false,
|
|
987
|
-
"options": [
|
|
988
|
-
"OAUTH",
|
|
989
|
-
"NO_AUTH"
|
|
990
|
-
],
|
|
991
1006
|
"type": "option"
|
|
1007
|
+
}
|
|
1008
|
+
},
|
|
1009
|
+
"hasDynamicHelp": true,
|
|
1010
|
+
"hiddenAliases": [],
|
|
1011
|
+
"id": "agent:adl:update",
|
|
1012
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1013
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1014
|
+
"pluginType": "core",
|
|
1015
|
+
"strict": true,
|
|
1016
|
+
"summary": "Update an Agentforce Data Library.",
|
|
1017
|
+
"enableJsonFlag": true,
|
|
1018
|
+
"isESM": true,
|
|
1019
|
+
"relativePath": [
|
|
1020
|
+
"lib",
|
|
1021
|
+
"commands",
|
|
1022
|
+
"agent",
|
|
1023
|
+
"adl",
|
|
1024
|
+
"update.js"
|
|
1025
|
+
],
|
|
1026
|
+
"aliasPermutations": [],
|
|
1027
|
+
"permutations": [
|
|
1028
|
+
"agent:adl:update",
|
|
1029
|
+
"adl:agent:update",
|
|
1030
|
+
"adl:update:agent",
|
|
1031
|
+
"agent:update:adl",
|
|
1032
|
+
"update:agent:adl",
|
|
1033
|
+
"update:adl:agent"
|
|
1034
|
+
]
|
|
1035
|
+
},
|
|
1036
|
+
"agent:adl:upload": {
|
|
1037
|
+
"aliases": [],
|
|
1038
|
+
"args": {},
|
|
1039
|
+
"description": "Performs the multi-step upload workflow: checks upload readiness, obtains a pre-signed S3 URL, uploads the file, triggers indexing, and optionally polls until the library is ready (retrieverId is populated).\n\nUpload triggers the full Data Cloud provisioning pipeline, creating all downstream assets (DLO, DMO, SearchIndex, Retriever). Use `sf agent adl status` to monitor progress. For adding files to an already-provisioned library, use `sf agent adl file add` instead.\n\nThis command only works with SFDRIVE libraries. KNOWLEDGE libraries index automatically after creation, and RETRIEVER libraries require no file upload.",
|
|
1040
|
+
"examples": [
|
|
1041
|
+
"Upload a file and wait for indexing to complete:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg --wait 10",
|
|
1042
|
+
"Upload a file without waiting:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg"
|
|
1043
|
+
],
|
|
1044
|
+
"flags": {
|
|
1045
|
+
"json": {
|
|
1046
|
+
"description": "Format output as json.",
|
|
1047
|
+
"helpGroup": "GLOBAL",
|
|
1048
|
+
"name": "json",
|
|
1049
|
+
"allowNo": false,
|
|
1050
|
+
"type": "boolean"
|
|
992
1051
|
},
|
|
993
|
-
"
|
|
994
|
-
"
|
|
995
|
-
"
|
|
1052
|
+
"flags-dir": {
|
|
1053
|
+
"helpGroup": "GLOBAL",
|
|
1054
|
+
"name": "flags-dir",
|
|
1055
|
+
"summary": "Import flag values from a directory.",
|
|
996
1056
|
"hasDynamicHelp": false,
|
|
997
1057
|
"multiple": false,
|
|
998
1058
|
"type": "option"
|
|
999
1059
|
},
|
|
1000
|
-
"
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1060
|
+
"target-org": {
|
|
1061
|
+
"char": "o",
|
|
1062
|
+
"name": "target-org",
|
|
1063
|
+
"noCacheDefault": true,
|
|
1064
|
+
"required": true,
|
|
1065
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1066
|
+
"hasDynamicHelp": true,
|
|
1067
|
+
"multiple": false,
|
|
1068
|
+
"type": "option"
|
|
1069
|
+
},
|
|
1070
|
+
"api-version": {
|
|
1071
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1072
|
+
"name": "api-version",
|
|
1003
1073
|
"hasDynamicHelp": false,
|
|
1004
1074
|
"multiple": false,
|
|
1005
1075
|
"type": "option"
|
|
1006
1076
|
},
|
|
1007
|
-
"
|
|
1008
|
-
"
|
|
1009
|
-
"
|
|
1077
|
+
"library-id": {
|
|
1078
|
+
"char": "i",
|
|
1079
|
+
"name": "library-id",
|
|
1080
|
+
"required": true,
|
|
1081
|
+
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
1010
1082
|
"hasDynamicHelp": false,
|
|
1011
1083
|
"multiple": false,
|
|
1012
1084
|
"type": "option"
|
|
1013
1085
|
},
|
|
1014
|
-
"
|
|
1015
|
-
"
|
|
1016
|
-
"
|
|
1086
|
+
"file": {
|
|
1087
|
+
"char": "f",
|
|
1088
|
+
"name": "file",
|
|
1089
|
+
"required": true,
|
|
1090
|
+
"summary": "Path to the file to upload.",
|
|
1017
1091
|
"hasDynamicHelp": false,
|
|
1092
|
+
"multiple": true,
|
|
1093
|
+
"type": "option"
|
|
1094
|
+
},
|
|
1095
|
+
"wait": {
|
|
1096
|
+
"char": "w",
|
|
1097
|
+
"name": "wait",
|
|
1098
|
+
"summary": "Number of minutes to wait for indexing to complete. If not specified, returns after triggering indexing.",
|
|
1099
|
+
"hasDynamicHelp": true,
|
|
1018
1100
|
"multiple": false,
|
|
1019
1101
|
"type": "option"
|
|
1020
1102
|
}
|
|
1021
1103
|
},
|
|
1022
1104
|
"hasDynamicHelp": true,
|
|
1023
1105
|
"hiddenAliases": [],
|
|
1024
|
-
"id": "agent:
|
|
1106
|
+
"id": "agent:adl:upload",
|
|
1025
1107
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1026
1108
|
"pluginName": "@salesforce/plugin-agent",
|
|
1027
1109
|
"pluginType": "core",
|
|
1028
|
-
"state": "preview",
|
|
1029
1110
|
"strict": true,
|
|
1030
|
-
"summary": "
|
|
1111
|
+
"summary": "Upload a file to an SFDRIVE Agentforce Data Library.",
|
|
1031
1112
|
"enableJsonFlag": true,
|
|
1032
1113
|
"isESM": true,
|
|
1033
1114
|
"relativePath": [
|
|
1034
1115
|
"lib",
|
|
1035
1116
|
"commands",
|
|
1036
1117
|
"agent",
|
|
1037
|
-
"
|
|
1038
|
-
"
|
|
1118
|
+
"adl",
|
|
1119
|
+
"upload.js"
|
|
1039
1120
|
],
|
|
1040
1121
|
"aliasPermutations": [],
|
|
1041
1122
|
"permutations": [
|
|
1042
|
-
"agent:
|
|
1043
|
-
"
|
|
1044
|
-
"
|
|
1045
|
-
"agent:
|
|
1046
|
-
"
|
|
1047
|
-
"
|
|
1123
|
+
"agent:adl:upload",
|
|
1124
|
+
"adl:agent:upload",
|
|
1125
|
+
"adl:upload:agent",
|
|
1126
|
+
"agent:upload:adl",
|
|
1127
|
+
"upload:agent:adl",
|
|
1128
|
+
"upload:adl:agent"
|
|
1048
1129
|
]
|
|
1049
1130
|
},
|
|
1050
1131
|
"agent:generate:agent-spec": {
|
|
@@ -1531,16 +1612,13 @@
|
|
|
1531
1612
|
"test-spec:generate:agent"
|
|
1532
1613
|
]
|
|
1533
1614
|
},
|
|
1534
|
-
"agent:
|
|
1615
|
+
"agent:mcp:create": {
|
|
1535
1616
|
"aliases": [],
|
|
1536
1617
|
"args": {},
|
|
1537
|
-
"description": "
|
|
1618
|
+
"description": "Registers an external Model Context Protocol (MCP) server with the API Catalog and discovers its assets (tools, prompts, and resources). Provide the server URL and, when the server requires it, OAuth authorization details. When the authorization type is OAUTH you must supply the identity provider, client ID, client secret, and scope.",
|
|
1538
1619
|
"examples": [
|
|
1539
|
-
"
|
|
1540
|
-
"
|
|
1541
|
-
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
1542
|
-
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
1543
|
-
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
1620
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1621
|
+
"Create an MCP server that uses OAuth authentication, piping the client secret from stdin to keep it out of shell history:\ncat secret.txt | <%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --auth-type OAUTH --identity-provider myIdp --client-id abc123 --client-secret - --scope \"read write\" --target-org myOrg"
|
|
1544
1622
|
],
|
|
1545
1623
|
"flags": {
|
|
1546
1624
|
"json": {
|
|
@@ -1575,616 +1653,113 @@
|
|
|
1575
1653
|
"multiple": false,
|
|
1576
1654
|
"type": "option"
|
|
1577
1655
|
},
|
|
1578
|
-
"
|
|
1579
|
-
"
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
"
|
|
1583
|
-
"required": false,
|
|
1584
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
1656
|
+
"name": {
|
|
1657
|
+
"char": "n",
|
|
1658
|
+
"name": "name",
|
|
1659
|
+
"required": true,
|
|
1660
|
+
"summary": "Unique name of the MCP server.",
|
|
1585
1661
|
"hasDynamicHelp": false,
|
|
1586
1662
|
"multiple": false,
|
|
1587
1663
|
"type": "option"
|
|
1588
1664
|
},
|
|
1589
|
-
"
|
|
1590
|
-
"
|
|
1591
|
-
"
|
|
1592
|
-
"authoring-bundle"
|
|
1593
|
-
],
|
|
1594
|
-
"name": "api-name",
|
|
1595
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1665
|
+
"label": {
|
|
1666
|
+
"name": "label",
|
|
1667
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1596
1668
|
"hasDynamicHelp": false,
|
|
1597
1669
|
"multiple": false,
|
|
1598
1670
|
"type": "option"
|
|
1599
1671
|
},
|
|
1600
|
-
"
|
|
1601
|
-
"
|
|
1602
|
-
|
|
1603
|
-
],
|
|
1604
|
-
"name": "authoring-bundle",
|
|
1605
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1672
|
+
"description": {
|
|
1673
|
+
"name": "description",
|
|
1674
|
+
"summary": "Description of the MCP server.",
|
|
1606
1675
|
"hasDynamicHelp": false,
|
|
1607
1676
|
"multiple": false,
|
|
1608
1677
|
"type": "option"
|
|
1609
1678
|
},
|
|
1610
|
-
"
|
|
1611
|
-
"
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
"
|
|
1615
|
-
"
|
|
1616
|
-
"
|
|
1617
|
-
"type": "boolean"
|
|
1679
|
+
"server-url": {
|
|
1680
|
+
"name": "server-url",
|
|
1681
|
+
"required": true,
|
|
1682
|
+
"summary": "URL of the external MCP server.",
|
|
1683
|
+
"hasDynamicHelp": false,
|
|
1684
|
+
"multiple": false,
|
|
1685
|
+
"type": "option"
|
|
1618
1686
|
},
|
|
1619
|
-
"
|
|
1620
|
-
"
|
|
1621
|
-
"
|
|
1622
|
-
"
|
|
1623
|
-
"allowNo": false,
|
|
1624
|
-
"type": "boolean"
|
|
1625
|
-
}
|
|
1626
|
-
},
|
|
1627
|
-
"hasDynamicHelp": true,
|
|
1628
|
-
"hiddenAliases": [],
|
|
1629
|
-
"id": "agent:preview:end",
|
|
1630
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1631
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1632
|
-
"pluginType": "core",
|
|
1633
|
-
"strict": true,
|
|
1634
|
-
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1635
|
-
"enableJsonFlag": true,
|
|
1636
|
-
"requiresProject": true,
|
|
1637
|
-
"envVariablesSection": {
|
|
1638
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1639
|
-
"body": [
|
|
1640
|
-
{
|
|
1641
|
-
"name": "SF_TARGET_ORG",
|
|
1642
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1643
|
-
}
|
|
1644
|
-
]
|
|
1645
|
-
},
|
|
1646
|
-
"errorCodes": {
|
|
1647
|
-
"header": "ERROR CODES",
|
|
1648
|
-
"body": [
|
|
1649
|
-
{
|
|
1650
|
-
"name": "Succeeded (0)",
|
|
1651
|
-
"description": "Preview session ended successfully and traces saved."
|
|
1652
|
-
},
|
|
1653
|
-
{
|
|
1654
|
-
"name": "ExactlyOneRequired (2)",
|
|
1655
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1656
|
-
},
|
|
1657
|
-
{
|
|
1658
|
-
"name": "NotFound (2)",
|
|
1659
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
1660
|
-
},
|
|
1661
|
-
{
|
|
1662
|
-
"name": "PreviewEndFailed (4)",
|
|
1663
|
-
"description": "Failed to end the preview session."
|
|
1664
|
-
},
|
|
1665
|
-
{
|
|
1666
|
-
"name": "PreviewEndPartialFailure (68)",
|
|
1667
|
-
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1668
|
-
},
|
|
1669
|
-
{
|
|
1670
|
-
"name": "SessionAmbiguous (5)",
|
|
1671
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1672
|
-
}
|
|
1673
|
-
]
|
|
1674
|
-
},
|
|
1675
|
-
"isESM": true,
|
|
1676
|
-
"relativePath": [
|
|
1677
|
-
"lib",
|
|
1678
|
-
"commands",
|
|
1679
|
-
"agent",
|
|
1680
|
-
"preview",
|
|
1681
|
-
"end.js"
|
|
1682
|
-
],
|
|
1683
|
-
"aliasPermutations": [],
|
|
1684
|
-
"permutations": [
|
|
1685
|
-
"agent:preview:end",
|
|
1686
|
-
"preview:agent:end",
|
|
1687
|
-
"preview:end:agent",
|
|
1688
|
-
"agent:end:preview",
|
|
1689
|
-
"end:agent:preview",
|
|
1690
|
-
"end:preview:agent"
|
|
1691
|
-
]
|
|
1692
|
-
},
|
|
1693
|
-
"agent:preview:send": {
|
|
1694
|
-
"aliases": [],
|
|
1695
|
-
"args": {},
|
|
1696
|
-
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
1697
|
-
"examples": [
|
|
1698
|
-
"Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
|
|
1699
|
-
"Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
|
|
1700
|
-
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
1701
|
-
],
|
|
1702
|
-
"flags": {
|
|
1703
|
-
"json": {
|
|
1704
|
-
"description": "Format output as json.",
|
|
1705
|
-
"helpGroup": "GLOBAL",
|
|
1706
|
-
"name": "json",
|
|
1707
|
-
"allowNo": false,
|
|
1708
|
-
"type": "boolean"
|
|
1709
|
-
},
|
|
1710
|
-
"flags-dir": {
|
|
1711
|
-
"helpGroup": "GLOBAL",
|
|
1712
|
-
"name": "flags-dir",
|
|
1713
|
-
"summary": "Import flag values from a directory.",
|
|
1714
|
-
"hasDynamicHelp": false,
|
|
1715
|
-
"multiple": false,
|
|
1716
|
-
"type": "option"
|
|
1717
|
-
},
|
|
1718
|
-
"target-org": {
|
|
1719
|
-
"char": "o",
|
|
1720
|
-
"name": "target-org",
|
|
1721
|
-
"noCacheDefault": true,
|
|
1722
|
-
"required": true,
|
|
1723
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1724
|
-
"hasDynamicHelp": true,
|
|
1725
|
-
"multiple": false,
|
|
1726
|
-
"type": "option"
|
|
1727
|
-
},
|
|
1728
|
-
"api-version": {
|
|
1729
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1730
|
-
"name": "api-version",
|
|
1731
|
-
"hasDynamicHelp": false,
|
|
1732
|
-
"multiple": false,
|
|
1733
|
-
"type": "option"
|
|
1734
|
-
},
|
|
1735
|
-
"session-id": {
|
|
1736
|
-
"name": "session-id",
|
|
1737
|
-
"required": false,
|
|
1738
|
-
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
1739
|
-
"hasDynamicHelp": false,
|
|
1740
|
-
"multiple": false,
|
|
1741
|
-
"type": "option"
|
|
1742
|
-
},
|
|
1743
|
-
"utterance": {
|
|
1744
|
-
"char": "u",
|
|
1745
|
-
"name": "utterance",
|
|
1746
|
-
"required": true,
|
|
1747
|
-
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1748
|
-
"hasDynamicHelp": false,
|
|
1749
|
-
"multiple": false,
|
|
1750
|
-
"type": "option"
|
|
1751
|
-
},
|
|
1752
|
-
"api-name": {
|
|
1753
|
-
"char": "n",
|
|
1754
|
-
"name": "api-name",
|
|
1755
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1756
|
-
"hasDynamicHelp": false,
|
|
1757
|
-
"multiple": false,
|
|
1758
|
-
"type": "option"
|
|
1759
|
-
},
|
|
1760
|
-
"authoring-bundle": {
|
|
1761
|
-
"name": "authoring-bundle",
|
|
1762
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1763
|
-
"hasDynamicHelp": false,
|
|
1764
|
-
"multiple": false,
|
|
1765
|
-
"type": "option"
|
|
1766
|
-
}
|
|
1767
|
-
},
|
|
1768
|
-
"hasDynamicHelp": true,
|
|
1769
|
-
"hiddenAliases": [],
|
|
1770
|
-
"id": "agent:preview:send",
|
|
1771
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1772
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1773
|
-
"pluginType": "core",
|
|
1774
|
-
"strict": true,
|
|
1775
|
-
"summary": "Send a message to an existing agent preview session.",
|
|
1776
|
-
"enableJsonFlag": true,
|
|
1777
|
-
"requiresProject": true,
|
|
1778
|
-
"envVariablesSection": {
|
|
1779
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
1780
|
-
"body": [
|
|
1781
|
-
{
|
|
1782
|
-
"name": "SF_TARGET_ORG",
|
|
1783
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1784
|
-
}
|
|
1785
|
-
]
|
|
1786
|
-
},
|
|
1787
|
-
"errorCodes": {
|
|
1788
|
-
"header": "ERROR CODES",
|
|
1789
|
-
"body": [
|
|
1790
|
-
{
|
|
1791
|
-
"name": "Succeeded (0)",
|
|
1792
|
-
"description": "Message sent successfully and agent response received."
|
|
1793
|
-
},
|
|
1794
|
-
{
|
|
1795
|
-
"name": "NotFound (2)",
|
|
1796
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
1797
|
-
},
|
|
1798
|
-
{
|
|
1799
|
-
"name": "PreviewSendFailed (4)",
|
|
1800
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
1801
|
-
},
|
|
1802
|
-
{
|
|
1803
|
-
"name": "SessionAmbiguous (5)",
|
|
1804
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1805
|
-
}
|
|
1806
|
-
]
|
|
1807
|
-
},
|
|
1808
|
-
"isESM": true,
|
|
1809
|
-
"relativePath": [
|
|
1810
|
-
"lib",
|
|
1811
|
-
"commands",
|
|
1812
|
-
"agent",
|
|
1813
|
-
"preview",
|
|
1814
|
-
"send.js"
|
|
1815
|
-
],
|
|
1816
|
-
"aliasPermutations": [],
|
|
1817
|
-
"permutations": [
|
|
1818
|
-
"agent:preview:send",
|
|
1819
|
-
"preview:agent:send",
|
|
1820
|
-
"preview:send:agent",
|
|
1821
|
-
"agent:send:preview",
|
|
1822
|
-
"send:agent:preview",
|
|
1823
|
-
"send:preview:agent"
|
|
1824
|
-
]
|
|
1825
|
-
},
|
|
1826
|
-
"agent:preview:sessions": {
|
|
1827
|
-
"aliases": [],
|
|
1828
|
-
"args": {},
|
|
1829
|
-
"description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
|
|
1830
|
-
"examples": [
|
|
1831
|
-
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1832
|
-
],
|
|
1833
|
-
"flags": {
|
|
1834
|
-
"json": {
|
|
1835
|
-
"description": "Format output as json.",
|
|
1836
|
-
"helpGroup": "GLOBAL",
|
|
1837
|
-
"name": "json",
|
|
1838
|
-
"allowNo": false,
|
|
1839
|
-
"type": "boolean"
|
|
1840
|
-
},
|
|
1841
|
-
"flags-dir": {
|
|
1842
|
-
"helpGroup": "GLOBAL",
|
|
1843
|
-
"name": "flags-dir",
|
|
1844
|
-
"summary": "Import flag values from a directory.",
|
|
1845
|
-
"hasDynamicHelp": false,
|
|
1846
|
-
"multiple": false,
|
|
1847
|
-
"type": "option"
|
|
1848
|
-
}
|
|
1849
|
-
},
|
|
1850
|
-
"hasDynamicHelp": false,
|
|
1851
|
-
"hiddenAliases": [],
|
|
1852
|
-
"id": "agent:preview:sessions",
|
|
1853
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1854
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1855
|
-
"pluginType": "core",
|
|
1856
|
-
"strict": true,
|
|
1857
|
-
"summary": "List all known programmatic agent preview sessions.",
|
|
1858
|
-
"enableJsonFlag": true,
|
|
1859
|
-
"requiresProject": true,
|
|
1860
|
-
"errorCodes": {
|
|
1861
|
-
"header": "ERROR CODES",
|
|
1862
|
-
"body": [
|
|
1863
|
-
{
|
|
1864
|
-
"name": "Succeeded (0)",
|
|
1865
|
-
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1866
|
-
}
|
|
1867
|
-
]
|
|
1868
|
-
},
|
|
1869
|
-
"isESM": true,
|
|
1870
|
-
"relativePath": [
|
|
1871
|
-
"lib",
|
|
1872
|
-
"commands",
|
|
1873
|
-
"agent",
|
|
1874
|
-
"preview",
|
|
1875
|
-
"sessions.js"
|
|
1876
|
-
],
|
|
1877
|
-
"aliasPermutations": [],
|
|
1878
|
-
"permutations": [
|
|
1879
|
-
"agent:preview:sessions",
|
|
1880
|
-
"preview:agent:sessions",
|
|
1881
|
-
"preview:sessions:agent",
|
|
1882
|
-
"agent:sessions:preview",
|
|
1883
|
-
"sessions:agent:preview",
|
|
1884
|
-
"sessions:preview:agent"
|
|
1885
|
-
]
|
|
1886
|
-
},
|
|
1887
|
-
"agent:preview:start": {
|
|
1888
|
-
"aliases": [],
|
|
1889
|
-
"args": {},
|
|
1890
|
-
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
|
|
1891
|
-
"examples": [
|
|
1892
|
-
"Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
|
|
1893
|
-
"Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
|
|
1894
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1895
|
-
],
|
|
1896
|
-
"flags": {
|
|
1897
|
-
"json": {
|
|
1898
|
-
"description": "Format output as json.",
|
|
1899
|
-
"helpGroup": "GLOBAL",
|
|
1900
|
-
"name": "json",
|
|
1901
|
-
"allowNo": false,
|
|
1902
|
-
"type": "boolean"
|
|
1903
|
-
},
|
|
1904
|
-
"flags-dir": {
|
|
1905
|
-
"helpGroup": "GLOBAL",
|
|
1906
|
-
"name": "flags-dir",
|
|
1907
|
-
"summary": "Import flag values from a directory.",
|
|
1908
|
-
"hasDynamicHelp": false,
|
|
1909
|
-
"multiple": false,
|
|
1910
|
-
"type": "option"
|
|
1911
|
-
},
|
|
1912
|
-
"target-org": {
|
|
1913
|
-
"char": "o",
|
|
1914
|
-
"name": "target-org",
|
|
1915
|
-
"noCacheDefault": true,
|
|
1916
|
-
"required": true,
|
|
1917
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1918
|
-
"hasDynamicHelp": true,
|
|
1919
|
-
"multiple": false,
|
|
1920
|
-
"type": "option"
|
|
1921
|
-
},
|
|
1922
|
-
"api-version": {
|
|
1923
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1924
|
-
"name": "api-version",
|
|
1925
|
-
"hasDynamicHelp": false,
|
|
1926
|
-
"multiple": false,
|
|
1927
|
-
"type": "option"
|
|
1928
|
-
},
|
|
1929
|
-
"api-name": {
|
|
1930
|
-
"char": "n",
|
|
1931
|
-
"name": "api-name",
|
|
1932
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1933
|
-
"hasDynamicHelp": false,
|
|
1934
|
-
"multiple": false,
|
|
1935
|
-
"type": "option"
|
|
1936
|
-
},
|
|
1937
|
-
"authoring-bundle": {
|
|
1938
|
-
"name": "authoring-bundle",
|
|
1939
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1940
|
-
"hasDynamicHelp": false,
|
|
1941
|
-
"multiple": false,
|
|
1942
|
-
"type": "option"
|
|
1943
|
-
},
|
|
1944
|
-
"use-live-actions": {
|
|
1945
|
-
"exclusive": [
|
|
1946
|
-
"simulate-actions"
|
|
1947
|
-
],
|
|
1948
|
-
"name": "use-live-actions",
|
|
1949
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
1950
|
-
"allowNo": false,
|
|
1951
|
-
"type": "boolean"
|
|
1952
|
-
},
|
|
1953
|
-
"simulate-actions": {
|
|
1954
|
-
"exclusive": [
|
|
1955
|
-
"use-live-actions"
|
|
1956
|
-
],
|
|
1957
|
-
"name": "simulate-actions",
|
|
1958
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
1959
|
-
"allowNo": false,
|
|
1960
|
-
"type": "boolean"
|
|
1961
|
-
},
|
|
1962
|
-
"context-variables": {
|
|
1963
|
-
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
1964
|
-
"name": "context-variables",
|
|
1965
|
-
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
1966
|
-
"delimiter": ",",
|
|
1967
|
-
"hasDynamicHelp": false,
|
|
1968
|
-
"multiple": true,
|
|
1969
|
-
"type": "option"
|
|
1970
|
-
},
|
|
1971
|
-
"context-variables-json": {
|
|
1972
|
-
"description": "Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a Number, Object, List, or Json value.\n\nThe value is a JSON array of objects, each with a \"name\", a \"type\", and an optional \"value\". The \"type\" is one of Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of \"value\" must match \"type\": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an array, and Json takes an object.\n\nExample: --context-variables-json '[{\"name\":\"probeGate\",\"type\":\"Boolean\",\"value\":true},{\"name\":\"retryCount\",\"type\":\"Number\",\"value\":3}]'.\n\nYou can pass both --context-variables and --context-variables-json in the same command. When the same variable name appears in both, the --context-variables-json value wins.\n\nTip: names follow the same rules as --context-variables. Use the \"$Context.\" prefix for linked context variables, and a bare name for state variables.",
|
|
1973
|
-
"name": "context-variables-json",
|
|
1974
|
-
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
1687
|
+
"auth-type": {
|
|
1688
|
+
"name": "auth-type",
|
|
1689
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1690
|
+
"default": "NO_AUTH",
|
|
1975
1691
|
"hasDynamicHelp": false,
|
|
1976
1692
|
"multiple": false,
|
|
1977
|
-
"
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
"dependsOn": [
|
|
1981
|
-
"authoring-bundle"
|
|
1693
|
+
"options": [
|
|
1694
|
+
"OAUTH",
|
|
1695
|
+
"NO_AUTH"
|
|
1982
1696
|
],
|
|
1983
|
-
"hidden": true,
|
|
1984
|
-
"name": "agent-json",
|
|
1985
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
1986
|
-
"hasDynamicHelp": false,
|
|
1987
|
-
"multiple": false,
|
|
1988
1697
|
"type": "option"
|
|
1989
|
-
}
|
|
1990
|
-
},
|
|
1991
|
-
"hasDynamicHelp": true,
|
|
1992
|
-
"hiddenAliases": [],
|
|
1993
|
-
"id": "agent:preview:start",
|
|
1994
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1995
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1996
|
-
"pluginType": "core",
|
|
1997
|
-
"strict": true,
|
|
1998
|
-
"summary": "Start a programmatic agent preview session.",
|
|
1999
|
-
"enableJsonFlag": true,
|
|
2000
|
-
"requiresProject": true,
|
|
2001
|
-
"envVariablesSection": {
|
|
2002
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2003
|
-
"body": [
|
|
2004
|
-
{
|
|
2005
|
-
"name": "SF_TARGET_ORG",
|
|
2006
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2007
|
-
}
|
|
2008
|
-
]
|
|
2009
|
-
},
|
|
2010
|
-
"errorCodes": {
|
|
2011
|
-
"header": "ERROR CODES",
|
|
2012
|
-
"body": [
|
|
2013
|
-
{
|
|
2014
|
-
"name": "Succeeded (0)",
|
|
2015
|
-
"description": "Preview session started successfully."
|
|
2016
|
-
},
|
|
2017
|
-
{
|
|
2018
|
-
"name": "Failed (1)",
|
|
2019
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2020
|
-
},
|
|
2021
|
-
{
|
|
2022
|
-
"name": "NotFound (2)",
|
|
2023
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2024
|
-
},
|
|
2025
|
-
{
|
|
2026
|
-
"name": "ServerError (3)",
|
|
2027
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2028
|
-
},
|
|
2029
|
-
{
|
|
2030
|
-
"name": "PreviewStartFailed (4)",
|
|
2031
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
2032
|
-
}
|
|
2033
|
-
]
|
|
2034
|
-
},
|
|
2035
|
-
"isESM": true,
|
|
2036
|
-
"relativePath": [
|
|
2037
|
-
"lib",
|
|
2038
|
-
"commands",
|
|
2039
|
-
"agent",
|
|
2040
|
-
"preview",
|
|
2041
|
-
"start.js"
|
|
2042
|
-
],
|
|
2043
|
-
"aliasPermutations": [],
|
|
2044
|
-
"permutations": [
|
|
2045
|
-
"agent:preview:start",
|
|
2046
|
-
"preview:agent:start",
|
|
2047
|
-
"preview:start:agent",
|
|
2048
|
-
"agent:start:preview",
|
|
2049
|
-
"start:agent:preview",
|
|
2050
|
-
"start:preview:agent"
|
|
2051
|
-
]
|
|
2052
|
-
},
|
|
2053
|
-
"agent:publish:authoring-bundle": {
|
|
2054
|
-
"aliases": [],
|
|
2055
|
-
"args": {},
|
|
2056
|
-
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
2057
|
-
"examples": [
|
|
2058
|
-
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2059
|
-
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
2060
|
-
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2061
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2062
|
-
],
|
|
2063
|
-
"flags": {
|
|
2064
|
-
"json": {
|
|
2065
|
-
"description": "Format output as json.",
|
|
2066
|
-
"helpGroup": "GLOBAL",
|
|
2067
|
-
"name": "json",
|
|
2068
|
-
"allowNo": false,
|
|
2069
|
-
"type": "boolean"
|
|
2070
1698
|
},
|
|
2071
|
-
"
|
|
2072
|
-
"
|
|
2073
|
-
"
|
|
2074
|
-
"summary": "Import flag values from a directory.",
|
|
1699
|
+
"identity-provider": {
|
|
1700
|
+
"name": "identity-provider",
|
|
1701
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
2075
1702
|
"hasDynamicHelp": false,
|
|
2076
1703
|
"multiple": false,
|
|
2077
1704
|
"type": "option"
|
|
2078
1705
|
},
|
|
2079
|
-
"
|
|
2080
|
-
"
|
|
2081
|
-
"
|
|
2082
|
-
"noCacheDefault": true,
|
|
2083
|
-
"required": true,
|
|
2084
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2085
|
-
"hasDynamicHelp": true,
|
|
2086
|
-
"multiple": false,
|
|
2087
|
-
"type": "option"
|
|
2088
|
-
},
|
|
2089
|
-
"api-version": {
|
|
2090
|
-
"description": "Override the api version used for api requests made by this command",
|
|
2091
|
-
"name": "api-version",
|
|
1706
|
+
"client-id": {
|
|
1707
|
+
"name": "client-id",
|
|
1708
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
2092
1709
|
"hasDynamicHelp": false,
|
|
2093
1710
|
"multiple": false,
|
|
2094
1711
|
"type": "option"
|
|
2095
1712
|
},
|
|
2096
|
-
"
|
|
2097
|
-
"
|
|
2098
|
-
"
|
|
2099
|
-
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
1713
|
+
"client-secret": {
|
|
1714
|
+
"name": "client-secret",
|
|
1715
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2100
1716
|
"hasDynamicHelp": false,
|
|
2101
1717
|
"multiple": false,
|
|
2102
1718
|
"type": "option"
|
|
2103
1719
|
},
|
|
2104
|
-
"
|
|
2105
|
-
"name": "
|
|
2106
|
-
"summary": "
|
|
2107
|
-
"
|
|
2108
|
-
"
|
|
2109
|
-
|
|
2110
|
-
"verbose": {
|
|
2111
|
-
"char": "v",
|
|
2112
|
-
"exclusive": [
|
|
2113
|
-
"concise"
|
|
2114
|
-
],
|
|
2115
|
-
"name": "verbose",
|
|
2116
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2117
|
-
"allowNo": false,
|
|
2118
|
-
"type": "boolean"
|
|
2119
|
-
},
|
|
2120
|
-
"concise": {
|
|
2121
|
-
"exclusive": [
|
|
2122
|
-
"verbose"
|
|
2123
|
-
],
|
|
2124
|
-
"name": "concise",
|
|
2125
|
-
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
2126
|
-
"allowNo": false,
|
|
2127
|
-
"type": "boolean"
|
|
2128
|
-
}
|
|
2129
|
-
},
|
|
2130
|
-
"hasDynamicHelp": true,
|
|
2131
|
-
"hiddenAliases": [],
|
|
2132
|
-
"id": "agent:publish:authoring-bundle",
|
|
2133
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
2134
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
2135
|
-
"pluginType": "core",
|
|
2136
|
-
"strict": true,
|
|
2137
|
-
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
2138
|
-
"enableJsonFlag": true,
|
|
2139
|
-
"requiresProject": true,
|
|
2140
|
-
"errorCodes": {
|
|
2141
|
-
"header": "ERROR CODES",
|
|
2142
|
-
"body": [
|
|
2143
|
-
{
|
|
2144
|
-
"name": "Succeeded (0)",
|
|
2145
|
-
"description": "Agent published successfully without errors."
|
|
2146
|
-
},
|
|
2147
|
-
{
|
|
2148
|
-
"name": "Failed (1)",
|
|
2149
|
-
"description": "Compilation errors found in the Agent Script file."
|
|
2150
|
-
}
|
|
2151
|
-
]
|
|
2152
|
-
},
|
|
2153
|
-
"FLAGGABLE_PROMPTS": {
|
|
2154
|
-
"api-name": {
|
|
2155
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2156
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
1720
|
+
"scope": {
|
|
1721
|
+
"name": "scope",
|
|
1722
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1723
|
+
"hasDynamicHelp": false,
|
|
1724
|
+
"multiple": false,
|
|
1725
|
+
"type": "option"
|
|
2157
1726
|
}
|
|
2158
1727
|
},
|
|
1728
|
+
"hasDynamicHelp": true,
|
|
1729
|
+
"hiddenAliases": [],
|
|
1730
|
+
"id": "agent:mcp:create",
|
|
1731
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
1732
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
1733
|
+
"pluginType": "core",
|
|
1734
|
+
"state": "preview",
|
|
1735
|
+
"strict": true,
|
|
1736
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1737
|
+
"enableJsonFlag": true,
|
|
2159
1738
|
"isESM": true,
|
|
2160
1739
|
"relativePath": [
|
|
2161
1740
|
"lib",
|
|
2162
1741
|
"commands",
|
|
2163
1742
|
"agent",
|
|
2164
|
-
"
|
|
2165
|
-
"
|
|
1743
|
+
"mcp",
|
|
1744
|
+
"create.js"
|
|
2166
1745
|
],
|
|
2167
1746
|
"aliasPermutations": [],
|
|
2168
1747
|
"permutations": [
|
|
2169
|
-
"agent:
|
|
2170
|
-
"
|
|
2171
|
-
"
|
|
2172
|
-
"agent:
|
|
2173
|
-
"
|
|
2174
|
-
"
|
|
1748
|
+
"agent:mcp:create",
|
|
1749
|
+
"mcp:agent:create",
|
|
1750
|
+
"mcp:create:agent",
|
|
1751
|
+
"agent:create:mcp",
|
|
1752
|
+
"create:agent:mcp",
|
|
1753
|
+
"create:mcp:agent"
|
|
2175
1754
|
]
|
|
2176
1755
|
},
|
|
2177
|
-
"agent:
|
|
1756
|
+
"agent:mcp:delete": {
|
|
2178
1757
|
"aliases": [],
|
|
2179
1758
|
"args": {},
|
|
2180
|
-
"description": "
|
|
1759
|
+
"description": "Permanently removes an MCP (Model Context Protocol) server registration from the API Catalog, identified by its ID. By default you are prompted to confirm the deletion; pass --no-prompt to skip the confirmation (for example in scripts and CI).",
|
|
2181
1760
|
"examples": [
|
|
2182
|
-
"Delete
|
|
2183
|
-
"Delete
|
|
2184
|
-
"Delete traces from a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2185
|
-
"Delete traces older than 7 days:\n<%= config.bin %> <%= command.id %> --older-than 7d",
|
|
2186
|
-
"Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt",
|
|
2187
|
-
"Delete all traces for all agents and sessions; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
1761
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1762
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
2188
1763
|
],
|
|
2189
1764
|
"flags": {
|
|
2190
1765
|
"json": {
|
|
@@ -2202,84 +1777,74 @@
|
|
|
2202
1777
|
"multiple": false,
|
|
2203
1778
|
"type": "option"
|
|
2204
1779
|
},
|
|
2205
|
-
"
|
|
2206
|
-
"char": "
|
|
2207
|
-
"name": "
|
|
2208
|
-
"
|
|
2209
|
-
"
|
|
1780
|
+
"target-org": {
|
|
1781
|
+
"char": "o",
|
|
1782
|
+
"name": "target-org",
|
|
1783
|
+
"noCacheDefault": true,
|
|
1784
|
+
"required": true,
|
|
1785
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1786
|
+
"hasDynamicHelp": true,
|
|
2210
1787
|
"multiple": false,
|
|
2211
1788
|
"type": "option"
|
|
2212
1789
|
},
|
|
2213
|
-
"
|
|
2214
|
-
"
|
|
2215
|
-
"
|
|
1790
|
+
"api-version": {
|
|
1791
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1792
|
+
"name": "api-version",
|
|
2216
1793
|
"hasDynamicHelp": false,
|
|
2217
1794
|
"multiple": false,
|
|
2218
1795
|
"type": "option"
|
|
2219
1796
|
},
|
|
2220
|
-
"
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
1797
|
+
"mcp-server-id": {
|
|
1798
|
+
"char": "i",
|
|
1799
|
+
"name": "mcp-server-id",
|
|
1800
|
+
"required": true,
|
|
1801
|
+
"summary": "ID of the MCP server to delete.",
|
|
2223
1802
|
"hasDynamicHelp": false,
|
|
2224
1803
|
"multiple": false,
|
|
2225
1804
|
"type": "option"
|
|
2226
1805
|
},
|
|
2227
1806
|
"no-prompt": {
|
|
2228
1807
|
"name": "no-prompt",
|
|
2229
|
-
"summary": "Skip the confirmation prompt and delete immediately.",
|
|
1808
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
2230
1809
|
"allowNo": false,
|
|
2231
1810
|
"type": "boolean"
|
|
2232
1811
|
}
|
|
2233
1812
|
},
|
|
2234
|
-
"hasDynamicHelp":
|
|
1813
|
+
"hasDynamicHelp": true,
|
|
2235
1814
|
"hiddenAliases": [],
|
|
2236
|
-
"id": "agent:
|
|
1815
|
+
"id": "agent:mcp:delete",
|
|
2237
1816
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2238
1817
|
"pluginName": "@salesforce/plugin-agent",
|
|
2239
1818
|
"pluginType": "core",
|
|
1819
|
+
"state": "preview",
|
|
2240
1820
|
"strict": true,
|
|
2241
|
-
"summary": "Delete
|
|
1821
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
2242
1822
|
"enableJsonFlag": true,
|
|
2243
|
-
"requiresProject": true,
|
|
2244
|
-
"errorCodes": {
|
|
2245
|
-
"header": "ERROR CODES",
|
|
2246
|
-
"body": [
|
|
2247
|
-
{
|
|
2248
|
-
"name": "Succeeded (0)",
|
|
2249
|
-
"description": "Traces deleted successfully (or no traces matched)."
|
|
2250
|
-
}
|
|
2251
|
-
]
|
|
2252
|
-
},
|
|
2253
1823
|
"isESM": true,
|
|
2254
1824
|
"relativePath": [
|
|
2255
1825
|
"lib",
|
|
2256
1826
|
"commands",
|
|
2257
1827
|
"agent",
|
|
2258
|
-
"
|
|
1828
|
+
"mcp",
|
|
2259
1829
|
"delete.js"
|
|
2260
1830
|
],
|
|
2261
1831
|
"aliasPermutations": [],
|
|
2262
1832
|
"permutations": [
|
|
2263
|
-
"agent:
|
|
2264
|
-
"
|
|
2265
|
-
"
|
|
2266
|
-
"agent:delete:
|
|
2267
|
-
"delete:agent:
|
|
2268
|
-
"delete:
|
|
1833
|
+
"agent:mcp:delete",
|
|
1834
|
+
"mcp:agent:delete",
|
|
1835
|
+
"mcp:delete:agent",
|
|
1836
|
+
"agent:delete:mcp",
|
|
1837
|
+
"delete:agent:mcp",
|
|
1838
|
+
"delete:mcp:agent"
|
|
2269
1839
|
]
|
|
2270
1840
|
},
|
|
2271
|
-
"agent:
|
|
1841
|
+
"agent:mcp:fetch": {
|
|
2272
1842
|
"aliases": [],
|
|
2273
1843
|
"args": {},
|
|
2274
|
-
"description": "
|
|
1844
|
+
"description": "Performs a live fetch against the configured MCP server identified by its ID, returning the assets (MCP tools, prompts, and resources) it currently advertises along with their status and activation state. Use this to refresh the view of what an MCP server exposes before activating its assets as agent actions.",
|
|
2275
1845
|
"examples": [
|
|
2276
|
-
"
|
|
2277
|
-
"
|
|
2278
|
-
"List trace files for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2279
|
-
"List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):\n<%= config.bin %> <%= command.id %> --since 2026-04-20",
|
|
2280
|
-
"List trace files recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
2281
|
-
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
2282
|
-
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
1846
|
+
"Fetch the assets advertised by an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
1847
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
2283
1848
|
],
|
|
2284
1849
|
"flags": {
|
|
2285
1850
|
"json": {
|
|
@@ -2297,79 +1862,68 @@
|
|
|
2297
1862
|
"multiple": false,
|
|
2298
1863
|
"type": "option"
|
|
2299
1864
|
},
|
|
2300
|
-
"
|
|
2301
|
-
"
|
|
2302
|
-
"
|
|
2303
|
-
"
|
|
1865
|
+
"target-org": {
|
|
1866
|
+
"char": "o",
|
|
1867
|
+
"name": "target-org",
|
|
1868
|
+
"noCacheDefault": true,
|
|
1869
|
+
"required": true,
|
|
1870
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1871
|
+
"hasDynamicHelp": true,
|
|
2304
1872
|
"multiple": false,
|
|
2305
1873
|
"type": "option"
|
|
2306
1874
|
},
|
|
2307
|
-
"
|
|
2308
|
-
"
|
|
2309
|
-
"name": "
|
|
2310
|
-
"summary": "API name of the agent used to filter the list of available trace files. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
1875
|
+
"api-version": {
|
|
1876
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1877
|
+
"name": "api-version",
|
|
2311
1878
|
"hasDynamicHelp": false,
|
|
2312
1879
|
"multiple": false,
|
|
2313
1880
|
"type": "option"
|
|
2314
1881
|
},
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2317
|
-
"name": "
|
|
2318
|
-
"
|
|
1882
|
+
"mcp-server-id": {
|
|
1883
|
+
"char": "i",
|
|
1884
|
+
"name": "mcp-server-id",
|
|
1885
|
+
"required": true,
|
|
1886
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
2319
1887
|
"hasDynamicHelp": false,
|
|
2320
1888
|
"multiple": false,
|
|
2321
1889
|
"type": "option"
|
|
2322
1890
|
}
|
|
2323
1891
|
},
|
|
2324
|
-
"hasDynamicHelp":
|
|
1892
|
+
"hasDynamicHelp": true,
|
|
2325
1893
|
"hiddenAliases": [],
|
|
2326
|
-
"id": "agent:
|
|
1894
|
+
"id": "agent:mcp:fetch",
|
|
2327
1895
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2328
1896
|
"pluginName": "@salesforce/plugin-agent",
|
|
2329
1897
|
"pluginType": "core",
|
|
1898
|
+
"state": "preview",
|
|
2330
1899
|
"strict": true,
|
|
2331
|
-
"summary": "
|
|
1900
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
2332
1901
|
"enableJsonFlag": true,
|
|
2333
|
-
"requiresProject": true,
|
|
2334
|
-
"errorCodes": {
|
|
2335
|
-
"header": "ERROR CODES",
|
|
2336
|
-
"body": [
|
|
2337
|
-
{
|
|
2338
|
-
"name": "Succeeded (0)",
|
|
2339
|
-
"description": "Trace files listed successfully (or empty list if none found)."
|
|
2340
|
-
}
|
|
2341
|
-
]
|
|
2342
|
-
},
|
|
2343
1902
|
"isESM": true,
|
|
2344
1903
|
"relativePath": [
|
|
2345
1904
|
"lib",
|
|
2346
1905
|
"commands",
|
|
2347
1906
|
"agent",
|
|
2348
|
-
"
|
|
2349
|
-
"
|
|
1907
|
+
"mcp",
|
|
1908
|
+
"fetch.js"
|
|
2350
1909
|
],
|
|
2351
1910
|
"aliasPermutations": [],
|
|
2352
1911
|
"permutations": [
|
|
2353
|
-
"agent:
|
|
2354
|
-
"
|
|
2355
|
-
"
|
|
2356
|
-
"agent:
|
|
2357
|
-
"
|
|
2358
|
-
"
|
|
1912
|
+
"agent:mcp:fetch",
|
|
1913
|
+
"mcp:agent:fetch",
|
|
1914
|
+
"mcp:fetch:agent",
|
|
1915
|
+
"agent:fetch:mcp",
|
|
1916
|
+
"fetch:agent:mcp",
|
|
1917
|
+
"fetch:mcp:agent"
|
|
2359
1918
|
]
|
|
2360
1919
|
},
|
|
2361
|
-
"agent:
|
|
1920
|
+
"agent:mcp:get": {
|
|
2362
1921
|
"aliases": [],
|
|
2363
1922
|
"args": {},
|
|
2364
|
-
"description": "
|
|
1923
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
2365
1924
|
"examples": [
|
|
2366
|
-
"
|
|
2367
|
-
"
|
|
2368
|
-
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
2369
|
-
"Drill into routing decisions for the first turn of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension routing --turn 1",
|
|
2370
|
-
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
2371
|
-
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
2372
|
-
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
1925
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1926
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2373
1927
|
],
|
|
2374
1928
|
"flags": {
|
|
2375
1929
|
"json": {
|
|
@@ -2387,89 +1941,68 @@
|
|
|
2387
1941
|
"multiple": false,
|
|
2388
1942
|
"type": "option"
|
|
2389
1943
|
},
|
|
2390
|
-
"
|
|
2391
|
-
"char": "
|
|
2392
|
-
"name": "
|
|
1944
|
+
"target-org": {
|
|
1945
|
+
"char": "o",
|
|
1946
|
+
"name": "target-org",
|
|
1947
|
+
"noCacheDefault": true,
|
|
2393
1948
|
"required": true,
|
|
2394
|
-
"summary": "
|
|
2395
|
-
"hasDynamicHelp":
|
|
2396
|
-
"multiple": false,
|
|
2397
|
-
"type": "option"
|
|
2398
|
-
},
|
|
2399
|
-
"format": {
|
|
2400
|
-
"char": "f",
|
|
2401
|
-
"name": "format",
|
|
2402
|
-
"summary": "Output format of the trace data; specifies the level of detail you want in the trace files.",
|
|
2403
|
-
"default": "summary",
|
|
2404
|
-
"hasDynamicHelp": false,
|
|
1949
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1950
|
+
"hasDynamicHelp": true,
|
|
2405
1951
|
"multiple": false,
|
|
2406
|
-
"options": [
|
|
2407
|
-
"summary",
|
|
2408
|
-
"detail",
|
|
2409
|
-
"raw"
|
|
2410
|
-
],
|
|
2411
1952
|
"type": "option"
|
|
2412
1953
|
},
|
|
2413
|
-
"
|
|
2414
|
-
"
|
|
2415
|
-
"name": "
|
|
2416
|
-
"summary": "Dimension to drill into when using \"--format detail\"; used to filter and organize the trace data to answer a specific type of question.",
|
|
1954
|
+
"api-version": {
|
|
1955
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1956
|
+
"name": "api-version",
|
|
2417
1957
|
"hasDynamicHelp": false,
|
|
2418
1958
|
"multiple": false,
|
|
2419
|
-
"options": [
|
|
2420
|
-
"actions",
|
|
2421
|
-
"grounding",
|
|
2422
|
-
"routing",
|
|
2423
|
-
"errors"
|
|
2424
|
-
],
|
|
2425
1959
|
"type": "option"
|
|
2426
1960
|
},
|
|
2427
|
-
"
|
|
2428
|
-
"char": "
|
|
2429
|
-
"name": "
|
|
2430
|
-
"
|
|
1961
|
+
"mcp-server-id": {
|
|
1962
|
+
"char": "i",
|
|
1963
|
+
"name": "mcp-server-id",
|
|
1964
|
+
"required": true,
|
|
1965
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
2431
1966
|
"hasDynamicHelp": false,
|
|
2432
1967
|
"multiple": false,
|
|
2433
1968
|
"type": "option"
|
|
2434
1969
|
}
|
|
2435
1970
|
},
|
|
2436
|
-
"hasDynamicHelp":
|
|
1971
|
+
"hasDynamicHelp": true,
|
|
2437
1972
|
"hiddenAliases": [],
|
|
2438
|
-
"id": "agent:
|
|
1973
|
+
"id": "agent:mcp:get",
|
|
2439
1974
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2440
1975
|
"pluginName": "@salesforce/plugin-agent",
|
|
2441
1976
|
"pluginType": "core",
|
|
1977
|
+
"state": "preview",
|
|
2442
1978
|
"strict": true,
|
|
2443
|
-
"summary": "
|
|
1979
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
2444
1980
|
"enableJsonFlag": true,
|
|
2445
|
-
"requiresProject": true,
|
|
2446
1981
|
"isESM": true,
|
|
2447
1982
|
"relativePath": [
|
|
2448
1983
|
"lib",
|
|
2449
1984
|
"commands",
|
|
2450
1985
|
"agent",
|
|
2451
|
-
"
|
|
2452
|
-
"
|
|
1986
|
+
"mcp",
|
|
1987
|
+
"get.js"
|
|
2453
1988
|
],
|
|
2454
1989
|
"aliasPermutations": [],
|
|
2455
1990
|
"permutations": [
|
|
2456
|
-
"agent:
|
|
2457
|
-
"
|
|
2458
|
-
"
|
|
2459
|
-
"agent:
|
|
2460
|
-
"
|
|
2461
|
-
"
|
|
1991
|
+
"agent:mcp:get",
|
|
1992
|
+
"mcp:agent:get",
|
|
1993
|
+
"mcp:get:agent",
|
|
1994
|
+
"agent:get:mcp",
|
|
1995
|
+
"get:agent:mcp",
|
|
1996
|
+
"get:mcp:agent"
|
|
2462
1997
|
]
|
|
2463
1998
|
},
|
|
2464
|
-
"agent:
|
|
1999
|
+
"agent:mcp:list": {
|
|
2465
2000
|
"aliases": [],
|
|
2466
2001
|
"args": {},
|
|
2467
|
-
"description": "
|
|
2002
|
+
"description": "Returns the Model Context Protocol (MCP) servers registered in the API Catalog, optionally filtered by label, type, or status. Use this to discover which MCP servers are available and inspect their server URLs and current status.",
|
|
2468
2003
|
"examples": [
|
|
2469
|
-
"
|
|
2470
|
-
"
|
|
2471
|
-
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
2472
|
-
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
2004
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2005
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2473
2006
|
],
|
|
2474
2007
|
"flags": {
|
|
2475
2008
|
"json": {
|
|
@@ -2487,20 +2020,6 @@
|
|
|
2487
2020
|
"multiple": false,
|
|
2488
2021
|
"type": "option"
|
|
2489
2022
|
},
|
|
2490
|
-
"api-name": {
|
|
2491
|
-
"name": "api-name",
|
|
2492
|
-
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
2493
|
-
"hasDynamicHelp": false,
|
|
2494
|
-
"multiple": false,
|
|
2495
|
-
"type": "option"
|
|
2496
|
-
},
|
|
2497
|
-
"spec": {
|
|
2498
|
-
"name": "spec",
|
|
2499
|
-
"summary": "Path to the test spec YAML file.",
|
|
2500
|
-
"hasDynamicHelp": false,
|
|
2501
|
-
"multiple": false,
|
|
2502
|
-
"type": "option"
|
|
2503
|
-
},
|
|
2504
2023
|
"target-org": {
|
|
2505
2024
|
"char": "o",
|
|
2506
2025
|
"name": "target-org",
|
|
@@ -2518,95 +2037,70 @@
|
|
|
2518
2037
|
"multiple": false,
|
|
2519
2038
|
"type": "option"
|
|
2520
2039
|
},
|
|
2521
|
-
"
|
|
2522
|
-
"name": "
|
|
2523
|
-
"summary": "
|
|
2524
|
-
"
|
|
2525
|
-
"
|
|
2040
|
+
"label": {
|
|
2041
|
+
"name": "label",
|
|
2042
|
+
"summary": "Filter the MCP servers by label.",
|
|
2043
|
+
"hasDynamicHelp": false,
|
|
2044
|
+
"multiple": false,
|
|
2045
|
+
"type": "option"
|
|
2526
2046
|
},
|
|
2527
|
-
"
|
|
2528
|
-
"name": "
|
|
2529
|
-
"summary": "
|
|
2530
|
-
"
|
|
2531
|
-
"
|
|
2047
|
+
"type": {
|
|
2048
|
+
"name": "type",
|
|
2049
|
+
"summary": "Filter the MCP servers by type.",
|
|
2050
|
+
"hasDynamicHelp": false,
|
|
2051
|
+
"multiple": false,
|
|
2052
|
+
"options": [
|
|
2053
|
+
"EXTERNAL"
|
|
2054
|
+
],
|
|
2055
|
+
"type": "option"
|
|
2532
2056
|
},
|
|
2533
|
-
"
|
|
2534
|
-
"
|
|
2535
|
-
"
|
|
2536
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2057
|
+
"status": {
|
|
2058
|
+
"name": "status",
|
|
2059
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2537
2060
|
"hasDynamicHelp": false,
|
|
2538
2061
|
"multiple": false,
|
|
2539
2062
|
"options": [
|
|
2540
|
-
"
|
|
2541
|
-
"
|
|
2063
|
+
"ACTIVE",
|
|
2064
|
+
"DISCONNECTED"
|
|
2542
2065
|
],
|
|
2543
2066
|
"type": "option"
|
|
2544
2067
|
}
|
|
2545
2068
|
},
|
|
2546
2069
|
"hasDynamicHelp": true,
|
|
2547
2070
|
"hiddenAliases": [],
|
|
2548
|
-
"id": "agent:
|
|
2071
|
+
"id": "agent:mcp:list",
|
|
2549
2072
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2550
2073
|
"pluginName": "@salesforce/plugin-agent",
|
|
2551
2074
|
"pluginType": "core",
|
|
2075
|
+
"state": "preview",
|
|
2552
2076
|
"strict": true,
|
|
2553
|
-
"summary": "
|
|
2077
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2554
2078
|
"enableJsonFlag": true,
|
|
2555
|
-
"envVariablesSection": {
|
|
2556
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2557
|
-
"body": [
|
|
2558
|
-
{
|
|
2559
|
-
"name": "SF_TARGET_ORG",
|
|
2560
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2561
|
-
}
|
|
2562
|
-
]
|
|
2563
|
-
},
|
|
2564
|
-
"errorCodes": {
|
|
2565
|
-
"header": "ERROR CODES",
|
|
2566
|
-
"body": [
|
|
2567
|
-
{
|
|
2568
|
-
"name": "Succeeded (0)",
|
|
2569
|
-
"description": "Test created and deployed successfully."
|
|
2570
|
-
},
|
|
2571
|
-
{
|
|
2572
|
-
"name": "Failed (1)",
|
|
2573
|
-
"description": "Test validation errors or metadata format issues."
|
|
2574
|
-
},
|
|
2575
|
-
{
|
|
2576
|
-
"name": "NotFound (2)",
|
|
2577
|
-
"description": "Test spec file not found or org connection failed."
|
|
2578
|
-
},
|
|
2579
|
-
{
|
|
2580
|
-
"name": "DeploymentFailed (4)",
|
|
2581
|
-
"description": "Deployment failed due to API or network errors."
|
|
2582
|
-
}
|
|
2583
|
-
]
|
|
2584
|
-
},
|
|
2585
2079
|
"isESM": true,
|
|
2586
2080
|
"relativePath": [
|
|
2587
2081
|
"lib",
|
|
2588
2082
|
"commands",
|
|
2589
2083
|
"agent",
|
|
2590
|
-
"
|
|
2591
|
-
"
|
|
2084
|
+
"mcp",
|
|
2085
|
+
"list.js"
|
|
2592
2086
|
],
|
|
2593
2087
|
"aliasPermutations": [],
|
|
2594
2088
|
"permutations": [
|
|
2595
|
-
"agent:
|
|
2596
|
-
"
|
|
2597
|
-
"
|
|
2598
|
-
"agent:
|
|
2599
|
-
"
|
|
2600
|
-
"
|
|
2089
|
+
"agent:mcp:list",
|
|
2090
|
+
"mcp:agent:list",
|
|
2091
|
+
"mcp:list:agent",
|
|
2092
|
+
"agent:list:mcp",
|
|
2093
|
+
"list:agent:mcp",
|
|
2094
|
+
"list:mcp:agent"
|
|
2601
2095
|
]
|
|
2602
2096
|
},
|
|
2603
|
-
"agent:
|
|
2097
|
+
"agent:mcp:update": {
|
|
2604
2098
|
"aliases": [],
|
|
2605
2099
|
"args": {},
|
|
2606
|
-
"description": "
|
|
2100
|
+
"description": "Updates an existing MCP server in the API Catalog. Only the fields you provide are changed; omitted fields are left untouched. You can update the label, description, and server URL, and replace the authorization configuration. When setting `--auth-type OAUTH`, you must also provide `--identity-provider`, `--client-id`, `--client-secret`, and `--scope`. When setting `--auth-type NO_AUTH`, no authorization credentials are required. At least one updatable field must be supplied.",
|
|
2607
2101
|
"examples": [
|
|
2608
|
-
"
|
|
2609
|
-
"
|
|
2102
|
+
"Update the label and description of an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label \"Orders MCP\" --description \"Order tooling\" --target-org myOrg",
|
|
2103
|
+
"Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:\ncat secret.txt | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope \"read write\" --target-org myOrg --json"
|
|
2610
2104
|
],
|
|
2611
2105
|
"flags": {
|
|
2612
2106
|
"json": {
|
|
@@ -2640,65 +2134,115 @@
|
|
|
2640
2134
|
"hasDynamicHelp": false,
|
|
2641
2135
|
"multiple": false,
|
|
2642
2136
|
"type": "option"
|
|
2137
|
+
},
|
|
2138
|
+
"mcp-server-id": {
|
|
2139
|
+
"char": "i",
|
|
2140
|
+
"name": "mcp-server-id",
|
|
2141
|
+
"required": true,
|
|
2142
|
+
"summary": "ID of the MCP server to update.",
|
|
2143
|
+
"hasDynamicHelp": false,
|
|
2144
|
+
"multiple": false,
|
|
2145
|
+
"type": "option"
|
|
2146
|
+
},
|
|
2147
|
+
"label": {
|
|
2148
|
+
"name": "label",
|
|
2149
|
+
"summary": "New display label for the MCP server.",
|
|
2150
|
+
"hasDynamicHelp": false,
|
|
2151
|
+
"multiple": false,
|
|
2152
|
+
"type": "option"
|
|
2153
|
+
},
|
|
2154
|
+
"description": {
|
|
2155
|
+
"name": "description",
|
|
2156
|
+
"summary": "New description for the MCP server.",
|
|
2157
|
+
"hasDynamicHelp": false,
|
|
2158
|
+
"multiple": false,
|
|
2159
|
+
"type": "option"
|
|
2160
|
+
},
|
|
2161
|
+
"server-url": {
|
|
2162
|
+
"name": "server-url",
|
|
2163
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2164
|
+
"hasDynamicHelp": false,
|
|
2165
|
+
"multiple": false,
|
|
2166
|
+
"type": "option"
|
|
2167
|
+
},
|
|
2168
|
+
"auth-type": {
|
|
2169
|
+
"name": "auth-type",
|
|
2170
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2171
|
+
"hasDynamicHelp": false,
|
|
2172
|
+
"multiple": false,
|
|
2173
|
+
"options": [
|
|
2174
|
+
"OAUTH",
|
|
2175
|
+
"NO_AUTH"
|
|
2176
|
+
],
|
|
2177
|
+
"type": "option"
|
|
2178
|
+
},
|
|
2179
|
+
"identity-provider": {
|
|
2180
|
+
"name": "identity-provider",
|
|
2181
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2182
|
+
"hasDynamicHelp": false,
|
|
2183
|
+
"multiple": false,
|
|
2184
|
+
"type": "option"
|
|
2185
|
+
},
|
|
2186
|
+
"client-id": {
|
|
2187
|
+
"name": "client-id",
|
|
2188
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2189
|
+
"hasDynamicHelp": false,
|
|
2190
|
+
"multiple": false,
|
|
2191
|
+
"type": "option"
|
|
2192
|
+
},
|
|
2193
|
+
"client-secret": {
|
|
2194
|
+
"name": "client-secret",
|
|
2195
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2196
|
+
"hasDynamicHelp": false,
|
|
2197
|
+
"multiple": false,
|
|
2198
|
+
"type": "option"
|
|
2199
|
+
},
|
|
2200
|
+
"scope": {
|
|
2201
|
+
"name": "scope",
|
|
2202
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2203
|
+
"hasDynamicHelp": false,
|
|
2204
|
+
"multiple": false,
|
|
2205
|
+
"type": "option"
|
|
2643
2206
|
}
|
|
2644
2207
|
},
|
|
2645
2208
|
"hasDynamicHelp": true,
|
|
2646
2209
|
"hiddenAliases": [],
|
|
2647
|
-
"id": "agent:
|
|
2210
|
+
"id": "agent:mcp:update",
|
|
2648
2211
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2649
2212
|
"pluginName": "@salesforce/plugin-agent",
|
|
2650
2213
|
"pluginType": "core",
|
|
2214
|
+
"state": "preview",
|
|
2651
2215
|
"strict": true,
|
|
2652
|
-
"summary": "
|
|
2216
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2653
2217
|
"enableJsonFlag": true,
|
|
2654
|
-
"envVariablesSection": {
|
|
2655
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2656
|
-
"body": [
|
|
2657
|
-
{
|
|
2658
|
-
"name": "SF_TARGET_ORG",
|
|
2659
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2660
|
-
}
|
|
2661
|
-
]
|
|
2662
|
-
},
|
|
2663
|
-
"errorCodes": {
|
|
2664
|
-
"header": "ERROR CODES",
|
|
2665
|
-
"body": [
|
|
2666
|
-
{
|
|
2667
|
-
"name": "Succeeded (0)",
|
|
2668
|
-
"description": "Agent tests listed successfully."
|
|
2669
|
-
},
|
|
2670
|
-
{
|
|
2671
|
-
"name": "Failed (4)",
|
|
2672
|
-
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
2673
|
-
}
|
|
2674
|
-
]
|
|
2675
|
-
},
|
|
2676
2218
|
"isESM": true,
|
|
2677
2219
|
"relativePath": [
|
|
2678
2220
|
"lib",
|
|
2679
2221
|
"commands",
|
|
2680
2222
|
"agent",
|
|
2681
|
-
"
|
|
2682
|
-
"
|
|
2223
|
+
"mcp",
|
|
2224
|
+
"update.js"
|
|
2683
2225
|
],
|
|
2684
2226
|
"aliasPermutations": [],
|
|
2685
2227
|
"permutations": [
|
|
2686
|
-
"agent:
|
|
2687
|
-
"
|
|
2688
|
-
"
|
|
2689
|
-
"agent:
|
|
2690
|
-
"
|
|
2691
|
-
"
|
|
2228
|
+
"agent:mcp:update",
|
|
2229
|
+
"mcp:agent:update",
|
|
2230
|
+
"mcp:update:agent",
|
|
2231
|
+
"agent:update:mcp",
|
|
2232
|
+
"update:agent:mcp",
|
|
2233
|
+
"update:mcp:agent"
|
|
2692
2234
|
]
|
|
2693
2235
|
},
|
|
2694
|
-
"agent:
|
|
2236
|
+
"agent:preview:end": {
|
|
2695
2237
|
"aliases": [],
|
|
2696
2238
|
"args": {},
|
|
2697
|
-
"description": "This command
|
|
2239
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to end it. This command also displays the local directory where the session trace files are stored.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respectively. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nUse the --all flag to end all active preview sessions at once. You can combine --all with --api-name or --authoring-bundle to end only sessions for a specific agent, or use --all on its own to end every session across all agents in the project.",
|
|
2698
2240
|
"examples": [
|
|
2699
|
-
"
|
|
2700
|
-
"
|
|
2701
|
-
"
|
|
2241
|
+
"End a preview session of a published agent by specifying its session ID and API name; use the default org:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --api-name My_Published_Agent",
|
|
2242
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent --target-org my-dev-org",
|
|
2243
|
+
"End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than one active session.\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Local_Agent",
|
|
2244
|
+
"End all active preview sessions for a specific agent without prompting:\n<%= config.bin %> <%= command.id %> --all --authoring-bundle My_Local_Agent --target-org <target_org> --no-prompt",
|
|
2245
|
+
"End all active preview sessions across every agent in the local session cache for an org:\n<%= config.bin %> <%= command.id %> --all --target-org <target_org>"
|
|
2702
2246
|
],
|
|
2703
2247
|
"flags": {
|
|
2704
2248
|
"json": {
|
|
@@ -2733,67 +2277,65 @@
|
|
|
2733
2277
|
"multiple": false,
|
|
2734
2278
|
"type": "option"
|
|
2735
2279
|
},
|
|
2736
|
-
"
|
|
2737
|
-
"
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
"
|
|
2280
|
+
"session-id": {
|
|
2281
|
+
"exclusive": [
|
|
2282
|
+
"all"
|
|
2283
|
+
],
|
|
2284
|
+
"name": "session-id",
|
|
2285
|
+
"required": false,
|
|
2286
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see the list of all sessions.",
|
|
2741
2287
|
"hasDynamicHelp": false,
|
|
2742
2288
|
"multiple": false,
|
|
2743
2289
|
"type": "option"
|
|
2744
2290
|
},
|
|
2745
|
-
"
|
|
2746
|
-
"
|
|
2747
|
-
"
|
|
2748
|
-
|
|
2291
|
+
"api-name": {
|
|
2292
|
+
"char": "n",
|
|
2293
|
+
"exclusive": [
|
|
2294
|
+
"authoring-bundle"
|
|
2295
|
+
],
|
|
2296
|
+
"name": "api-name",
|
|
2297
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2749
2298
|
"hasDynamicHelp": false,
|
|
2750
2299
|
"multiple": false,
|
|
2751
|
-
"options": [
|
|
2752
|
-
"json",
|
|
2753
|
-
"human",
|
|
2754
|
-
"junit",
|
|
2755
|
-
"tap"
|
|
2756
|
-
],
|
|
2757
2300
|
"type": "option"
|
|
2758
2301
|
},
|
|
2759
|
-
"
|
|
2760
|
-
"
|
|
2761
|
-
|
|
2762
|
-
|
|
2763
|
-
"
|
|
2302
|
+
"authoring-bundle": {
|
|
2303
|
+
"exclusive": [
|
|
2304
|
+
"api-name"
|
|
2305
|
+
],
|
|
2306
|
+
"name": "authoring-bundle",
|
|
2307
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2764
2308
|
"hasDynamicHelp": false,
|
|
2765
2309
|
"multiple": false,
|
|
2766
2310
|
"type": "option"
|
|
2767
2311
|
},
|
|
2768
|
-
"
|
|
2769
|
-
"
|
|
2770
|
-
|
|
2771
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2772
|
-
"hasDynamicHelp": false,
|
|
2773
|
-
"multiple": false,
|
|
2774
|
-
"options": [
|
|
2775
|
-
"agentforce-studio",
|
|
2776
|
-
"testing-center"
|
|
2312
|
+
"all": {
|
|
2313
|
+
"exclusive": [
|
|
2314
|
+
"session-id"
|
|
2777
2315
|
],
|
|
2778
|
-
"
|
|
2316
|
+
"name": "all",
|
|
2317
|
+
"summary": "End all active preview sessions. Combine with --api-name or --authoring-bundle to limit to a specific agent, or use with only --target-org to end sessions for all agents found in the local session cache. Requires --target-org.",
|
|
2318
|
+
"allowNo": false,
|
|
2319
|
+
"type": "boolean"
|
|
2779
2320
|
},
|
|
2780
|
-
"
|
|
2781
|
-
"
|
|
2782
|
-
"name": "
|
|
2783
|
-
"summary": "
|
|
2321
|
+
"no-prompt": {
|
|
2322
|
+
"char": "p",
|
|
2323
|
+
"name": "no-prompt",
|
|
2324
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2784
2325
|
"allowNo": false,
|
|
2785
2326
|
"type": "boolean"
|
|
2786
2327
|
}
|
|
2787
2328
|
},
|
|
2788
2329
|
"hasDynamicHelp": true,
|
|
2789
2330
|
"hiddenAliases": [],
|
|
2790
|
-
"id": "agent:
|
|
2331
|
+
"id": "agent:preview:end",
|
|
2791
2332
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2792
2333
|
"pluginName": "@salesforce/plugin-agent",
|
|
2793
2334
|
"pluginType": "core",
|
|
2794
2335
|
"strict": true,
|
|
2795
|
-
"summary": "
|
|
2336
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
2796
2337
|
"enableJsonFlag": true,
|
|
2338
|
+
"requiresProject": true,
|
|
2797
2339
|
"envVariablesSection": {
|
|
2798
2340
|
"header": "ENVIRONMENT VARIABLES",
|
|
2799
2341
|
"body": [
|
|
@@ -2808,15 +2350,27 @@
|
|
|
2808
2350
|
"body": [
|
|
2809
2351
|
{
|
|
2810
2352
|
"name": "Succeeded (0)",
|
|
2811
|
-
"description": "
|
|
2353
|
+
"description": "Preview session ended successfully and traces saved."
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
"name": "ExactlyOneRequired (2)",
|
|
2357
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2812
2358
|
},
|
|
2813
2359
|
{
|
|
2814
2360
|
"name": "NotFound (2)",
|
|
2815
|
-
"description": "
|
|
2361
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2816
2362
|
},
|
|
2817
2363
|
{
|
|
2818
|
-
"name": "
|
|
2819
|
-
"description": "Failed to
|
|
2364
|
+
"name": "PreviewEndFailed (4)",
|
|
2365
|
+
"description": "Failed to end the preview session."
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
2369
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
"name": "SessionAmbiguous (5)",
|
|
2373
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2820
2374
|
}
|
|
2821
2375
|
]
|
|
2822
2376
|
},
|
|
@@ -2825,27 +2379,27 @@
|
|
|
2825
2379
|
"lib",
|
|
2826
2380
|
"commands",
|
|
2827
2381
|
"agent",
|
|
2828
|
-
"
|
|
2829
|
-
"
|
|
2382
|
+
"preview",
|
|
2383
|
+
"end.js"
|
|
2830
2384
|
],
|
|
2831
2385
|
"aliasPermutations": [],
|
|
2832
2386
|
"permutations": [
|
|
2833
|
-
"agent:
|
|
2834
|
-
"
|
|
2835
|
-
"
|
|
2836
|
-
"agent:
|
|
2837
|
-
"
|
|
2838
|
-
"
|
|
2387
|
+
"agent:preview:end",
|
|
2388
|
+
"preview:agent:end",
|
|
2389
|
+
"preview:end:agent",
|
|
2390
|
+
"agent:end:preview",
|
|
2391
|
+
"end:agent:preview",
|
|
2392
|
+
"end:preview:agent"
|
|
2839
2393
|
]
|
|
2840
2394
|
},
|
|
2841
|
-
"agent:
|
|
2395
|
+
"agent:preview:send": {
|
|
2842
2396
|
"aliases": [],
|
|
2843
2397
|
"args": {},
|
|
2844
|
-
"description": "
|
|
2398
|
+
"description": "You must have previously started a programmatic agent preview session with the \"agent preview start\" command to then use this command to send the agent a message (utterance). This command then displays the agent's response.\n\nThe original \"agent preview start\" command outputs a session ID which you then use with the --session-id flag of this command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.",
|
|
2845
2399
|
"examples": [
|
|
2846
|
-
"
|
|
2847
|
-
"
|
|
2848
|
-
"
|
|
2400
|
+
"Send a message to an activated published agent using its API name and session ID; use the default org:\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --session-id <SESSION_ID>",
|
|
2401
|
+
"Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active session. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --utterance \"What can you help me with?\" --api-name My_Published_Agent --target-org my-dev-org",
|
|
2402
|
+
"Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one active session:\n<%= config.bin %> <%= command.id %> --utterance \"what can you help me with?\" --authoring-bundle My_Local_Agent"
|
|
2849
2403
|
],
|
|
2850
2404
|
"flags": {
|
|
2851
2405
|
"json": {
|
|
@@ -2880,82 +2434,49 @@
|
|
|
2880
2434
|
"multiple": false,
|
|
2881
2435
|
"type": "option"
|
|
2882
2436
|
},
|
|
2883
|
-
"
|
|
2884
|
-
"
|
|
2885
|
-
"
|
|
2886
|
-
"summary": "
|
|
2437
|
+
"session-id": {
|
|
2438
|
+
"name": "session-id",
|
|
2439
|
+
"required": false,
|
|
2440
|
+
"summary": "Session ID outputted by \"agent preview start\". Not required when the agent has exactly one active session. Run \"agent preview sessions\" to see list of all sessions.",
|
|
2887
2441
|
"hasDynamicHelp": false,
|
|
2888
2442
|
"multiple": false,
|
|
2889
2443
|
"type": "option"
|
|
2890
2444
|
},
|
|
2891
|
-
"
|
|
2892
|
-
"char": "
|
|
2893
|
-
"name": "
|
|
2894
|
-
"
|
|
2895
|
-
"
|
|
2896
|
-
"type": "boolean"
|
|
2897
|
-
},
|
|
2898
|
-
"wait": {
|
|
2899
|
-
"char": "w",
|
|
2900
|
-
"name": "wait",
|
|
2901
|
-
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
2902
|
-
"default": "5 minutes",
|
|
2903
|
-
"hasDynamicHelp": true,
|
|
2904
|
-
"multiple": false,
|
|
2905
|
-
"type": "option"
|
|
2906
|
-
},
|
|
2907
|
-
"result-format": {
|
|
2908
|
-
"name": "result-format",
|
|
2909
|
-
"summary": "Format of the agent test run results.",
|
|
2910
|
-
"default": "human",
|
|
2445
|
+
"utterance": {
|
|
2446
|
+
"char": "u",
|
|
2447
|
+
"name": "utterance",
|
|
2448
|
+
"required": true,
|
|
2449
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
2911
2450
|
"hasDynamicHelp": false,
|
|
2912
2451
|
"multiple": false,
|
|
2913
|
-
"options": [
|
|
2914
|
-
"json",
|
|
2915
|
-
"human",
|
|
2916
|
-
"junit",
|
|
2917
|
-
"tap"
|
|
2918
|
-
],
|
|
2919
2452
|
"type": "option"
|
|
2920
2453
|
},
|
|
2921
|
-
"
|
|
2922
|
-
"char": "
|
|
2923
|
-
"
|
|
2924
|
-
"
|
|
2925
|
-
"summary": "Directory to write the agent test results into.",
|
|
2454
|
+
"api-name": {
|
|
2455
|
+
"char": "n",
|
|
2456
|
+
"name": "api-name",
|
|
2457
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2926
2458
|
"hasDynamicHelp": false,
|
|
2927
2459
|
"multiple": false,
|
|
2928
2460
|
"type": "option"
|
|
2929
2461
|
},
|
|
2930
|
-
"
|
|
2931
|
-
"
|
|
2932
|
-
"
|
|
2933
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
2462
|
+
"authoring-bundle": {
|
|
2463
|
+
"name": "authoring-bundle",
|
|
2464
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2934
2465
|
"hasDynamicHelp": false,
|
|
2935
2466
|
"multiple": false,
|
|
2936
|
-
"options": [
|
|
2937
|
-
"agentforce-studio",
|
|
2938
|
-
"testing-center"
|
|
2939
|
-
],
|
|
2940
2467
|
"type": "option"
|
|
2941
|
-
},
|
|
2942
|
-
"verbose": {
|
|
2943
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
2944
|
-
"name": "verbose",
|
|
2945
|
-
"summary": "Show generated data in the test results output.",
|
|
2946
|
-
"allowNo": false,
|
|
2947
|
-
"type": "boolean"
|
|
2948
2468
|
}
|
|
2949
2469
|
},
|
|
2950
2470
|
"hasDynamicHelp": true,
|
|
2951
2471
|
"hiddenAliases": [],
|
|
2952
|
-
"id": "agent:
|
|
2472
|
+
"id": "agent:preview:send",
|
|
2953
2473
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2954
2474
|
"pluginName": "@salesforce/plugin-agent",
|
|
2955
2475
|
"pluginType": "core",
|
|
2956
2476
|
"strict": true,
|
|
2957
|
-
"summary": "
|
|
2477
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
2958
2478
|
"enableJsonFlag": true,
|
|
2479
|
+
"requiresProject": true,
|
|
2959
2480
|
"envVariablesSection": {
|
|
2960
2481
|
"header": "ENVIRONMENT VARIABLES",
|
|
2961
2482
|
"body": [
|
|
@@ -2970,19 +2491,19 @@
|
|
|
2970
2491
|
"body": [
|
|
2971
2492
|
{
|
|
2972
2493
|
"name": "Succeeded (0)",
|
|
2973
|
-
"description": "
|
|
2494
|
+
"description": "Message sent successfully and agent response received."
|
|
2974
2495
|
},
|
|
2975
2496
|
{
|
|
2976
|
-
"name": "
|
|
2977
|
-
"description": "
|
|
2497
|
+
"name": "NotFound (2)",
|
|
2498
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
2978
2499
|
},
|
|
2979
2500
|
{
|
|
2980
|
-
"name": "
|
|
2981
|
-
"description": "
|
|
2501
|
+
"name": "PreviewSendFailed (4)",
|
|
2502
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
2982
2503
|
},
|
|
2983
2504
|
{
|
|
2984
|
-
"name": "
|
|
2985
|
-
"description": "
|
|
2505
|
+
"name": "SessionAmbiguous (5)",
|
|
2506
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2986
2507
|
}
|
|
2987
2508
|
]
|
|
2988
2509
|
},
|
|
@@ -2991,30 +2512,88 @@
|
|
|
2991
2512
|
"lib",
|
|
2992
2513
|
"commands",
|
|
2993
2514
|
"agent",
|
|
2994
|
-
"
|
|
2995
|
-
"
|
|
2515
|
+
"preview",
|
|
2516
|
+
"send.js"
|
|
2996
2517
|
],
|
|
2997
2518
|
"aliasPermutations": [],
|
|
2998
2519
|
"permutations": [
|
|
2999
|
-
"agent:
|
|
3000
|
-
"
|
|
3001
|
-
"
|
|
3002
|
-
"agent:
|
|
3003
|
-
"
|
|
3004
|
-
"
|
|
2520
|
+
"agent:preview:send",
|
|
2521
|
+
"preview:agent:send",
|
|
2522
|
+
"preview:send:agent",
|
|
2523
|
+
"agent:send:preview",
|
|
2524
|
+
"send:agent:preview",
|
|
2525
|
+
"send:preview:agent"
|
|
2526
|
+
]
|
|
2527
|
+
},
|
|
2528
|
+
"agent:preview:sessions": {
|
|
2529
|
+
"aliases": [],
|
|
2530
|
+
"args": {},
|
|
2531
|
+
"description": "This command lists the agent preview sessions that were started with the \"agent preview start\" command and are still in the local cache. Use this command to discover specific session IDs that you can pass to the \"agent preview send\" or \"agent preview end\" commands with the --session-id flag.\n\nProgrammatic agent preview sessions can be started for both published activated agents and by using an agent's local authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In the table, if the same API name has multiple rows with different session IDs, then it means that you previously started multiple preview sessions with the associated agent.",
|
|
2532
|
+
"examples": [
|
|
2533
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
2534
|
+
],
|
|
2535
|
+
"flags": {
|
|
2536
|
+
"json": {
|
|
2537
|
+
"description": "Format output as json.",
|
|
2538
|
+
"helpGroup": "GLOBAL",
|
|
2539
|
+
"name": "json",
|
|
2540
|
+
"allowNo": false,
|
|
2541
|
+
"type": "boolean"
|
|
2542
|
+
},
|
|
2543
|
+
"flags-dir": {
|
|
2544
|
+
"helpGroup": "GLOBAL",
|
|
2545
|
+
"name": "flags-dir",
|
|
2546
|
+
"summary": "Import flag values from a directory.",
|
|
2547
|
+
"hasDynamicHelp": false,
|
|
2548
|
+
"multiple": false,
|
|
2549
|
+
"type": "option"
|
|
2550
|
+
}
|
|
2551
|
+
},
|
|
2552
|
+
"hasDynamicHelp": false,
|
|
2553
|
+
"hiddenAliases": [],
|
|
2554
|
+
"id": "agent:preview:sessions",
|
|
2555
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
2556
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
2557
|
+
"pluginType": "core",
|
|
2558
|
+
"strict": true,
|
|
2559
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
2560
|
+
"enableJsonFlag": true,
|
|
2561
|
+
"requiresProject": true,
|
|
2562
|
+
"errorCodes": {
|
|
2563
|
+
"header": "ERROR CODES",
|
|
2564
|
+
"body": [
|
|
2565
|
+
{
|
|
2566
|
+
"name": "Succeeded (0)",
|
|
2567
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2568
|
+
}
|
|
2569
|
+
]
|
|
2570
|
+
},
|
|
2571
|
+
"isESM": true,
|
|
2572
|
+
"relativePath": [
|
|
2573
|
+
"lib",
|
|
2574
|
+
"commands",
|
|
2575
|
+
"agent",
|
|
2576
|
+
"preview",
|
|
2577
|
+
"sessions.js"
|
|
2578
|
+
],
|
|
2579
|
+
"aliasPermutations": [],
|
|
2580
|
+
"permutations": [
|
|
2581
|
+
"agent:preview:sessions",
|
|
2582
|
+
"preview:agent:sessions",
|
|
2583
|
+
"preview:sessions:agent",
|
|
2584
|
+
"agent:sessions:preview",
|
|
2585
|
+
"sessions:agent:preview",
|
|
2586
|
+
"sessions:preview:agent"
|
|
3005
2587
|
]
|
|
3006
2588
|
},
|
|
3007
|
-
"agent:
|
|
2589
|
+
"agent:preview:start": {
|
|
3008
2590
|
"aliases": [],
|
|
3009
2591
|
"args": {},
|
|
3010
|
-
"description": "
|
|
2592
|
+
"description": "This command outputs a session ID that you then use with the \"agent preview send\" command to send an utterance to the agent. Use the \"agent preview sessions\" command to list all active sessions and the \"agent preview end\" command to end a specific session.\n\nIdentify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name under the \"aiAuthoringBundles\" metadata directory. Similarly, the published agent's API name is the same as its directory name under the \"Bots\" metadata directory.\n\nWhen starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of these flags:\n\n- --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and validation errors during preview.\n- --simulate-actions: Uses AI to simulate action execution without calling real implementations.\n\nPublished agents (--api-name) always use live actions. The mode flags are optional and have no effect for published agents.",
|
|
3011
2593
|
"examples": [
|
|
3012
|
-
"
|
|
3013
|
-
"
|
|
3014
|
-
"
|
|
3015
|
-
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
3016
|
-
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3017
|
-
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
2594
|
+
"Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions",
|
|
2595
|
+
"Similar to previous example but use live actions and the default org:\n<%= config.bin %> <%= command.id %> --authoring-bundle My_Agent_Bundle --use-live-actions",
|
|
2596
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
3018
2597
|
],
|
|
3019
2598
|
"flags": {
|
|
3020
2599
|
"json": {
|
|
@@ -3049,62 +2628,78 @@
|
|
|
3049
2628
|
"multiple": false,
|
|
3050
2629
|
"type": "option"
|
|
3051
2630
|
},
|
|
3052
|
-
"spec": {
|
|
3053
|
-
"char": "s",
|
|
3054
|
-
"name": "spec",
|
|
3055
|
-
"required": true,
|
|
3056
|
-
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3057
|
-
"hasDynamicHelp": false,
|
|
3058
|
-
"multiple": false,
|
|
3059
|
-
"type": "option"
|
|
3060
|
-
},
|
|
3061
2631
|
"api-name": {
|
|
3062
2632
|
"char": "n",
|
|
3063
2633
|
"name": "api-name",
|
|
3064
|
-
"summary": "
|
|
2634
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
3065
2635
|
"hasDynamicHelp": false,
|
|
3066
2636
|
"multiple": false,
|
|
3067
2637
|
"type": "option"
|
|
3068
2638
|
},
|
|
3069
|
-
"
|
|
3070
|
-
"name": "
|
|
3071
|
-
"summary": "
|
|
3072
|
-
"default": "human",
|
|
2639
|
+
"authoring-bundle": {
|
|
2640
|
+
"name": "authoring-bundle",
|
|
2641
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
3073
2642
|
"hasDynamicHelp": false,
|
|
3074
2643
|
"multiple": false,
|
|
3075
|
-
"
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
"
|
|
2644
|
+
"type": "option"
|
|
2645
|
+
},
|
|
2646
|
+
"use-live-actions": {
|
|
2647
|
+
"exclusive": [
|
|
2648
|
+
"simulate-actions"
|
|
2649
|
+
],
|
|
2650
|
+
"name": "use-live-actions",
|
|
2651
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2652
|
+
"allowNo": false,
|
|
2653
|
+
"type": "boolean"
|
|
2654
|
+
},
|
|
2655
|
+
"simulate-actions": {
|
|
2656
|
+
"exclusive": [
|
|
2657
|
+
"use-live-actions"
|
|
3080
2658
|
],
|
|
2659
|
+
"name": "simulate-actions",
|
|
2660
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2661
|
+
"allowNo": false,
|
|
2662
|
+
"type": "boolean"
|
|
2663
|
+
},
|
|
2664
|
+
"context-variables": {
|
|
2665
|
+
"description": "Sets variables on the agent preview session, mirroring what the in-org Agentforce Builder UI does when you override variables before sending a message. Specify this flag multiple times or use comma-separated values. Two namespaces are supported, distinguished by the name shape. Names pass through to the runtime verbatim — the CLI doesn't transform them.\n\nLinked context variables use the \"$Context.\" prefix. These map to externally-provided fields that the runtime resolves (declared in the bundle's globalConfiguration.contextVariables) and are read by live actions and topic-routing expressions via $Context.Name. Example: $Context.MyLinkedVar=some-value.\n\nState variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.\n\nBoth namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.\n\nTips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.",
|
|
2666
|
+
"name": "context-variables",
|
|
2667
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2668
|
+
"delimiter": ",",
|
|
2669
|
+
"hasDynamicHelp": false,
|
|
2670
|
+
"multiple": true,
|
|
3081
2671
|
"type": "option"
|
|
3082
2672
|
},
|
|
3083
|
-
"
|
|
3084
|
-
"name": "
|
|
3085
|
-
"
|
|
3086
|
-
"
|
|
2673
|
+
"context-variables-json": {
|
|
2674
|
+
"description": "Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a Number, Object, List, or Json value.\n\nThe value is a JSON array of objects, each with a \"name\", a \"type\", and an optional \"value\". The \"type\" is one of Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of \"value\" must match \"type\": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an array, and Json takes an object.\n\nExample: --context-variables-json '[{\"name\":\"probeGate\",\"type\":\"Boolean\",\"value\":true},{\"name\":\"retryCount\",\"type\":\"Number\",\"value\":3}]'.\n\nYou can pass both --context-variables and --context-variables-json in the same command. When the same variable name appears in both, the --context-variables-json value wins.\n\nTip: names follow the same rules as --context-variables. Use the \"$Context.\" prefix for linked context variables, and a bare name for state variables.",
|
|
2675
|
+
"name": "context-variables-json",
|
|
2676
|
+
"summary": "Typed session variables for the agent preview session, as a JSON array.",
|
|
3087
2677
|
"hasDynamicHelp": false,
|
|
3088
2678
|
"multiple": false,
|
|
3089
2679
|
"type": "option"
|
|
3090
2680
|
},
|
|
3091
|
-
"
|
|
3092
|
-
"
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
"
|
|
2681
|
+
"agent-json": {
|
|
2682
|
+
"dependsOn": [
|
|
2683
|
+
"authoring-bundle"
|
|
2684
|
+
],
|
|
2685
|
+
"hidden": true,
|
|
2686
|
+
"name": "agent-json",
|
|
2687
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2688
|
+
"hasDynamicHelp": false,
|
|
2689
|
+
"multiple": false,
|
|
2690
|
+
"type": "option"
|
|
3096
2691
|
}
|
|
3097
2692
|
},
|
|
3098
2693
|
"hasDynamicHelp": true,
|
|
3099
2694
|
"hiddenAliases": [],
|
|
3100
|
-
"id": "agent:
|
|
2695
|
+
"id": "agent:preview:start",
|
|
3101
2696
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3102
2697
|
"pluginName": "@salesforce/plugin-agent",
|
|
3103
2698
|
"pluginType": "core",
|
|
3104
|
-
"state": "beta",
|
|
3105
2699
|
"strict": true,
|
|
3106
|
-
"summary": "
|
|
2700
|
+
"summary": "Start a programmatic agent preview session.",
|
|
3107
2701
|
"enableJsonFlag": true,
|
|
2702
|
+
"requiresProject": true,
|
|
3108
2703
|
"envVariablesSection": {
|
|
3109
2704
|
"header": "ENVIRONMENT VARIABLES",
|
|
3110
2705
|
"body": [
|
|
@@ -3119,19 +2714,23 @@
|
|
|
3119
2714
|
"body": [
|
|
3120
2715
|
{
|
|
3121
2716
|
"name": "Succeeded (0)",
|
|
3122
|
-
"description": "
|
|
2717
|
+
"description": "Preview session started successfully."
|
|
3123
2718
|
},
|
|
3124
2719
|
{
|
|
3125
2720
|
"name": "Failed (1)",
|
|
3126
|
-
"description": "
|
|
2721
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
3127
2722
|
},
|
|
3128
2723
|
{
|
|
3129
2724
|
"name": "NotFound (2)",
|
|
3130
|
-
"description": "Agent not found,
|
|
2725
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
3131
2726
|
},
|
|
3132
2727
|
{
|
|
3133
|
-
"name": "
|
|
3134
|
-
"description": "
|
|
2728
|
+
"name": "ServerError (3)",
|
|
2729
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
"name": "PreviewStartFailed (4)",
|
|
2733
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
3135
2734
|
}
|
|
3136
2735
|
]
|
|
3137
2736
|
},
|
|
@@ -3140,27 +2739,28 @@
|
|
|
3140
2739
|
"lib",
|
|
3141
2740
|
"commands",
|
|
3142
2741
|
"agent",
|
|
3143
|
-
"
|
|
3144
|
-
"
|
|
2742
|
+
"preview",
|
|
2743
|
+
"start.js"
|
|
3145
2744
|
],
|
|
3146
2745
|
"aliasPermutations": [],
|
|
3147
2746
|
"permutations": [
|
|
3148
|
-
"agent:
|
|
3149
|
-
"
|
|
3150
|
-
"
|
|
3151
|
-
"agent:
|
|
3152
|
-
"
|
|
3153
|
-
"
|
|
2747
|
+
"agent:preview:start",
|
|
2748
|
+
"preview:agent:start",
|
|
2749
|
+
"preview:start:agent",
|
|
2750
|
+
"agent:start:preview",
|
|
2751
|
+
"start:agent:preview",
|
|
2752
|
+
"start:preview:agent"
|
|
3154
2753
|
]
|
|
3155
2754
|
},
|
|
3156
|
-
"agent:
|
|
2755
|
+
"agent:publish:authoring-bundle": {
|
|
3157
2756
|
"aliases": [],
|
|
3158
2757
|
"args": {},
|
|
3159
|
-
"description": "
|
|
2758
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nWhen you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.\n\nThis command uses the API name of the authoring bundle.",
|
|
3160
2759
|
"examples": [
|
|
3161
|
-
"
|
|
3162
|
-
"
|
|
3163
|
-
"
|
|
2760
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2761
|
+
"Publish an authoring bundle with API name MyAuthoringBundle to the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --target-org my-dev-org",
|
|
2762
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2763
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
3164
2764
|
],
|
|
3165
2765
|
"flags": {
|
|
3166
2766
|
"json": {
|
|
@@ -3198,127 +2798,95 @@
|
|
|
3198
2798
|
"api-name": {
|
|
3199
2799
|
"char": "n",
|
|
3200
2800
|
"name": "api-name",
|
|
3201
|
-
"summary": "API name of the
|
|
2801
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3202
2802
|
"hasDynamicHelp": false,
|
|
3203
2803
|
"multiple": false,
|
|
3204
2804
|
"type": "option"
|
|
3205
2805
|
},
|
|
3206
|
-
"
|
|
3207
|
-
"
|
|
3208
|
-
"
|
|
3209
|
-
"
|
|
3210
|
-
"
|
|
3211
|
-
"multiple": false,
|
|
3212
|
-
"type": "option"
|
|
2806
|
+
"skip-retrieve": {
|
|
2807
|
+
"name": "skip-retrieve",
|
|
2808
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
2809
|
+
"allowNo": false,
|
|
2810
|
+
"type": "boolean"
|
|
3213
2811
|
},
|
|
3214
|
-
"
|
|
3215
|
-
"
|
|
3216
|
-
"
|
|
3217
|
-
|
|
3218
|
-
"hasDynamicHelp": false,
|
|
3219
|
-
"multiple": false,
|
|
3220
|
-
"options": [
|
|
3221
|
-
"json",
|
|
3222
|
-
"human",
|
|
3223
|
-
"junit",
|
|
3224
|
-
"tap"
|
|
2812
|
+
"verbose": {
|
|
2813
|
+
"char": "v",
|
|
2814
|
+
"exclusive": [
|
|
2815
|
+
"concise"
|
|
3225
2816
|
],
|
|
3226
|
-
"
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
"
|
|
3230
|
-
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3231
|
-
"name": "output-dir",
|
|
3232
|
-
"summary": "Directory to write the agent test results into.",
|
|
3233
|
-
"hasDynamicHelp": false,
|
|
3234
|
-
"multiple": false,
|
|
3235
|
-
"type": "option"
|
|
2817
|
+
"name": "verbose",
|
|
2818
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2819
|
+
"allowNo": false,
|
|
2820
|
+
"type": "boolean"
|
|
3236
2821
|
},
|
|
3237
|
-
"
|
|
3238
|
-
"
|
|
3239
|
-
|
|
3240
|
-
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3241
|
-
"hasDynamicHelp": false,
|
|
3242
|
-
"multiple": false,
|
|
3243
|
-
"options": [
|
|
3244
|
-
"agentforce-studio",
|
|
3245
|
-
"testing-center"
|
|
2822
|
+
"concise": {
|
|
2823
|
+
"exclusive": [
|
|
2824
|
+
"verbose"
|
|
3246
2825
|
],
|
|
3247
|
-
"
|
|
3248
|
-
|
|
3249
|
-
"verbose": {
|
|
3250
|
-
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3251
|
-
"name": "verbose",
|
|
3252
|
-
"summary": "Show generated data in the test results output.",
|
|
2826
|
+
"name": "concise",
|
|
2827
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
3253
2828
|
"allowNo": false,
|
|
3254
2829
|
"type": "boolean"
|
|
3255
2830
|
}
|
|
3256
2831
|
},
|
|
3257
2832
|
"hasDynamicHelp": true,
|
|
3258
2833
|
"hiddenAliases": [],
|
|
3259
|
-
"id": "agent:
|
|
2834
|
+
"id": "agent:publish:authoring-bundle",
|
|
3260
2835
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3261
2836
|
"pluginName": "@salesforce/plugin-agent",
|
|
3262
2837
|
"pluginType": "core",
|
|
3263
2838
|
"strict": true,
|
|
3264
|
-
"summary": "
|
|
2839
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
3265
2840
|
"enableJsonFlag": true,
|
|
3266
|
-
"
|
|
3267
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
3268
|
-
"body": [
|
|
3269
|
-
{
|
|
3270
|
-
"name": "SF_TARGET_ORG",
|
|
3271
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3272
|
-
}
|
|
3273
|
-
]
|
|
3274
|
-
},
|
|
2841
|
+
"requiresProject": true,
|
|
3275
2842
|
"errorCodes": {
|
|
3276
2843
|
"header": "ERROR CODES",
|
|
3277
2844
|
"body": [
|
|
3278
2845
|
{
|
|
3279
2846
|
"name": "Succeeded (0)",
|
|
3280
|
-
"description": "
|
|
2847
|
+
"description": "Agent published successfully without errors."
|
|
3281
2848
|
},
|
|
3282
2849
|
{
|
|
3283
2850
|
"name": "Failed (1)",
|
|
3284
|
-
"description": "
|
|
3285
|
-
},
|
|
3286
|
-
{
|
|
3287
|
-
"name": "NotFound (2)",
|
|
3288
|
-
"description": "Test definition not found or invalid test name."
|
|
3289
|
-
},
|
|
3290
|
-
{
|
|
3291
|
-
"name": "OperationFailed (4)",
|
|
3292
|
-
"description": "Failed to start or poll test due to API or network errors."
|
|
2851
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
3293
2852
|
}
|
|
3294
2853
|
]
|
|
3295
2854
|
},
|
|
2855
|
+
"FLAGGABLE_PROMPTS": {
|
|
2856
|
+
"api-name": {
|
|
2857
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2858
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
2859
|
+
}
|
|
2860
|
+
},
|
|
3296
2861
|
"isESM": true,
|
|
3297
2862
|
"relativePath": [
|
|
3298
2863
|
"lib",
|
|
3299
2864
|
"commands",
|
|
3300
2865
|
"agent",
|
|
3301
|
-
"
|
|
3302
|
-
"
|
|
2866
|
+
"publish",
|
|
2867
|
+
"authoring-bundle.js"
|
|
3303
2868
|
],
|
|
3304
2869
|
"aliasPermutations": [],
|
|
3305
2870
|
"permutations": [
|
|
3306
|
-
"agent:
|
|
3307
|
-
"
|
|
3308
|
-
"
|
|
3309
|
-
"agent:
|
|
3310
|
-
"
|
|
3311
|
-
"
|
|
2871
|
+
"agent:publish:authoring-bundle",
|
|
2872
|
+
"publish:agent:authoring-bundle",
|
|
2873
|
+
"publish:authoring-bundle:agent",
|
|
2874
|
+
"agent:authoring-bundle:publish",
|
|
2875
|
+
"authoring-bundle:agent:publish",
|
|
2876
|
+
"authoring-bundle:publish:agent"
|
|
3312
2877
|
]
|
|
3313
2878
|
},
|
|
3314
|
-
"agent:
|
|
2879
|
+
"agent:trace:delete": {
|
|
3315
2880
|
"aliases": [],
|
|
3316
2881
|
"args": {},
|
|
3317
|
-
"description": "
|
|
2882
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. Use this command to delete some or all of the trace files.\n\nBy default, this command shows a preview of what will be deleted and prompts for confirmation. Use --no-prompt to skip confirmation.\n\nWithout filters, this comamnd deletes all trace files for all agents and sessions. Use flags to narrow the scope: filter by agent API name (--agent), by session (--session-id), or by age (--older-than).",
|
|
3318
2883
|
"examples": [
|
|
3319
|
-
"
|
|
3320
|
-
"
|
|
3321
|
-
"
|
|
2884
|
+
"Delete all traces for all agents and sessions; prompt for confirmation:\n<%= config.bin %> <%= command.id %>",
|
|
2885
|
+
"Delete all traces for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
2886
|
+
"Delete traces from a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2887
|
+
"Delete traces older than 7 days:\n<%= config.bin %> <%= command.id %> --older-than 7d",
|
|
2888
|
+
"Delete traces older than 24 hours for a specific agent; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --agent My_Agent --older-than 24h --no-prompt",
|
|
2889
|
+
"Delete all traces for all agents and sessions; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --no-prompt"
|
|
3322
2890
|
],
|
|
3323
2891
|
"flags": {
|
|
3324
2892
|
"json": {
|
|
@@ -3336,155 +2904,84 @@
|
|
|
3336
2904
|
"multiple": false,
|
|
3337
2905
|
"type": "option"
|
|
3338
2906
|
},
|
|
3339
|
-
"
|
|
3340
|
-
"char": "
|
|
3341
|
-
"name": "
|
|
3342
|
-
"
|
|
3343
|
-
"required": true,
|
|
3344
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3345
|
-
"hasDynamicHelp": true,
|
|
3346
|
-
"multiple": false,
|
|
3347
|
-
"type": "option"
|
|
3348
|
-
},
|
|
3349
|
-
"api-version": {
|
|
3350
|
-
"description": "Override the api version used for api requests made by this command",
|
|
3351
|
-
"name": "api-version",
|
|
3352
|
-
"hasDynamicHelp": false,
|
|
3353
|
-
"multiple": false,
|
|
3354
|
-
"type": "option"
|
|
3355
|
-
},
|
|
3356
|
-
"name": {
|
|
3357
|
-
"char": "n",
|
|
3358
|
-
"name": "name",
|
|
3359
|
-
"required": true,
|
|
3360
|
-
"summary": "Display name for the data library (max 80 characters).",
|
|
3361
|
-
"hasDynamicHelp": false,
|
|
3362
|
-
"multiple": false,
|
|
3363
|
-
"type": "option"
|
|
3364
|
-
},
|
|
3365
|
-
"developer-name": {
|
|
3366
|
-
"name": "developer-name",
|
|
3367
|
-
"required": true,
|
|
3368
|
-
"summary": "API name for the data library (max 80 characters, alphanumeric and underscores only, must start with a letter).",
|
|
3369
|
-
"hasDynamicHelp": false,
|
|
3370
|
-
"multiple": false,
|
|
3371
|
-
"type": "option"
|
|
3372
|
-
},
|
|
3373
|
-
"source-type": {
|
|
3374
|
-
"name": "source-type",
|
|
3375
|
-
"required": true,
|
|
3376
|
-
"summary": "Type of grounding source: sfdrive (file upload), knowledge (Salesforce Knowledge articles), or retriever (existing active Custom Retriever).",
|
|
3377
|
-
"hasDynamicHelp": false,
|
|
3378
|
-
"multiple": false,
|
|
3379
|
-
"options": [
|
|
3380
|
-
"sfdrive",
|
|
3381
|
-
"knowledge",
|
|
3382
|
-
"retriever"
|
|
3383
|
-
],
|
|
3384
|
-
"type": "option"
|
|
3385
|
-
},
|
|
3386
|
-
"description": {
|
|
3387
|
-
"name": "description",
|
|
3388
|
-
"summary": "Description of the data library (max 255 characters).",
|
|
3389
|
-
"hasDynamicHelp": false,
|
|
3390
|
-
"multiple": false,
|
|
3391
|
-
"type": "option"
|
|
3392
|
-
},
|
|
3393
|
-
"index-mode": {
|
|
3394
|
-
"name": "index-mode",
|
|
3395
|
-
"summary": "Index mode for SFDRIVE libraries: basic or enhanced.",
|
|
3396
|
-
"hasDynamicHelp": false,
|
|
3397
|
-
"multiple": false,
|
|
3398
|
-
"options": [
|
|
3399
|
-
"basic",
|
|
3400
|
-
"enhanced"
|
|
3401
|
-
],
|
|
3402
|
-
"type": "option"
|
|
3403
|
-
},
|
|
3404
|
-
"retriever-id": {
|
|
3405
|
-
"name": "retriever-id",
|
|
3406
|
-
"summary": "ID of an active Custom Retriever (required for RETRIEVER source type; retriever must be active).",
|
|
3407
|
-
"hasDynamicHelp": false,
|
|
3408
|
-
"multiple": false,
|
|
3409
|
-
"type": "option"
|
|
3410
|
-
},
|
|
3411
|
-
"primary-index-field1": {
|
|
3412
|
-
"name": "primary-index-field1",
|
|
3413
|
-
"summary": "Primary index field 1 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
3414
|
-
"hasDynamicHelp": false,
|
|
3415
|
-
"multiple": false,
|
|
3416
|
-
"type": "option"
|
|
3417
|
-
},
|
|
3418
|
-
"primary-index-field2": {
|
|
3419
|
-
"name": "primary-index-field2",
|
|
3420
|
-
"summary": "Primary index field 2 for KNOWLEDGE libraries (required, immutable after creation).",
|
|
3421
|
-
"hasDynamicHelp": false,
|
|
3422
|
-
"multiple": false,
|
|
3423
|
-
"type": "option"
|
|
3424
|
-
},
|
|
3425
|
-
"content-fields": {
|
|
3426
|
-
"name": "content-fields",
|
|
3427
|
-
"summary": "Comma-separated list of content fields for KNOWLEDGE libraries (optional, mutable after creation).",
|
|
2907
|
+
"agent": {
|
|
2908
|
+
"char": "a",
|
|
2909
|
+
"name": "agent",
|
|
2910
|
+
"summary": "API name of the agent used to filter the list of trace files you want to delete. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
3428
2911
|
"hasDynamicHelp": false,
|
|
3429
2912
|
"multiple": false,
|
|
3430
2913
|
"type": "option"
|
|
3431
2914
|
},
|
|
3432
|
-
"
|
|
3433
|
-
"name": "
|
|
3434
|
-
"summary": "
|
|
2915
|
+
"session-id": {
|
|
2916
|
+
"name": "session-id",
|
|
2917
|
+
"summary": "Session ID used to filter the list of trace files you want to delete. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs.",
|
|
3435
2918
|
"hasDynamicHelp": false,
|
|
3436
2919
|
"multiple": false,
|
|
3437
2920
|
"type": "option"
|
|
3438
2921
|
},
|
|
3439
|
-
"
|
|
3440
|
-
"name": "
|
|
3441
|
-
"summary": "
|
|
2922
|
+
"older-than": {
|
|
2923
|
+
"name": "older-than",
|
|
2924
|
+
"summary": "Duration used to filter the list of trace files; only files older than the duration are deleted. Accepts a number followed by a unit: m/minutes, h/hours, d/days, w/weeks. Examples: 7d, 24h, 2w.",
|
|
3442
2925
|
"hasDynamicHelp": false,
|
|
3443
2926
|
"multiple": false,
|
|
3444
2927
|
"type": "option"
|
|
3445
2928
|
},
|
|
3446
|
-
"
|
|
3447
|
-
"
|
|
3448
|
-
"
|
|
3449
|
-
"
|
|
3450
|
-
"
|
|
3451
|
-
"multiple": false,
|
|
3452
|
-
"type": "option"
|
|
2929
|
+
"no-prompt": {
|
|
2930
|
+
"name": "no-prompt",
|
|
2931
|
+
"summary": "Skip the confirmation prompt and delete immediately.",
|
|
2932
|
+
"allowNo": false,
|
|
2933
|
+
"type": "boolean"
|
|
3453
2934
|
}
|
|
3454
2935
|
},
|
|
3455
|
-
"hasDynamicHelp":
|
|
2936
|
+
"hasDynamicHelp": false,
|
|
3456
2937
|
"hiddenAliases": [],
|
|
3457
|
-
"id": "agent:
|
|
2938
|
+
"id": "agent:trace:delete",
|
|
3458
2939
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3459
2940
|
"pluginName": "@salesforce/plugin-agent",
|
|
3460
2941
|
"pluginType": "core",
|
|
3461
2942
|
"strict": true,
|
|
3462
|
-
"summary": "
|
|
2943
|
+
"summary": "Delete trace files from an agent preview session.",
|
|
3463
2944
|
"enableJsonFlag": true,
|
|
2945
|
+
"requiresProject": true,
|
|
2946
|
+
"errorCodes": {
|
|
2947
|
+
"header": "ERROR CODES",
|
|
2948
|
+
"body": [
|
|
2949
|
+
{
|
|
2950
|
+
"name": "Succeeded (0)",
|
|
2951
|
+
"description": "Traces deleted successfully (or no traces matched)."
|
|
2952
|
+
}
|
|
2953
|
+
]
|
|
2954
|
+
},
|
|
3464
2955
|
"isESM": true,
|
|
3465
2956
|
"relativePath": [
|
|
3466
2957
|
"lib",
|
|
3467
2958
|
"commands",
|
|
3468
2959
|
"agent",
|
|
3469
|
-
"
|
|
3470
|
-
"
|
|
2960
|
+
"trace",
|
|
2961
|
+
"delete.js"
|
|
3471
2962
|
],
|
|
3472
2963
|
"aliasPermutations": [],
|
|
3473
2964
|
"permutations": [
|
|
3474
|
-
"agent:
|
|
3475
|
-
"
|
|
3476
|
-
"
|
|
3477
|
-
"agent:
|
|
3478
|
-
"
|
|
3479
|
-
"
|
|
2965
|
+
"agent:trace:delete",
|
|
2966
|
+
"trace:agent:delete",
|
|
2967
|
+
"trace:delete:agent",
|
|
2968
|
+
"agent:delete:trace",
|
|
2969
|
+
"delete:agent:trace",
|
|
2970
|
+
"delete:trace:agent"
|
|
3480
2971
|
]
|
|
3481
2972
|
},
|
|
3482
|
-
"agent:
|
|
2973
|
+
"agent:trace:list": {
|
|
3483
2974
|
"aliases": [],
|
|
3484
2975
|
"args": {},
|
|
3485
|
-
"description": "
|
|
2976
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. By default, this command lists all trace files for all agents and all of their sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date (--since).\n\nEach row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column shows the authoring bundle or API name used when starting the session.",
|
|
3486
2977
|
"examples": [
|
|
3487
|
-
"
|
|
2978
|
+
"List all trace files for all agents and sessions:\n<%= config.bin %> <%= command.id %>",
|
|
2979
|
+
"List all trace files for a specific agent:\n<%= config.bin %> <%= command.id %> --agent My_Agent",
|
|
2980
|
+
"List trace files for a specific session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
2981
|
+
"List trace files recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):\n<%= config.bin %> <%= command.id %> --since 2026-04-20",
|
|
2982
|
+
"List trace files recorded on or after a specific UTC time:\n<%= config.bin %> <%= command.id %> --since 2026-04-20T14:00:00Z",
|
|
2983
|
+
"Filter by agent and date together:\n<%= config.bin %> <%= command.id %> --agent My_Agent --since 2026-04-20",
|
|
2984
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --json"
|
|
3488
2985
|
],
|
|
3489
2986
|
"flags": {
|
|
3490
2987
|
"json": {
|
|
@@ -3502,66 +2999,79 @@
|
|
|
3502
2999
|
"multiple": false,
|
|
3503
3000
|
"type": "option"
|
|
3504
3001
|
},
|
|
3505
|
-
"
|
|
3506
|
-
"
|
|
3507
|
-
"
|
|
3508
|
-
"
|
|
3509
|
-
"required": true,
|
|
3510
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3511
|
-
"hasDynamicHelp": true,
|
|
3002
|
+
"session-id": {
|
|
3003
|
+
"name": "session-id",
|
|
3004
|
+
"summary": "Session ID used to filter the list of trace files. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs.",
|
|
3005
|
+
"hasDynamicHelp": false,
|
|
3512
3006
|
"multiple": false,
|
|
3513
3007
|
"type": "option"
|
|
3514
3008
|
},
|
|
3515
|
-
"
|
|
3516
|
-
"
|
|
3517
|
-
"name": "
|
|
3009
|
+
"agent": {
|
|
3010
|
+
"char": "a",
|
|
3011
|
+
"name": "agent",
|
|
3012
|
+
"summary": "API name of the agent used to filter the list of available trace files. Matches against the API name used when starting the session, either an authoring bundle or a published agent API name.",
|
|
3518
3013
|
"hasDynamicHelp": false,
|
|
3519
3014
|
"multiple": false,
|
|
3520
3015
|
"type": "option"
|
|
3521
3016
|
},
|
|
3522
|
-
"
|
|
3523
|
-
"
|
|
3524
|
-
"name": "
|
|
3525
|
-
"
|
|
3526
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
3017
|
+
"since": {
|
|
3018
|
+
"description": "Accepts ISO 8601 format: date-only (2026-04-20), date-time (2026-04-20T14:00:00Z), or date-time with milliseconds (2026-04-20T14:00:00.000Z). The \"Recorded At\" values shown in the table output are valid inputs.",
|
|
3019
|
+
"name": "since",
|
|
3020
|
+
"summary": "Date used to filter the list of trace files; only those recorded on or after the date are listed.",
|
|
3527
3021
|
"hasDynamicHelp": false,
|
|
3528
3022
|
"multiple": false,
|
|
3529
3023
|
"type": "option"
|
|
3530
3024
|
}
|
|
3531
3025
|
},
|
|
3532
|
-
"hasDynamicHelp":
|
|
3026
|
+
"hasDynamicHelp": false,
|
|
3533
3027
|
"hiddenAliases": [],
|
|
3534
|
-
"id": "agent:
|
|
3028
|
+
"id": "agent:trace:list",
|
|
3535
3029
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3536
3030
|
"pluginName": "@salesforce/plugin-agent",
|
|
3537
3031
|
"pluginType": "core",
|
|
3538
3032
|
"strict": true,
|
|
3539
|
-
"summary": "
|
|
3033
|
+
"summary": "List the available trace files that were recorded during all agent preview sessions.",
|
|
3540
3034
|
"enableJsonFlag": true,
|
|
3035
|
+
"requiresProject": true,
|
|
3036
|
+
"errorCodes": {
|
|
3037
|
+
"header": "ERROR CODES",
|
|
3038
|
+
"body": [
|
|
3039
|
+
{
|
|
3040
|
+
"name": "Succeeded (0)",
|
|
3041
|
+
"description": "Trace files listed successfully (or empty list if none found)."
|
|
3042
|
+
}
|
|
3043
|
+
]
|
|
3044
|
+
},
|
|
3541
3045
|
"isESM": true,
|
|
3542
3046
|
"relativePath": [
|
|
3543
3047
|
"lib",
|
|
3544
3048
|
"commands",
|
|
3545
3049
|
"agent",
|
|
3546
|
-
"
|
|
3547
|
-
"
|
|
3050
|
+
"trace",
|
|
3051
|
+
"list.js"
|
|
3548
3052
|
],
|
|
3549
3053
|
"aliasPermutations": [],
|
|
3550
3054
|
"permutations": [
|
|
3551
|
-
"agent:
|
|
3552
|
-
"
|
|
3553
|
-
"
|
|
3554
|
-
"agent:
|
|
3555
|
-
"
|
|
3556
|
-
"
|
|
3055
|
+
"agent:trace:list",
|
|
3056
|
+
"trace:agent:list",
|
|
3057
|
+
"trace:list:agent",
|
|
3058
|
+
"agent:list:trace",
|
|
3059
|
+
"list:agent:trace",
|
|
3060
|
+
"list:trace:agent"
|
|
3557
3061
|
]
|
|
3558
3062
|
},
|
|
3559
|
-
"agent:
|
|
3063
|
+
"agent:trace:read": {
|
|
3560
3064
|
"aliases": [],
|
|
3561
3065
|
"args": {},
|
|
3562
|
-
"description": "
|
|
3066
|
+
"description": "When you run an agent preview conversation (either interactive or programmatic), trace files are automatically recorded and saved in your local DX project. Each turn (utterance or response) of a conversation creates trace data. Use this command to view trace data for a specific preview session, so you can then analyze the trace data to observe, monitor, investigate, and troubleshoot agent events and behavior.\n\nUse the --format flag to specify one of these formats of the outputted trace data:\n\n- summary (Default): A per-turn narrative showing topic routing, actions executed, and the agent's response. Use this to quickly understand what happened in a preview session.\n- detail: Diagnostic drill-down into a specific dimension. Filters output to only the trace steps relevant to that dimension, minimizing noise.\n- raw: Unprocessed trace JSON. Use this as a fallback when the trace schema has changed or you need to perform custom analysis.\n\nIf you specify \"--format detail\", you must also specify a dimension with the --dimension flag. Dimensions are a way to slice and analyze the agent execution trace from a specific angle or concern. Instead of looking at the raw sequence of everything that happened, each dimension filters and organizes the trace data to answer a specific type of question. These are the available dimensions and the information they provide:\n\n- actions: The actions the agent executed. Includes action name, input parameters, output, and latency. Use this dimension to understand what the agent actually did when answering an utterance in the preview session.\n- grounding: The reasoning steps used by the LLM. Use this dimension to see how the agent \"thought\" about the problem - the AI reasoning that determined which actions to take.\n- routing: How the agent navigated between subagents. Use this dimension to understand conversation flow - when and why the agent switched between different subagents or contexts during the conversation.\n- errors: Aggregates all errors during the session. Use this dimension to quickly identify and debug issues across all steps.",
|
|
3563
3067
|
"examples": [
|
|
3564
|
-
"
|
|
3068
|
+
"Show a session trace summary for all turns in the session with the specified ID:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID>",
|
|
3069
|
+
"Show a trace summary for the second turn (utterance or response) of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --turn 2",
|
|
3070
|
+
"Drill into action execution across all turns:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension actions",
|
|
3071
|
+
"Drill into routing decisions for the first turn of the conversation:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension routing --turn 1",
|
|
3072
|
+
"Show all errors across the session:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format detail --dimension errors",
|
|
3073
|
+
"Output raw trace JSON for custom parsing:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --format raw",
|
|
3074
|
+
"Return results as JSON:\n<%= config.bin %> <%= command.id %> --session-id <SESSION_ID> --json"
|
|
3565
3075
|
],
|
|
3566
3076
|
"flags": {
|
|
3567
3077
|
"json": {
|
|
@@ -3579,67 +3089,89 @@
|
|
|
3579
3089
|
"multiple": false,
|
|
3580
3090
|
"type": "option"
|
|
3581
3091
|
},
|
|
3582
|
-
"
|
|
3583
|
-
"char": "
|
|
3584
|
-
"name": "
|
|
3585
|
-
"noCacheDefault": true,
|
|
3092
|
+
"session-id": {
|
|
3093
|
+
"char": "s",
|
|
3094
|
+
"name": "session-id",
|
|
3586
3095
|
"required": true,
|
|
3587
|
-
"summary": "
|
|
3588
|
-
"hasDynamicHelp":
|
|
3096
|
+
"summary": "Session ID to read traces for. Use the \"agent preview sessions\" CLI command to list all known agent preview sessions along with their session IDs",
|
|
3097
|
+
"hasDynamicHelp": false,
|
|
3098
|
+
"multiple": false,
|
|
3099
|
+
"type": "option"
|
|
3100
|
+
},
|
|
3101
|
+
"format": {
|
|
3102
|
+
"char": "f",
|
|
3103
|
+
"name": "format",
|
|
3104
|
+
"summary": "Output format of the trace data; specifies the level of detail you want in the trace files.",
|
|
3105
|
+
"default": "summary",
|
|
3106
|
+
"hasDynamicHelp": false,
|
|
3589
3107
|
"multiple": false,
|
|
3108
|
+
"options": [
|
|
3109
|
+
"summary",
|
|
3110
|
+
"detail",
|
|
3111
|
+
"raw"
|
|
3112
|
+
],
|
|
3590
3113
|
"type": "option"
|
|
3591
3114
|
},
|
|
3592
|
-
"
|
|
3593
|
-
"
|
|
3594
|
-
"name": "
|
|
3115
|
+
"dimension": {
|
|
3116
|
+
"char": "d",
|
|
3117
|
+
"name": "dimension",
|
|
3118
|
+
"summary": "Dimension to drill into when using \"--format detail\"; used to filter and organize the trace data to answer a specific type of question.",
|
|
3595
3119
|
"hasDynamicHelp": false,
|
|
3596
3120
|
"multiple": false,
|
|
3121
|
+
"options": [
|
|
3122
|
+
"actions",
|
|
3123
|
+
"grounding",
|
|
3124
|
+
"routing",
|
|
3125
|
+
"errors"
|
|
3126
|
+
],
|
|
3597
3127
|
"type": "option"
|
|
3598
3128
|
},
|
|
3599
|
-
"
|
|
3600
|
-
"char": "
|
|
3601
|
-
"name": "
|
|
3602
|
-
"
|
|
3603
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
3129
|
+
"turn": {
|
|
3130
|
+
"char": "t",
|
|
3131
|
+
"name": "turn",
|
|
3132
|
+
"summary": "Turn number for which you want trace data. A turn is a single utterance or response in a conversation, starting with 1.",
|
|
3604
3133
|
"hasDynamicHelp": false,
|
|
3605
3134
|
"multiple": false,
|
|
3606
3135
|
"type": "option"
|
|
3607
3136
|
}
|
|
3608
3137
|
},
|
|
3609
|
-
"hasDynamicHelp":
|
|
3138
|
+
"hasDynamicHelp": false,
|
|
3610
3139
|
"hiddenAliases": [],
|
|
3611
|
-
"id": "agent:
|
|
3140
|
+
"id": "agent:trace:read",
|
|
3612
3141
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3613
3142
|
"pluginName": "@salesforce/plugin-agent",
|
|
3614
3143
|
"pluginType": "core",
|
|
3615
3144
|
"strict": true,
|
|
3616
|
-
"summary": "
|
|
3145
|
+
"summary": "Read trace files from an agent preview session.",
|
|
3617
3146
|
"enableJsonFlag": true,
|
|
3147
|
+
"requiresProject": true,
|
|
3618
3148
|
"isESM": true,
|
|
3619
3149
|
"relativePath": [
|
|
3620
3150
|
"lib",
|
|
3621
3151
|
"commands",
|
|
3622
3152
|
"agent",
|
|
3623
|
-
"
|
|
3624
|
-
"
|
|
3153
|
+
"trace",
|
|
3154
|
+
"read.js"
|
|
3625
3155
|
],
|
|
3626
3156
|
"aliasPermutations": [],
|
|
3627
3157
|
"permutations": [
|
|
3628
|
-
"agent:
|
|
3629
|
-
"
|
|
3630
|
-
"
|
|
3631
|
-
"agent:
|
|
3632
|
-
"
|
|
3633
|
-
"
|
|
3158
|
+
"agent:trace:read",
|
|
3159
|
+
"trace:agent:read",
|
|
3160
|
+
"trace:read:agent",
|
|
3161
|
+
"agent:read:trace",
|
|
3162
|
+
"read:agent:trace",
|
|
3163
|
+
"read:trace:agent"
|
|
3634
3164
|
]
|
|
3635
3165
|
},
|
|
3636
|
-
"agent:
|
|
3166
|
+
"agent:test:create": {
|
|
3637
3167
|
"aliases": [],
|
|
3638
3168
|
"args": {},
|
|
3639
|
-
"description": "
|
|
3169
|
+
"description": "To run this command, you must have an agent test spec file, which is a YAML file that lists the test cases for testing a specific agent. Use the \"agent generate test-spec\" CLI command to generate a test spec file. Then specify the file to this command with the --spec flag, or run this command with no flags to be prompted.\n\nWhen this command completes, your org contains the new agent test, which you can view and edit using the Testing Center UI (legacy) or Agentforce Studio (NGT). This command also retrieves the metadata component associated with the new test to your local Salesforce DX project and displays its filename. By default, the legacy AiEvaluationDefinition is created; use --test-runner agentforce-studio to author an AiTestingDefinition (NGT) instead.\n\nAfter you've created the test in the org, use the \"agent test run\" command to run it.",
|
|
3640
3170
|
"examples": [
|
|
3641
|
-
"
|
|
3642
|
-
"
|
|
3171
|
+
"Create an agent test interactively and be prompted for the test spec and API name of the test in the org; use the default org:\n<%= config.bin %> <%= command.id %>",
|
|
3172
|
+
"Create an agent test and use flags to specify all required information; if a test with same API name already exists in the org, overwrite it without confirmation. Use the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --force-overwrite --target-org my-org",
|
|
3173
|
+
"Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:\n<%= config.bin %> <%= command.id %> --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview",
|
|
3174
|
+
"Author an Agentforce Studio (NGT) test from an NGT-shaped YAML; writes an AiTestingDefinition metadata file:\n<%= config.bin %> <%= command.id %> --spec specs/ReturnsCheckout.ngt.yaml --api-name Returns_Checkout --test-runner agentforce-studio --target-org my-org"
|
|
3643
3175
|
],
|
|
3644
3176
|
"flags": {
|
|
3645
3177
|
"json": {
|
|
@@ -3657,6 +3189,20 @@
|
|
|
3657
3189
|
"multiple": false,
|
|
3658
3190
|
"type": "option"
|
|
3659
3191
|
},
|
|
3192
|
+
"api-name": {
|
|
3193
|
+
"name": "api-name",
|
|
3194
|
+
"summary": "API name of the new test; the API name must not exist in the org.",
|
|
3195
|
+
"hasDynamicHelp": false,
|
|
3196
|
+
"multiple": false,
|
|
3197
|
+
"type": "option"
|
|
3198
|
+
},
|
|
3199
|
+
"spec": {
|
|
3200
|
+
"name": "spec",
|
|
3201
|
+
"summary": "Path to the test spec YAML file.",
|
|
3202
|
+
"hasDynamicHelp": false,
|
|
3203
|
+
"multiple": false,
|
|
3204
|
+
"type": "option"
|
|
3205
|
+
},
|
|
3660
3206
|
"target-org": {
|
|
3661
3207
|
"char": "o",
|
|
3662
3208
|
"name": "target-org",
|
|
@@ -3674,52 +3220,95 @@
|
|
|
3674
3220
|
"multiple": false,
|
|
3675
3221
|
"type": "option"
|
|
3676
3222
|
},
|
|
3677
|
-
"
|
|
3678
|
-
"name": "
|
|
3679
|
-
"summary": "
|
|
3223
|
+
"preview": {
|
|
3224
|
+
"name": "preview",
|
|
3225
|
+
"summary": "Preview the test metadata file without deploying to your org.",
|
|
3226
|
+
"allowNo": false,
|
|
3227
|
+
"type": "boolean"
|
|
3228
|
+
},
|
|
3229
|
+
"force-overwrite": {
|
|
3230
|
+
"name": "force-overwrite",
|
|
3231
|
+
"summary": "Don't prompt for confirmation when overwriting an existing test (based on API name) in your org.",
|
|
3232
|
+
"allowNo": false,
|
|
3233
|
+
"type": "boolean"
|
|
3234
|
+
},
|
|
3235
|
+
"test-runner": {
|
|
3236
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3237
|
+
"name": "test-runner",
|
|
3238
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3680
3239
|
"hasDynamicHelp": false,
|
|
3681
3240
|
"multiple": false,
|
|
3682
3241
|
"options": [
|
|
3683
|
-
"
|
|
3684
|
-
"
|
|
3685
|
-
"retriever"
|
|
3242
|
+
"agentforce-studio",
|
|
3243
|
+
"testing-center"
|
|
3686
3244
|
],
|
|
3687
3245
|
"type": "option"
|
|
3688
3246
|
}
|
|
3689
3247
|
},
|
|
3690
3248
|
"hasDynamicHelp": true,
|
|
3691
3249
|
"hiddenAliases": [],
|
|
3692
|
-
"id": "agent:
|
|
3250
|
+
"id": "agent:test:create",
|
|
3693
3251
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3694
3252
|
"pluginName": "@salesforce/plugin-agent",
|
|
3695
3253
|
"pluginType": "core",
|
|
3696
3254
|
"strict": true,
|
|
3697
|
-
"summary": "
|
|
3255
|
+
"summary": "Create an agent test in your org using a local test spec YAML file.",
|
|
3698
3256
|
"enableJsonFlag": true,
|
|
3257
|
+
"envVariablesSection": {
|
|
3258
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3259
|
+
"body": [
|
|
3260
|
+
{
|
|
3261
|
+
"name": "SF_TARGET_ORG",
|
|
3262
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3263
|
+
}
|
|
3264
|
+
]
|
|
3265
|
+
},
|
|
3266
|
+
"errorCodes": {
|
|
3267
|
+
"header": "ERROR CODES",
|
|
3268
|
+
"body": [
|
|
3269
|
+
{
|
|
3270
|
+
"name": "Succeeded (0)",
|
|
3271
|
+
"description": "Test created and deployed successfully."
|
|
3272
|
+
},
|
|
3273
|
+
{
|
|
3274
|
+
"name": "Failed (1)",
|
|
3275
|
+
"description": "Test validation errors or metadata format issues."
|
|
3276
|
+
},
|
|
3277
|
+
{
|
|
3278
|
+
"name": "NotFound (2)",
|
|
3279
|
+
"description": "Test spec file not found or org connection failed."
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"name": "DeploymentFailed (4)",
|
|
3283
|
+
"description": "Deployment failed due to API or network errors."
|
|
3284
|
+
}
|
|
3285
|
+
]
|
|
3286
|
+
},
|
|
3699
3287
|
"isESM": true,
|
|
3700
3288
|
"relativePath": [
|
|
3701
3289
|
"lib",
|
|
3702
3290
|
"commands",
|
|
3703
3291
|
"agent",
|
|
3704
|
-
"
|
|
3705
|
-
"
|
|
3292
|
+
"test",
|
|
3293
|
+
"create.js"
|
|
3706
3294
|
],
|
|
3707
3295
|
"aliasPermutations": [],
|
|
3708
3296
|
"permutations": [
|
|
3709
|
-
"agent:
|
|
3710
|
-
"
|
|
3711
|
-
"
|
|
3712
|
-
"agent:
|
|
3713
|
-
"
|
|
3714
|
-
"
|
|
3297
|
+
"agent:test:create",
|
|
3298
|
+
"test:agent:create",
|
|
3299
|
+
"test:create:agent",
|
|
3300
|
+
"agent:create:test",
|
|
3301
|
+
"create:agent:test",
|
|
3302
|
+
"create:test:agent"
|
|
3715
3303
|
]
|
|
3716
3304
|
},
|
|
3717
|
-
"agent:
|
|
3305
|
+
"agent:test:list": {
|
|
3718
3306
|
"aliases": [],
|
|
3719
3307
|
"args": {},
|
|
3720
|
-
"description": "
|
|
3308
|
+
"description": "The command outputs a table with the name (API name) of each test along with its unique ID, type ('agentforce-studio' or 'testing-center'), and the date it was created in the org.",
|
|
3721
3309
|
"examples": [
|
|
3722
|
-
"
|
|
3310
|
+
"List the agent tests in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
3311
|
+
"List the agent tests in an org with alias \"my-org\"\"\n<%= config.bin %> <%= command.id %> --target-org my-org"
|
|
3723
3312
|
],
|
|
3724
3313
|
"flags": {
|
|
3725
3314
|
"json": {
|
|
@@ -3753,59 +3342,65 @@
|
|
|
3753
3342
|
"hasDynamicHelp": false,
|
|
3754
3343
|
"multiple": false,
|
|
3755
3344
|
"type": "option"
|
|
3756
|
-
},
|
|
3757
|
-
"library-id": {
|
|
3758
|
-
"char": "i",
|
|
3759
|
-
"name": "library-id",
|
|
3760
|
-
"required": true,
|
|
3761
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
3762
|
-
"hasDynamicHelp": false,
|
|
3763
|
-
"multiple": false,
|
|
3764
|
-
"type": "option"
|
|
3765
|
-
},
|
|
3766
|
-
"include-artifacts": {
|
|
3767
|
-
"name": "include-artifacts",
|
|
3768
|
-
"summary": "Resolve DC asset artifacts (DataStream, DLO, DMO, SearchIndex, Retriever) with entity IDs and names on each stage. Slower — requires additional queries.",
|
|
3769
|
-
"allowNo": false,
|
|
3770
|
-
"type": "boolean"
|
|
3771
3345
|
}
|
|
3772
3346
|
},
|
|
3773
3347
|
"hasDynamicHelp": true,
|
|
3774
3348
|
"hiddenAliases": [],
|
|
3775
|
-
"id": "agent:
|
|
3349
|
+
"id": "agent:test:list",
|
|
3776
3350
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3777
3351
|
"pluginName": "@salesforce/plugin-agent",
|
|
3778
3352
|
"pluginType": "core",
|
|
3779
3353
|
"strict": true,
|
|
3780
|
-
"summary": "
|
|
3354
|
+
"summary": "List the available agent tests in your org.",
|
|
3781
3355
|
"enableJsonFlag": true,
|
|
3356
|
+
"envVariablesSection": {
|
|
3357
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3358
|
+
"body": [
|
|
3359
|
+
{
|
|
3360
|
+
"name": "SF_TARGET_ORG",
|
|
3361
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3362
|
+
}
|
|
3363
|
+
]
|
|
3364
|
+
},
|
|
3365
|
+
"errorCodes": {
|
|
3366
|
+
"header": "ERROR CODES",
|
|
3367
|
+
"body": [
|
|
3368
|
+
{
|
|
3369
|
+
"name": "Succeeded (0)",
|
|
3370
|
+
"description": "Agent tests listed successfully."
|
|
3371
|
+
},
|
|
3372
|
+
{
|
|
3373
|
+
"name": "Failed (4)",
|
|
3374
|
+
"description": "Failed to retrieve agent tests due to API or network errors."
|
|
3375
|
+
}
|
|
3376
|
+
]
|
|
3377
|
+
},
|
|
3782
3378
|
"isESM": true,
|
|
3783
3379
|
"relativePath": [
|
|
3784
3380
|
"lib",
|
|
3785
3381
|
"commands",
|
|
3786
3382
|
"agent",
|
|
3787
|
-
"
|
|
3788
|
-
"
|
|
3383
|
+
"test",
|
|
3384
|
+
"list.js"
|
|
3789
3385
|
],
|
|
3790
3386
|
"aliasPermutations": [],
|
|
3791
3387
|
"permutations": [
|
|
3792
|
-
"agent:
|
|
3793
|
-
"
|
|
3794
|
-
"
|
|
3795
|
-
"agent:
|
|
3796
|
-
"
|
|
3797
|
-
"
|
|
3388
|
+
"agent:test:list",
|
|
3389
|
+
"test:agent:list",
|
|
3390
|
+
"test:list:agent",
|
|
3391
|
+
"agent:list:test",
|
|
3392
|
+
"list:agent:test",
|
|
3393
|
+
"list:test:agent"
|
|
3798
3394
|
]
|
|
3799
3395
|
},
|
|
3800
|
-
"agent:
|
|
3396
|
+
"agent:test:results": {
|
|
3801
3397
|
"aliases": [],
|
|
3802
3398
|
"args": {},
|
|
3803
|
-
"description": "
|
|
3399
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3804
3400
|
"examples": [
|
|
3805
|
-
"
|
|
3806
|
-
"
|
|
3807
|
-
"
|
|
3808
|
-
"Restrict Knowledge library to public articles:\n<%= config.bin %> <%= command.id %> --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg"
|
|
3401
|
+
"Get the results of an agent test run in your default org using its job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3402
|
+
"Get the results of the most recently run agent test in an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --use-most-recent --target-org my-org",
|
|
3403
|
+
"Get the results of the most recently run agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3809
3404
|
],
|
|
3810
3405
|
"flags": {
|
|
3811
3406
|
"json": {
|
|
@@ -3840,91 +3435,119 @@
|
|
|
3840
3435
|
"multiple": false,
|
|
3841
3436
|
"type": "option"
|
|
3842
3437
|
},
|
|
3843
|
-
"
|
|
3438
|
+
"job-id": {
|
|
3844
3439
|
"char": "i",
|
|
3845
|
-
"name": "
|
|
3440
|
+
"name": "job-id",
|
|
3846
3441
|
"required": true,
|
|
3847
|
-
"summary": "
|
|
3848
|
-
"hasDynamicHelp": false,
|
|
3849
|
-
"multiple": false,
|
|
3850
|
-
"type": "option"
|
|
3851
|
-
},
|
|
3852
|
-
"name": {
|
|
3853
|
-
"char": "n",
|
|
3854
|
-
"name": "name",
|
|
3855
|
-
"summary": "New display name for the data library (max 80 characters).",
|
|
3442
|
+
"summary": "Job ID of the completed agent test run.",
|
|
3856
3443
|
"hasDynamicHelp": false,
|
|
3857
3444
|
"multiple": false,
|
|
3858
3445
|
"type": "option"
|
|
3859
3446
|
},
|
|
3860
|
-
"
|
|
3861
|
-
"name": "
|
|
3862
|
-
"summary": "
|
|
3447
|
+
"result-format": {
|
|
3448
|
+
"name": "result-format",
|
|
3449
|
+
"summary": "Format of the agent test run results.",
|
|
3450
|
+
"default": "human",
|
|
3863
3451
|
"hasDynamicHelp": false,
|
|
3864
3452
|
"multiple": false,
|
|
3453
|
+
"options": [
|
|
3454
|
+
"json",
|
|
3455
|
+
"human",
|
|
3456
|
+
"junit",
|
|
3457
|
+
"tap"
|
|
3458
|
+
],
|
|
3865
3459
|
"type": "option"
|
|
3866
3460
|
},
|
|
3867
|
-
"
|
|
3868
|
-
"
|
|
3869
|
-
"
|
|
3461
|
+
"output-dir": {
|
|
3462
|
+
"char": "d",
|
|
3463
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3464
|
+
"name": "output-dir",
|
|
3465
|
+
"summary": "Directory to write the agent test results into.",
|
|
3870
3466
|
"hasDynamicHelp": false,
|
|
3871
3467
|
"multiple": false,
|
|
3872
3468
|
"type": "option"
|
|
3873
3469
|
},
|
|
3874
|
-
"
|
|
3875
|
-
"
|
|
3876
|
-
"
|
|
3877
|
-
"
|
|
3878
|
-
"type": "boolean"
|
|
3879
|
-
},
|
|
3880
|
-
"data-category-rule": {
|
|
3881
|
-
"name": "data-category-rule",
|
|
3882
|
-
"summary": "Enable or disable data category filtering for KNOWLEDGE libraries. Use --no-data-category-rule to disable.",
|
|
3883
|
-
"allowNo": true,
|
|
3884
|
-
"type": "boolean"
|
|
3885
|
-
},
|
|
3886
|
-
"retriever-id": {
|
|
3887
|
-
"name": "retriever-id",
|
|
3888
|
-
"summary": "Swap the retriever for a RETRIEVER library (must be an active Custom Retriever ID).",
|
|
3470
|
+
"test-runner": {
|
|
3471
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3472
|
+
"name": "test-runner",
|
|
3473
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3889
3474
|
"hasDynamicHelp": false,
|
|
3890
3475
|
"multiple": false,
|
|
3476
|
+
"options": [
|
|
3477
|
+
"agentforce-studio",
|
|
3478
|
+
"testing-center"
|
|
3479
|
+
],
|
|
3891
3480
|
"type": "option"
|
|
3481
|
+
},
|
|
3482
|
+
"verbose": {
|
|
3483
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3484
|
+
"name": "verbose",
|
|
3485
|
+
"summary": "Show generated data in the test results output.",
|
|
3486
|
+
"allowNo": false,
|
|
3487
|
+
"type": "boolean"
|
|
3892
3488
|
}
|
|
3893
3489
|
},
|
|
3894
3490
|
"hasDynamicHelp": true,
|
|
3895
3491
|
"hiddenAliases": [],
|
|
3896
|
-
"id": "agent:
|
|
3492
|
+
"id": "agent:test:results",
|
|
3897
3493
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3898
3494
|
"pluginName": "@salesforce/plugin-agent",
|
|
3899
3495
|
"pluginType": "core",
|
|
3900
3496
|
"strict": true,
|
|
3901
|
-
"summary": "
|
|
3497
|
+
"summary": "Get the results of a completed agent test run.",
|
|
3902
3498
|
"enableJsonFlag": true,
|
|
3499
|
+
"envVariablesSection": {
|
|
3500
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3501
|
+
"body": [
|
|
3502
|
+
{
|
|
3503
|
+
"name": "SF_TARGET_ORG",
|
|
3504
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3505
|
+
}
|
|
3506
|
+
]
|
|
3507
|
+
},
|
|
3508
|
+
"errorCodes": {
|
|
3509
|
+
"header": "ERROR CODES",
|
|
3510
|
+
"body": [
|
|
3511
|
+
{
|
|
3512
|
+
"name": "Succeeded (0)",
|
|
3513
|
+
"description": "Results retrieved successfully. Test results (passed/failed) are in the output."
|
|
3514
|
+
},
|
|
3515
|
+
{
|
|
3516
|
+
"name": "NotFound (2)",
|
|
3517
|
+
"description": "Job ID not found or invalid."
|
|
3518
|
+
},
|
|
3519
|
+
{
|
|
3520
|
+
"name": "Failed (4)",
|
|
3521
|
+
"description": "Failed to retrieve results due to API or network errors."
|
|
3522
|
+
}
|
|
3523
|
+
]
|
|
3524
|
+
},
|
|
3903
3525
|
"isESM": true,
|
|
3904
3526
|
"relativePath": [
|
|
3905
3527
|
"lib",
|
|
3906
3528
|
"commands",
|
|
3907
3529
|
"agent",
|
|
3908
|
-
"
|
|
3909
|
-
"
|
|
3530
|
+
"test",
|
|
3531
|
+
"results.js"
|
|
3910
3532
|
],
|
|
3911
3533
|
"aliasPermutations": [],
|
|
3912
3534
|
"permutations": [
|
|
3913
|
-
"agent:
|
|
3914
|
-
"
|
|
3915
|
-
"
|
|
3916
|
-
"agent:
|
|
3917
|
-
"
|
|
3918
|
-
"
|
|
3535
|
+
"agent:test:results",
|
|
3536
|
+
"test:agent:results",
|
|
3537
|
+
"test:results:agent",
|
|
3538
|
+
"agent:results:test",
|
|
3539
|
+
"results:agent:test",
|
|
3540
|
+
"results:test:agent"
|
|
3919
3541
|
]
|
|
3920
3542
|
},
|
|
3921
|
-
"agent:
|
|
3543
|
+
"agent:test:resume": {
|
|
3922
3544
|
"aliases": [],
|
|
3923
3545
|
"args": {},
|
|
3924
|
-
"description": "
|
|
3546
|
+
"description": "This command requires a job ID, which the original \"agent test run\" command displays when it completes. You can also use the --use-most-recent flag to see results for the most recently run agent test.\n\nUse the --wait flag to specify the number of minutes for this command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, the CLI returns control of the terminal to you, and you must run \"agent test resume\" again.\n\nBy default, this command outputs test results in human-readable tables for each test case. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
3925
3547
|
"examples": [
|
|
3926
|
-
"
|
|
3927
|
-
"
|
|
3548
|
+
"Resume an agent test in your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 4KBfake0000003F4AQ",
|
|
3549
|
+
"Resume the most recently-run agent test in an org with alias \"my-org\" org; wait 10 minutes for the tests to finish:\n<%= config.bin %> <%= command.id %> --use-most-recent --wait 10 --target-org my-org",
|
|
3550
|
+
"Resume the most recent agent test in your default org, and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --use-most-recent --output-dir ./test-results --result-format json"
|
|
3928
3551
|
],
|
|
3929
3552
|
"flags": {
|
|
3930
3553
|
"json": {
|
|
@@ -3959,67 +3582,141 @@
|
|
|
3959
3582
|
"multiple": false,
|
|
3960
3583
|
"type": "option"
|
|
3961
3584
|
},
|
|
3962
|
-
"
|
|
3585
|
+
"job-id": {
|
|
3963
3586
|
"char": "i",
|
|
3964
|
-
"name": "
|
|
3965
|
-
"
|
|
3966
|
-
"summary": "Agentforce Data Library ID (18-char Salesforce ID with prefix 1JD).",
|
|
3587
|
+
"name": "job-id",
|
|
3588
|
+
"summary": "Job ID of the original agent test run.",
|
|
3967
3589
|
"hasDynamicHelp": false,
|
|
3968
3590
|
"multiple": false,
|
|
3969
3591
|
"type": "option"
|
|
3970
3592
|
},
|
|
3971
|
-
"
|
|
3972
|
-
"char": "
|
|
3973
|
-
"name": "
|
|
3974
|
-
"
|
|
3975
|
-
"
|
|
3976
|
-
"
|
|
3977
|
-
"multiple": true,
|
|
3978
|
-
"type": "option"
|
|
3593
|
+
"use-most-recent": {
|
|
3594
|
+
"char": "r",
|
|
3595
|
+
"name": "use-most-recent",
|
|
3596
|
+
"summary": "Use the job ID of the most recent agent test run.",
|
|
3597
|
+
"allowNo": false,
|
|
3598
|
+
"type": "boolean"
|
|
3979
3599
|
},
|
|
3980
3600
|
"wait": {
|
|
3981
3601
|
"char": "w",
|
|
3982
3602
|
"name": "wait",
|
|
3983
|
-
"summary": "Number of minutes to wait for
|
|
3603
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3604
|
+
"default": "5 minutes",
|
|
3984
3605
|
"hasDynamicHelp": true,
|
|
3985
3606
|
"multiple": false,
|
|
3986
3607
|
"type": "option"
|
|
3608
|
+
},
|
|
3609
|
+
"result-format": {
|
|
3610
|
+
"name": "result-format",
|
|
3611
|
+
"summary": "Format of the agent test run results.",
|
|
3612
|
+
"default": "human",
|
|
3613
|
+
"hasDynamicHelp": false,
|
|
3614
|
+
"multiple": false,
|
|
3615
|
+
"options": [
|
|
3616
|
+
"json",
|
|
3617
|
+
"human",
|
|
3618
|
+
"junit",
|
|
3619
|
+
"tap"
|
|
3620
|
+
],
|
|
3621
|
+
"type": "option"
|
|
3622
|
+
},
|
|
3623
|
+
"output-dir": {
|
|
3624
|
+
"char": "d",
|
|
3625
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3626
|
+
"name": "output-dir",
|
|
3627
|
+
"summary": "Directory to write the agent test results into.",
|
|
3628
|
+
"hasDynamicHelp": false,
|
|
3629
|
+
"multiple": false,
|
|
3630
|
+
"type": "option"
|
|
3631
|
+
},
|
|
3632
|
+
"test-runner": {
|
|
3633
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3634
|
+
"name": "test-runner",
|
|
3635
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
3636
|
+
"hasDynamicHelp": false,
|
|
3637
|
+
"multiple": false,
|
|
3638
|
+
"options": [
|
|
3639
|
+
"agentforce-studio",
|
|
3640
|
+
"testing-center"
|
|
3641
|
+
],
|
|
3642
|
+
"type": "option"
|
|
3643
|
+
},
|
|
3644
|
+
"verbose": {
|
|
3645
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3646
|
+
"name": "verbose",
|
|
3647
|
+
"summary": "Show generated data in the test results output.",
|
|
3648
|
+
"allowNo": false,
|
|
3649
|
+
"type": "boolean"
|
|
3987
3650
|
}
|
|
3988
3651
|
},
|
|
3989
3652
|
"hasDynamicHelp": true,
|
|
3990
3653
|
"hiddenAliases": [],
|
|
3991
|
-
"id": "agent:
|
|
3654
|
+
"id": "agent:test:resume",
|
|
3992
3655
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
3993
3656
|
"pluginName": "@salesforce/plugin-agent",
|
|
3994
3657
|
"pluginType": "core",
|
|
3995
3658
|
"strict": true,
|
|
3996
|
-
"summary": "
|
|
3659
|
+
"summary": "Resume an agent test that you previously started in your org so you can view the test results.",
|
|
3997
3660
|
"enableJsonFlag": true,
|
|
3661
|
+
"envVariablesSection": {
|
|
3662
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3663
|
+
"body": [
|
|
3664
|
+
{
|
|
3665
|
+
"name": "SF_TARGET_ORG",
|
|
3666
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3667
|
+
}
|
|
3668
|
+
]
|
|
3669
|
+
},
|
|
3670
|
+
"errorCodes": {
|
|
3671
|
+
"header": "ERROR CODES",
|
|
3672
|
+
"body": [
|
|
3673
|
+
{
|
|
3674
|
+
"name": "Succeeded (0)",
|
|
3675
|
+
"description": "Test completed successfully (with test results in the output)."
|
|
3676
|
+
},
|
|
3677
|
+
{
|
|
3678
|
+
"name": "Failed (1)",
|
|
3679
|
+
"description": "Tests encountered execution errors (test cases with ERROR status)."
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"name": "NotFound (2)",
|
|
3683
|
+
"description": "Job ID not found or invalid."
|
|
3684
|
+
},
|
|
3685
|
+
{
|
|
3686
|
+
"name": "OperationFailed (4)",
|
|
3687
|
+
"description": "Failed to poll test due to API or network errors."
|
|
3688
|
+
}
|
|
3689
|
+
]
|
|
3690
|
+
},
|
|
3998
3691
|
"isESM": true,
|
|
3999
3692
|
"relativePath": [
|
|
4000
3693
|
"lib",
|
|
4001
3694
|
"commands",
|
|
4002
3695
|
"agent",
|
|
4003
|
-
"
|
|
4004
|
-
"
|
|
3696
|
+
"test",
|
|
3697
|
+
"resume.js"
|
|
4005
3698
|
],
|
|
4006
3699
|
"aliasPermutations": [],
|
|
4007
3700
|
"permutations": [
|
|
4008
|
-
"agent:
|
|
4009
|
-
"
|
|
4010
|
-
"
|
|
4011
|
-
"agent:
|
|
4012
|
-
"
|
|
4013
|
-
"
|
|
3701
|
+
"agent:test:resume",
|
|
3702
|
+
"test:agent:resume",
|
|
3703
|
+
"test:resume:agent",
|
|
3704
|
+
"agent:resume:test",
|
|
3705
|
+
"resume:agent:test",
|
|
3706
|
+
"resume:test:agent"
|
|
4014
3707
|
]
|
|
4015
3708
|
},
|
|
4016
|
-
"agent:
|
|
3709
|
+
"agent:test:run-eval": {
|
|
4017
3710
|
"aliases": [],
|
|
4018
3711
|
"args": {},
|
|
4019
|
-
"description": "
|
|
3712
|
+
"description": "Specify the tests you want to run with one of these inputs to the --spec flag:\n\n- YAML test spec generated by the `agent generate test-spec` CLI command\n- JSON payload\n\nWhen you provide a YAML test spec, this command automatically translates test cases into internal state-based evaluation framework calls and infers the agent name from the test spec's `subjectName` field. As a result, you can use the same test spec with both the `agent test run` and `agent test run-eval` commands. YAML test specs also support context variables, which allow you to inject contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.\n\nWhen you provide a JSON payload, it's sent directly to the evaluation framework with optional normalization. The normalizer auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use `--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on agent.create_session steps for the same contextual testing capabilities as when you use a YAML test spec.\n\nThis command supports more than 8 evaluator types, including subagent routing assertions, action invocation checks, string/numeric assertions, semantic similarity scoring, and LLM-based quality ratings.",
|
|
4020
3713
|
"examples": [
|
|
4021
|
-
"
|
|
4022
|
-
"
|
|
3714
|
+
"Run tests using a YAML test spec on the org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org",
|
|
3715
|
+
"Run tests using a YAML spec with explicit agent name override; use your default org:\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --api-name My_Agent",
|
|
3716
|
+
"Run tests using a JSON payload:\n<%= config.bin %> <%= command.id %> --spec specs/eval-payload.json --target-org my-org",
|
|
3717
|
+
"Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):\n<%= config.bin %> <%= command.id %> --spec specs/my-agent-testSpec.yaml --target-org my-org --result-format junit",
|
|
3718
|
+
"Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in your YAML spec):\n<%= config.bin %> <%= command.id %> --spec specs/agent-with-context.yaml --target-org my-org",
|
|
3719
|
+
"Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):\n$ echo '{\"tests\":[...]}' | <%= config.bin %> <%= command.id %> --spec --target-org my-org"
|
|
4023
3720
|
],
|
|
4024
3721
|
"flags": {
|
|
4025
3722
|
"json": {
|
|
@@ -4054,25 +3751,62 @@
|
|
|
4054
3751
|
"multiple": false,
|
|
4055
3752
|
"type": "option"
|
|
4056
3753
|
},
|
|
3754
|
+
"spec": {
|
|
3755
|
+
"char": "s",
|
|
3756
|
+
"name": "spec",
|
|
3757
|
+
"required": true,
|
|
3758
|
+
"summary": "Path to test spec file (YAML or JSON). Supports reading from stdin when piping content.",
|
|
3759
|
+
"hasDynamicHelp": false,
|
|
3760
|
+
"multiple": false,
|
|
3761
|
+
"type": "option"
|
|
3762
|
+
},
|
|
4057
3763
|
"api-name": {
|
|
4058
3764
|
"char": "n",
|
|
4059
3765
|
"name": "api-name",
|
|
4060
|
-
"summary": "API name
|
|
3766
|
+
"summary": "Agent API name (also called DeveloperName) used to resolve agent_id and agent_version_id. Auto-inferred from the YAML spec's subjectName.",
|
|
3767
|
+
"hasDynamicHelp": false,
|
|
3768
|
+
"multiple": false,
|
|
3769
|
+
"type": "option"
|
|
3770
|
+
},
|
|
3771
|
+
"result-format": {
|
|
3772
|
+
"name": "result-format",
|
|
3773
|
+
"summary": "Format of the agent test run results.",
|
|
3774
|
+
"default": "human",
|
|
3775
|
+
"hasDynamicHelp": false,
|
|
3776
|
+
"multiple": false,
|
|
3777
|
+
"options": [
|
|
3778
|
+
"json",
|
|
3779
|
+
"human",
|
|
3780
|
+
"junit",
|
|
3781
|
+
"tap"
|
|
3782
|
+
],
|
|
3783
|
+
"type": "option"
|
|
3784
|
+
},
|
|
3785
|
+
"batch-size": {
|
|
3786
|
+
"name": "batch-size",
|
|
3787
|
+
"summary": "Number of tests per API request (max 5).",
|
|
3788
|
+
"default": 5,
|
|
4061
3789
|
"hasDynamicHelp": false,
|
|
4062
3790
|
"multiple": false,
|
|
4063
3791
|
"type": "option"
|
|
3792
|
+
},
|
|
3793
|
+
"no-normalize": {
|
|
3794
|
+
"name": "no-normalize",
|
|
3795
|
+
"summary": "Disable auto-normalization of field names and shorthand references.",
|
|
3796
|
+
"allowNo": false,
|
|
3797
|
+
"type": "boolean"
|
|
4064
3798
|
}
|
|
4065
3799
|
},
|
|
4066
3800
|
"hasDynamicHelp": true,
|
|
4067
3801
|
"hiddenAliases": [],
|
|
4068
|
-
"id": "agent:
|
|
3802
|
+
"id": "agent:test:run-eval",
|
|
4069
3803
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4070
3804
|
"pluginName": "@salesforce/plugin-agent",
|
|
4071
3805
|
"pluginType": "core",
|
|
3806
|
+
"state": "beta",
|
|
4072
3807
|
"strict": true,
|
|
4073
|
-
"summary": "
|
|
3808
|
+
"summary": "Run rich evaluation tests against an Agentforce agent.",
|
|
4074
3809
|
"enableJsonFlag": true,
|
|
4075
|
-
"requiresProject": true,
|
|
4076
3810
|
"envVariablesSection": {
|
|
4077
3811
|
"header": "ENVIRONMENT VARIABLES",
|
|
4078
3812
|
"body": [
|
|
@@ -4087,53 +3821,48 @@
|
|
|
4087
3821
|
"body": [
|
|
4088
3822
|
{
|
|
4089
3823
|
"name": "Succeeded (0)",
|
|
4090
|
-
"description": "
|
|
3824
|
+
"description": "Tests completed successfully. Test results (passed/failed) are in the JSON output."
|
|
4091
3825
|
},
|
|
4092
3826
|
{
|
|
4093
3827
|
"name": "Failed (1)",
|
|
4094
|
-
"description": "
|
|
3828
|
+
"description": "Tests encountered execution errors (tests couldn't run properly)."
|
|
4095
3829
|
},
|
|
4096
3830
|
{
|
|
4097
3831
|
"name": "NotFound (2)",
|
|
4098
|
-
"description": "
|
|
3832
|
+
"description": "Agent not found, spec file not found, or invalid agent name."
|
|
4099
3833
|
},
|
|
4100
3834
|
{
|
|
4101
|
-
"name": "
|
|
4102
|
-
"description": "
|
|
3835
|
+
"name": "OperationFailed (4)",
|
|
3836
|
+
"description": "Failed to execute tests due to API or network errors."
|
|
4103
3837
|
}
|
|
4104
3838
|
]
|
|
4105
3839
|
},
|
|
4106
|
-
"FLAGGABLE_PROMPTS": {
|
|
4107
|
-
"api-name": {
|
|
4108
|
-
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
4109
|
-
"promptMessage": "API name of the authoring bundle to validate"
|
|
4110
|
-
}
|
|
4111
|
-
},
|
|
4112
3840
|
"isESM": true,
|
|
4113
3841
|
"relativePath": [
|
|
4114
3842
|
"lib",
|
|
4115
3843
|
"commands",
|
|
4116
3844
|
"agent",
|
|
4117
|
-
"
|
|
4118
|
-
"
|
|
3845
|
+
"test",
|
|
3846
|
+
"run-eval.js"
|
|
4119
3847
|
],
|
|
4120
3848
|
"aliasPermutations": [],
|
|
4121
3849
|
"permutations": [
|
|
4122
|
-
"agent:
|
|
4123
|
-
"
|
|
4124
|
-
"
|
|
4125
|
-
"agent:
|
|
4126
|
-
"
|
|
4127
|
-
"
|
|
3850
|
+
"agent:test:run-eval",
|
|
3851
|
+
"test:agent:run-eval",
|
|
3852
|
+
"test:run-eval:agent",
|
|
3853
|
+
"agent:run-eval:test",
|
|
3854
|
+
"run-eval:agent:test",
|
|
3855
|
+
"run-eval:test:agent"
|
|
4128
3856
|
]
|
|
4129
3857
|
},
|
|
4130
|
-
"agent:
|
|
3858
|
+
"agent:test:run": {
|
|
4131
3859
|
"aliases": [],
|
|
4132
3860
|
"args": {},
|
|
4133
|
-
"description": "
|
|
3861
|
+
"description": "Use the --api-name flag to specify the name of the agent test you want to run. Use the output of the \"agent test list\" command to get the names of all the available agent tests in your org.\n\nBy default, this command starts the agent test in your org, but it doesn't wait for the test to finish. Instead, it displays the \"agent test resume\" command, with a job ID, that you execute to see the results of the test run, and then returns control of the terminal window to you. Use the --wait flag to specify the number of minutes for the command to wait for the agent test to complete; if the test completes by the end of the wait time, the command displays the test results. If not, run \"agent test resume\".\n\nBy default, this command outputs test results in human-readable tables for each test case, if the test completes in time. The tables show whether the test case passed, the expected and actual values, the test score, how long the test took, and more. Use the --result-format to display the test results in JSON or Junit format. Use the --output-dir flag to write the results to a file rather than to the terminal.",
|
|
4134
3862
|
"examples": [
|
|
4135
|
-
"
|
|
4136
|
-
"
|
|
3863
|
+
"Start an agent test called Resort_Manager_Test for an agent in your default org, don't wait for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test",
|
|
3864
|
+
"Start an agent test for an agent in an org with alias \"my-org\" and wait for 10 minutes for the test to finish:\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --target-org my-org",
|
|
3865
|
+
"Start an agent test and write the JSON-formatted results into a directory called \"test-results\":\n<%= config.bin %> <%= command.id %> --api-name Resort_Manager_Test --wait 10 --output-dir ./test-results --result-format json"
|
|
4137
3866
|
],
|
|
4138
3867
|
"flags": {
|
|
4139
3868
|
"json": {
|
|
@@ -4168,71 +3897,129 @@
|
|
|
4168
3897
|
"multiple": false,
|
|
4169
3898
|
"type": "option"
|
|
4170
3899
|
},
|
|
4171
|
-
"
|
|
4172
|
-
"char": "
|
|
4173
|
-
"name": "
|
|
4174
|
-
"
|
|
4175
|
-
"
|
|
3900
|
+
"api-name": {
|
|
3901
|
+
"char": "n",
|
|
3902
|
+
"name": "api-name",
|
|
3903
|
+
"summary": "API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.",
|
|
3904
|
+
"hasDynamicHelp": false,
|
|
3905
|
+
"multiple": false,
|
|
3906
|
+
"type": "option"
|
|
3907
|
+
},
|
|
3908
|
+
"wait": {
|
|
3909
|
+
"char": "w",
|
|
3910
|
+
"name": "wait",
|
|
3911
|
+
"summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
|
|
3912
|
+
"hasDynamicHelp": true,
|
|
3913
|
+
"multiple": false,
|
|
3914
|
+
"type": "option"
|
|
3915
|
+
},
|
|
3916
|
+
"result-format": {
|
|
3917
|
+
"name": "result-format",
|
|
3918
|
+
"summary": "Format of the agent test run results.",
|
|
3919
|
+
"default": "human",
|
|
3920
|
+
"hasDynamicHelp": false,
|
|
3921
|
+
"multiple": false,
|
|
3922
|
+
"options": [
|
|
3923
|
+
"json",
|
|
3924
|
+
"human",
|
|
3925
|
+
"junit",
|
|
3926
|
+
"tap"
|
|
3927
|
+
],
|
|
3928
|
+
"type": "option"
|
|
3929
|
+
},
|
|
3930
|
+
"output-dir": {
|
|
3931
|
+
"char": "d",
|
|
3932
|
+
"description": "If the agent test run completes, write the results to the specified directory. If the test is still running, the test results aren't written.",
|
|
3933
|
+
"name": "output-dir",
|
|
3934
|
+
"summary": "Directory to write the agent test results into.",
|
|
3935
|
+
"hasDynamicHelp": false,
|
|
3936
|
+
"multiple": false,
|
|
3937
|
+
"type": "option"
|
|
3938
|
+
},
|
|
3939
|
+
"test-runner": {
|
|
3940
|
+
"description": "By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.",
|
|
3941
|
+
"name": "test-runner",
|
|
3942
|
+
"summary": "Explicitly specify which test runner to use (agentforce-studio or testing-center).",
|
|
4176
3943
|
"hasDynamicHelp": false,
|
|
4177
3944
|
"multiple": false,
|
|
3945
|
+
"options": [
|
|
3946
|
+
"agentforce-studio",
|
|
3947
|
+
"testing-center"
|
|
3948
|
+
],
|
|
4178
3949
|
"type": "option"
|
|
3950
|
+
},
|
|
3951
|
+
"verbose": {
|
|
3952
|
+
"description": "When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output. This is useful for debugging test failures and understanding what actions were actually invoked during the test run.\n\nThe generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath expression when using custom evaluations.",
|
|
3953
|
+
"name": "verbose",
|
|
3954
|
+
"summary": "Show generated data in the test results output.",
|
|
3955
|
+
"allowNo": false,
|
|
3956
|
+
"type": "boolean"
|
|
4179
3957
|
}
|
|
4180
3958
|
},
|
|
4181
3959
|
"hasDynamicHelp": true,
|
|
4182
3960
|
"hiddenAliases": [],
|
|
4183
|
-
"id": "agent:
|
|
3961
|
+
"id": "agent:test:run",
|
|
4184
3962
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4185
3963
|
"pluginName": "@salesforce/plugin-agent",
|
|
4186
3964
|
"pluginType": "core",
|
|
4187
|
-
"state": "preview",
|
|
4188
3965
|
"strict": true,
|
|
4189
|
-
"summary": "
|
|
3966
|
+
"summary": "Start an agent test in your org.",
|
|
4190
3967
|
"enableJsonFlag": true,
|
|
3968
|
+
"envVariablesSection": {
|
|
3969
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
3970
|
+
"body": [
|
|
3971
|
+
{
|
|
3972
|
+
"name": "SF_TARGET_ORG",
|
|
3973
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
3974
|
+
}
|
|
3975
|
+
]
|
|
3976
|
+
},
|
|
3977
|
+
"errorCodes": {
|
|
3978
|
+
"header": "ERROR CODES",
|
|
3979
|
+
"body": [
|
|
3980
|
+
{
|
|
3981
|
+
"name": "Succeeded (0)",
|
|
3982
|
+
"description": "Test started successfully (without --wait), or test completed successfully (with --wait)."
|
|
3983
|
+
},
|
|
3984
|
+
{
|
|
3985
|
+
"name": "Failed (1)",
|
|
3986
|
+
"description": "Tests encountered execution errors (test cases with ERROR status when using --wait)."
|
|
3987
|
+
},
|
|
3988
|
+
{
|
|
3989
|
+
"name": "NotFound (2)",
|
|
3990
|
+
"description": "Test definition not found or invalid test name."
|
|
3991
|
+
},
|
|
3992
|
+
{
|
|
3993
|
+
"name": "OperationFailed (4)",
|
|
3994
|
+
"description": "Failed to start or poll test due to API or network errors."
|
|
3995
|
+
}
|
|
3996
|
+
]
|
|
3997
|
+
},
|
|
4191
3998
|
"isESM": true,
|
|
4192
3999
|
"relativePath": [
|
|
4193
4000
|
"lib",
|
|
4194
4001
|
"commands",
|
|
4195
4002
|
"agent",
|
|
4196
|
-
"
|
|
4197
|
-
"
|
|
4198
|
-
"list.js"
|
|
4003
|
+
"test",
|
|
4004
|
+
"run.js"
|
|
4199
4005
|
],
|
|
4200
4006
|
"aliasPermutations": [],
|
|
4201
4007
|
"permutations": [
|
|
4202
|
-
"agent:
|
|
4203
|
-
"
|
|
4204
|
-
"
|
|
4205
|
-
"
|
|
4206
|
-
"agent:
|
|
4207
|
-
"
|
|
4208
|
-
"asset:mcp:agent:list",
|
|
4209
|
-
"asset:mcp:list:agent",
|
|
4210
|
-
"agent:asset:list:mcp",
|
|
4211
|
-
"asset:agent:list:mcp",
|
|
4212
|
-
"asset:list:agent:mcp",
|
|
4213
|
-
"asset:list:mcp:agent",
|
|
4214
|
-
"agent:mcp:list:asset",
|
|
4215
|
-
"mcp:agent:list:asset",
|
|
4216
|
-
"mcp:list:agent:asset",
|
|
4217
|
-
"mcp:list:asset:agent",
|
|
4218
|
-
"agent:list:mcp:asset",
|
|
4219
|
-
"list:agent:mcp:asset",
|
|
4220
|
-
"list:mcp:agent:asset",
|
|
4221
|
-
"list:mcp:asset:agent",
|
|
4222
|
-
"agent:list:asset:mcp",
|
|
4223
|
-
"list:agent:asset:mcp",
|
|
4224
|
-
"list:asset:agent:mcp",
|
|
4225
|
-
"list:asset:mcp:agent"
|
|
4008
|
+
"agent:test:run",
|
|
4009
|
+
"test:agent:run",
|
|
4010
|
+
"test:run:agent",
|
|
4011
|
+
"agent:run:test",
|
|
4012
|
+
"run:agent:test",
|
|
4013
|
+
"run:test:agent"
|
|
4226
4014
|
]
|
|
4227
4015
|
},
|
|
4228
|
-
"agent:
|
|
4016
|
+
"agent:validate:authoring-bundle": {
|
|
4229
4017
|
"aliases": [],
|
|
4230
4018
|
"args": {},
|
|
4231
|
-
"description": "
|
|
4019
|
+
"description": "An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension \".agent\") that fully describes the agent using the Agent Script language.\n\nThis command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.\n\nThis command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.",
|
|
4232
4020
|
"examples": [
|
|
4233
|
-
"
|
|
4234
|
-
"
|
|
4235
|
-
"Pipe the assets from stdin:\ncat assets.json | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets - --target-org myOrg"
|
|
4021
|
+
"Validate an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
4022
|
+
"Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias \"my-dev-org\":\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org"
|
|
4236
4023
|
],
|
|
4237
4024
|
"flags": {
|
|
4238
4025
|
"json": {
|
|
@@ -4267,31 +4054,10 @@
|
|
|
4267
4054
|
"multiple": false,
|
|
4268
4055
|
"type": "option"
|
|
4269
4056
|
},
|
|
4270
|
-
"
|
|
4271
|
-
"char": "
|
|
4272
|
-
"name": "
|
|
4273
|
-
"
|
|
4274
|
-
"summary": "ID of the MCP server whose assets you want to replace.",
|
|
4275
|
-
"hasDynamicHelp": false,
|
|
4276
|
-
"multiple": false,
|
|
4277
|
-
"type": "option"
|
|
4278
|
-
},
|
|
4279
|
-
"assets": {
|
|
4280
|
-
"exclusive": [
|
|
4281
|
-
"assets-file"
|
|
4282
|
-
],
|
|
4283
|
-
"name": "assets",
|
|
4284
|
-
"summary": "The desired asset allowlist as a JSON string (or \"-\" to read from stdin). Mutually exclusive with --assets-file.",
|
|
4285
|
-
"hasDynamicHelp": false,
|
|
4286
|
-
"multiple": false,
|
|
4287
|
-
"type": "option"
|
|
4288
|
-
},
|
|
4289
|
-
"assets-file": {
|
|
4290
|
-
"exclusive": [
|
|
4291
|
-
"assets"
|
|
4292
|
-
],
|
|
4293
|
-
"name": "assets-file",
|
|
4294
|
-
"summary": "Path to a JSON file containing the desired asset allowlist. Mutually exclusive with --assets.",
|
|
4057
|
+
"api-name": {
|
|
4058
|
+
"char": "n",
|
|
4059
|
+
"name": "api-name",
|
|
4060
|
+
"summary": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
4295
4061
|
"hasDynamicHelp": false,
|
|
4296
4062
|
"multiple": false,
|
|
4297
4063
|
"type": "option"
|
|
@@ -4299,49 +4065,66 @@
|
|
|
4299
4065
|
},
|
|
4300
4066
|
"hasDynamicHelp": true,
|
|
4301
4067
|
"hiddenAliases": [],
|
|
4302
|
-
"id": "agent:
|
|
4068
|
+
"id": "agent:validate:authoring-bundle",
|
|
4303
4069
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
4304
4070
|
"pluginName": "@salesforce/plugin-agent",
|
|
4305
4071
|
"pluginType": "core",
|
|
4306
|
-
"state": "preview",
|
|
4307
4072
|
"strict": true,
|
|
4308
|
-
"summary": "
|
|
4073
|
+
"summary": "Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.",
|
|
4309
4074
|
"enableJsonFlag": true,
|
|
4075
|
+
"requiresProject": true,
|
|
4076
|
+
"envVariablesSection": {
|
|
4077
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
4078
|
+
"body": [
|
|
4079
|
+
{
|
|
4080
|
+
"name": "SF_TARGET_ORG",
|
|
4081
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
4082
|
+
}
|
|
4083
|
+
]
|
|
4084
|
+
},
|
|
4085
|
+
"errorCodes": {
|
|
4086
|
+
"header": "ERROR CODES",
|
|
4087
|
+
"body": [
|
|
4088
|
+
{
|
|
4089
|
+
"name": "Succeeded (0)",
|
|
4090
|
+
"description": "Agent Script file compiled successfully without errors."
|
|
4091
|
+
},
|
|
4092
|
+
{
|
|
4093
|
+
"name": "Failed (1)",
|
|
4094
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
4095
|
+
},
|
|
4096
|
+
{
|
|
4097
|
+
"name": "NotFound (2)",
|
|
4098
|
+
"description": "Validation/compilation API returned HTTP 404. The API endpoint may not be available in your org or region."
|
|
4099
|
+
},
|
|
4100
|
+
{
|
|
4101
|
+
"name": "ServerError (3)",
|
|
4102
|
+
"description": "Validation/compilation API returned HTTP 500. A server error occurred during compilation."
|
|
4103
|
+
}
|
|
4104
|
+
]
|
|
4105
|
+
},
|
|
4106
|
+
"FLAGGABLE_PROMPTS": {
|
|
4107
|
+
"api-name": {
|
|
4108
|
+
"message": "API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.",
|
|
4109
|
+
"promptMessage": "API name of the authoring bundle to validate"
|
|
4110
|
+
}
|
|
4111
|
+
},
|
|
4310
4112
|
"isESM": true,
|
|
4311
4113
|
"relativePath": [
|
|
4312
4114
|
"lib",
|
|
4313
4115
|
"commands",
|
|
4314
4116
|
"agent",
|
|
4315
|
-
"
|
|
4316
|
-
"
|
|
4317
|
-
"replace.js"
|
|
4117
|
+
"validate",
|
|
4118
|
+
"authoring-bundle.js"
|
|
4318
4119
|
],
|
|
4319
4120
|
"aliasPermutations": [],
|
|
4320
4121
|
"permutations": [
|
|
4321
|
-
"agent:
|
|
4322
|
-
"
|
|
4323
|
-
"
|
|
4324
|
-
"
|
|
4325
|
-
"agent:
|
|
4326
|
-
"
|
|
4327
|
-
"asset:mcp:agent:replace",
|
|
4328
|
-
"asset:mcp:replace:agent",
|
|
4329
|
-
"agent:asset:replace:mcp",
|
|
4330
|
-
"asset:agent:replace:mcp",
|
|
4331
|
-
"asset:replace:agent:mcp",
|
|
4332
|
-
"asset:replace:mcp:agent",
|
|
4333
|
-
"agent:mcp:replace:asset",
|
|
4334
|
-
"mcp:agent:replace:asset",
|
|
4335
|
-
"mcp:replace:agent:asset",
|
|
4336
|
-
"mcp:replace:asset:agent",
|
|
4337
|
-
"agent:replace:mcp:asset",
|
|
4338
|
-
"replace:agent:mcp:asset",
|
|
4339
|
-
"replace:mcp:agent:asset",
|
|
4340
|
-
"replace:mcp:asset:agent",
|
|
4341
|
-
"agent:replace:asset:mcp",
|
|
4342
|
-
"replace:agent:asset:mcp",
|
|
4343
|
-
"replace:asset:agent:mcp",
|
|
4344
|
-
"replace:asset:mcp:agent"
|
|
4122
|
+
"agent:validate:authoring-bundle",
|
|
4123
|
+
"validate:agent:authoring-bundle",
|
|
4124
|
+
"validate:authoring-bundle:agent",
|
|
4125
|
+
"agent:authoring-bundle:validate",
|
|
4126
|
+
"authoring-bundle:agent:validate",
|
|
4127
|
+
"authoring-bundle:validate:agent"
|
|
4345
4128
|
]
|
|
4346
4129
|
},
|
|
4347
4130
|
"agent:adl:file:add": {
|
|
@@ -4681,7 +4464,224 @@
|
|
|
4681
4464
|
"list:file:agent:adl",
|
|
4682
4465
|
"list:file:adl:agent"
|
|
4683
4466
|
]
|
|
4467
|
+
},
|
|
4468
|
+
"agent:mcp:asset:list": {
|
|
4469
|
+
"aliases": [],
|
|
4470
|
+
"args": {},
|
|
4471
|
+
"description": "Returns the assets discovered for the specified MCP server, including each asset's kind (MCP_TOOL, MCP_PROMPT, or MCP_RESOURCE), whether it is active, and whether it is available as an agent action.",
|
|
4472
|
+
"examples": [
|
|
4473
|
+
"List the assets for an MCP server in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001",
|
|
4474
|
+
"List the assets for an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
4475
|
+
],
|
|
4476
|
+
"flags": {
|
|
4477
|
+
"json": {
|
|
4478
|
+
"description": "Format output as json.",
|
|
4479
|
+
"helpGroup": "GLOBAL",
|
|
4480
|
+
"name": "json",
|
|
4481
|
+
"allowNo": false,
|
|
4482
|
+
"type": "boolean"
|
|
4483
|
+
},
|
|
4484
|
+
"flags-dir": {
|
|
4485
|
+
"helpGroup": "GLOBAL",
|
|
4486
|
+
"name": "flags-dir",
|
|
4487
|
+
"summary": "Import flag values from a directory.",
|
|
4488
|
+
"hasDynamicHelp": false,
|
|
4489
|
+
"multiple": false,
|
|
4490
|
+
"type": "option"
|
|
4491
|
+
},
|
|
4492
|
+
"target-org": {
|
|
4493
|
+
"char": "o",
|
|
4494
|
+
"name": "target-org",
|
|
4495
|
+
"noCacheDefault": true,
|
|
4496
|
+
"required": true,
|
|
4497
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
4498
|
+
"hasDynamicHelp": true,
|
|
4499
|
+
"multiple": false,
|
|
4500
|
+
"type": "option"
|
|
4501
|
+
},
|
|
4502
|
+
"api-version": {
|
|
4503
|
+
"description": "Override the api version used for api requests made by this command",
|
|
4504
|
+
"name": "api-version",
|
|
4505
|
+
"hasDynamicHelp": false,
|
|
4506
|
+
"multiple": false,
|
|
4507
|
+
"type": "option"
|
|
4508
|
+
},
|
|
4509
|
+
"mcp-server-id": {
|
|
4510
|
+
"char": "i",
|
|
4511
|
+
"name": "mcp-server-id",
|
|
4512
|
+
"required": true,
|
|
4513
|
+
"summary": "The ID of the MCP server whose assets you want to list.",
|
|
4514
|
+
"hasDynamicHelp": false,
|
|
4515
|
+
"multiple": false,
|
|
4516
|
+
"type": "option"
|
|
4517
|
+
}
|
|
4518
|
+
},
|
|
4519
|
+
"hasDynamicHelp": true,
|
|
4520
|
+
"hiddenAliases": [],
|
|
4521
|
+
"id": "agent:mcp:asset:list",
|
|
4522
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
4523
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
4524
|
+
"pluginType": "core",
|
|
4525
|
+
"state": "preview",
|
|
4526
|
+
"strict": true,
|
|
4527
|
+
"summary": "List the assets (tools, prompts, and resources) for an MCP server in the catalog.",
|
|
4528
|
+
"enableJsonFlag": true,
|
|
4529
|
+
"isESM": true,
|
|
4530
|
+
"relativePath": [
|
|
4531
|
+
"lib",
|
|
4532
|
+
"commands",
|
|
4533
|
+
"agent",
|
|
4534
|
+
"mcp",
|
|
4535
|
+
"asset",
|
|
4536
|
+
"list.js"
|
|
4537
|
+
],
|
|
4538
|
+
"aliasPermutations": [],
|
|
4539
|
+
"permutations": [
|
|
4540
|
+
"agent:mcp:asset:list",
|
|
4541
|
+
"mcp:agent:asset:list",
|
|
4542
|
+
"mcp:asset:agent:list",
|
|
4543
|
+
"mcp:asset:list:agent",
|
|
4544
|
+
"agent:asset:mcp:list",
|
|
4545
|
+
"asset:agent:mcp:list",
|
|
4546
|
+
"asset:mcp:agent:list",
|
|
4547
|
+
"asset:mcp:list:agent",
|
|
4548
|
+
"agent:asset:list:mcp",
|
|
4549
|
+
"asset:agent:list:mcp",
|
|
4550
|
+
"asset:list:agent:mcp",
|
|
4551
|
+
"asset:list:mcp:agent",
|
|
4552
|
+
"agent:mcp:list:asset",
|
|
4553
|
+
"mcp:agent:list:asset",
|
|
4554
|
+
"mcp:list:agent:asset",
|
|
4555
|
+
"mcp:list:asset:agent",
|
|
4556
|
+
"agent:list:mcp:asset",
|
|
4557
|
+
"list:agent:mcp:asset",
|
|
4558
|
+
"list:mcp:agent:asset",
|
|
4559
|
+
"list:mcp:asset:agent",
|
|
4560
|
+
"agent:list:asset:mcp",
|
|
4561
|
+
"list:agent:asset:mcp",
|
|
4562
|
+
"list:asset:agent:mcp",
|
|
4563
|
+
"list:asset:mcp:agent"
|
|
4564
|
+
]
|
|
4565
|
+
},
|
|
4566
|
+
"agent:mcp:asset:replace": {
|
|
4567
|
+
"aliases": [],
|
|
4568
|
+
"args": {},
|
|
4569
|
+
"description": "Replaces the full set of assets (tools, prompts, resources) for an MCP server with the asset items you supply. Provide the assets either inline with `--assets` (a JSON string, or `-` to read from stdin) or from a file with `--assets-file`. The JSON must be either an array of asset items or an object of the form `{ \"assets\": [...] }`. Each asset item may include `id`, `name`, `label`, `description`, `active`, and `kind`. This is a full replacement: existing assets not present in the supplied set are removed, so provide the complete desired asset set (read the current set first with `agent mcp asset list` or `agent mcp fetch`).",
|
|
4570
|
+
"examples": [
|
|
4571
|
+
"Replace the assets inline with a JSON string:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets '{\"assets\":[{\"name\":\"McpTool__add\",\"active\":true}]}' --target-org myOrg",
|
|
4572
|
+
"Replace the assets from a JSON file:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets-file ./assets.json --target-org myOrg",
|
|
4573
|
+
"Pipe the assets from stdin:\ncat assets.json | <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --assets - --target-org myOrg"
|
|
4574
|
+
],
|
|
4575
|
+
"flags": {
|
|
4576
|
+
"json": {
|
|
4577
|
+
"description": "Format output as json.",
|
|
4578
|
+
"helpGroup": "GLOBAL",
|
|
4579
|
+
"name": "json",
|
|
4580
|
+
"allowNo": false,
|
|
4581
|
+
"type": "boolean"
|
|
4582
|
+
},
|
|
4583
|
+
"flags-dir": {
|
|
4584
|
+
"helpGroup": "GLOBAL",
|
|
4585
|
+
"name": "flags-dir",
|
|
4586
|
+
"summary": "Import flag values from a directory.",
|
|
4587
|
+
"hasDynamicHelp": false,
|
|
4588
|
+
"multiple": false,
|
|
4589
|
+
"type": "option"
|
|
4590
|
+
},
|
|
4591
|
+
"target-org": {
|
|
4592
|
+
"char": "o",
|
|
4593
|
+
"name": "target-org",
|
|
4594
|
+
"noCacheDefault": true,
|
|
4595
|
+
"required": true,
|
|
4596
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
4597
|
+
"hasDynamicHelp": true,
|
|
4598
|
+
"multiple": false,
|
|
4599
|
+
"type": "option"
|
|
4600
|
+
},
|
|
4601
|
+
"api-version": {
|
|
4602
|
+
"description": "Override the api version used for api requests made by this command",
|
|
4603
|
+
"name": "api-version",
|
|
4604
|
+
"hasDynamicHelp": false,
|
|
4605
|
+
"multiple": false,
|
|
4606
|
+
"type": "option"
|
|
4607
|
+
},
|
|
4608
|
+
"mcp-server-id": {
|
|
4609
|
+
"char": "i",
|
|
4610
|
+
"name": "mcp-server-id",
|
|
4611
|
+
"required": true,
|
|
4612
|
+
"summary": "ID of the MCP server whose assets you want to replace.",
|
|
4613
|
+
"hasDynamicHelp": false,
|
|
4614
|
+
"multiple": false,
|
|
4615
|
+
"type": "option"
|
|
4616
|
+
},
|
|
4617
|
+
"assets": {
|
|
4618
|
+
"exclusive": [
|
|
4619
|
+
"assets-file"
|
|
4620
|
+
],
|
|
4621
|
+
"name": "assets",
|
|
4622
|
+
"summary": "The desired asset allowlist as a JSON string (or \"-\" to read from stdin). Mutually exclusive with --assets-file.",
|
|
4623
|
+
"hasDynamicHelp": false,
|
|
4624
|
+
"multiple": false,
|
|
4625
|
+
"type": "option"
|
|
4626
|
+
},
|
|
4627
|
+
"assets-file": {
|
|
4628
|
+
"exclusive": [
|
|
4629
|
+
"assets"
|
|
4630
|
+
],
|
|
4631
|
+
"name": "assets-file",
|
|
4632
|
+
"summary": "Path to a JSON file containing the desired asset allowlist. Mutually exclusive with --assets.",
|
|
4633
|
+
"hasDynamicHelp": false,
|
|
4634
|
+
"multiple": false,
|
|
4635
|
+
"type": "option"
|
|
4636
|
+
}
|
|
4637
|
+
},
|
|
4638
|
+
"hasDynamicHelp": true,
|
|
4639
|
+
"hiddenAliases": [],
|
|
4640
|
+
"id": "agent:mcp:asset:replace",
|
|
4641
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
4642
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
4643
|
+
"pluginType": "core",
|
|
4644
|
+
"state": "preview",
|
|
4645
|
+
"strict": true,
|
|
4646
|
+
"summary": "Replace the asset set of an MCP server in the API Catalog.",
|
|
4647
|
+
"enableJsonFlag": true,
|
|
4648
|
+
"isESM": true,
|
|
4649
|
+
"relativePath": [
|
|
4650
|
+
"lib",
|
|
4651
|
+
"commands",
|
|
4652
|
+
"agent",
|
|
4653
|
+
"mcp",
|
|
4654
|
+
"asset",
|
|
4655
|
+
"replace.js"
|
|
4656
|
+
],
|
|
4657
|
+
"aliasPermutations": [],
|
|
4658
|
+
"permutations": [
|
|
4659
|
+
"agent:mcp:asset:replace",
|
|
4660
|
+
"mcp:agent:asset:replace",
|
|
4661
|
+
"mcp:asset:agent:replace",
|
|
4662
|
+
"mcp:asset:replace:agent",
|
|
4663
|
+
"agent:asset:mcp:replace",
|
|
4664
|
+
"asset:agent:mcp:replace",
|
|
4665
|
+
"asset:mcp:agent:replace",
|
|
4666
|
+
"asset:mcp:replace:agent",
|
|
4667
|
+
"agent:asset:replace:mcp",
|
|
4668
|
+
"asset:agent:replace:mcp",
|
|
4669
|
+
"asset:replace:agent:mcp",
|
|
4670
|
+
"asset:replace:mcp:agent",
|
|
4671
|
+
"agent:mcp:replace:asset",
|
|
4672
|
+
"mcp:agent:replace:asset",
|
|
4673
|
+
"mcp:replace:agent:asset",
|
|
4674
|
+
"mcp:replace:asset:agent",
|
|
4675
|
+
"agent:replace:mcp:asset",
|
|
4676
|
+
"replace:agent:mcp:asset",
|
|
4677
|
+
"replace:mcp:agent:asset",
|
|
4678
|
+
"replace:mcp:asset:agent",
|
|
4679
|
+
"agent:replace:asset:mcp",
|
|
4680
|
+
"replace:agent:asset:mcp",
|
|
4681
|
+
"replace:asset:agent:mcp",
|
|
4682
|
+
"replace:asset:mcp:agent"
|
|
4683
|
+
]
|
|
4684
4684
|
}
|
|
4685
4685
|
},
|
|
4686
|
-
"version": "2.2.
|
|
4686
|
+
"version": "2.2.4"
|
|
4687
4687
|
}
|