@salesforce/plugin-agent 2.0.2 → 2.0.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/commands/agent/test/resume.js +9 -6
- package/lib/commands/agent/test/resume.js.map +1 -1
- package/lib/commands/agent/test/run.js +9 -4
- package/lib/commands/agent/test/run.js.map +1 -1
- package/lib/testStages.js +4 -1
- package/lib/testStages.js.map +1 -1
- package/oclif.manifest.json +609 -609
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1604,13 +1604,16 @@
|
|
|
1604
1604
|
"test-spec:generate:agent"
|
|
1605
1605
|
]
|
|
1606
1606
|
},
|
|
1607
|
-
"agent:
|
|
1607
|
+
"agent:preview:end": {
|
|
1608
1608
|
"aliases": [],
|
|
1609
1609
|
"args": {},
|
|
1610
|
-
"description": "
|
|
1610
|
+
"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.",
|
|
1611
1611
|
"examples": [
|
|
1612
|
-
"
|
|
1613
|
-
"
|
|
1612
|
+
"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",
|
|
1613
|
+
"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",
|
|
1614
|
+
"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",
|
|
1615
|
+
"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",
|
|
1616
|
+
"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>"
|
|
1614
1617
|
],
|
|
1615
1618
|
"flags": {
|
|
1616
1619
|
"json": {
|
|
@@ -1645,113 +1648,129 @@
|
|
|
1645
1648
|
"multiple": false,
|
|
1646
1649
|
"type": "option"
|
|
1647
1650
|
},
|
|
1648
|
-
"
|
|
1649
|
-
"
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
"
|
|
1653
|
-
"
|
|
1654
|
-
"
|
|
1655
|
-
"type": "option"
|
|
1656
|
-
},
|
|
1657
|
-
"label": {
|
|
1658
|
-
"name": "label",
|
|
1659
|
-
"summary": "Human-readable label for the MCP server.",
|
|
1660
|
-
"hasDynamicHelp": false,
|
|
1661
|
-
"multiple": false,
|
|
1662
|
-
"type": "option"
|
|
1663
|
-
},
|
|
1664
|
-
"description": {
|
|
1665
|
-
"name": "description",
|
|
1666
|
-
"summary": "Description of the MCP server.",
|
|
1667
|
-
"hasDynamicHelp": false,
|
|
1668
|
-
"multiple": false,
|
|
1669
|
-
"type": "option"
|
|
1670
|
-
},
|
|
1671
|
-
"server-url": {
|
|
1672
|
-
"name": "server-url",
|
|
1673
|
-
"required": true,
|
|
1674
|
-
"summary": "URL of the external MCP server.",
|
|
1651
|
+
"session-id": {
|
|
1652
|
+
"exclusive": [
|
|
1653
|
+
"all"
|
|
1654
|
+
],
|
|
1655
|
+
"name": "session-id",
|
|
1656
|
+
"required": false,
|
|
1657
|
+
"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.",
|
|
1675
1658
|
"hasDynamicHelp": false,
|
|
1676
1659
|
"multiple": false,
|
|
1677
1660
|
"type": "option"
|
|
1678
1661
|
},
|
|
1679
|
-
"
|
|
1680
|
-
"
|
|
1681
|
-
"
|
|
1682
|
-
|
|
1683
|
-
"hasDynamicHelp": false,
|
|
1684
|
-
"multiple": false,
|
|
1685
|
-
"options": [
|
|
1686
|
-
"OAUTH",
|
|
1687
|
-
"NO_AUTH"
|
|
1662
|
+
"api-name": {
|
|
1663
|
+
"char": "n",
|
|
1664
|
+
"exclusive": [
|
|
1665
|
+
"authoring-bundle"
|
|
1688
1666
|
],
|
|
1689
|
-
"
|
|
1690
|
-
|
|
1691
|
-
"identity-provider": {
|
|
1692
|
-
"name": "identity-provider",
|
|
1693
|
-
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1667
|
+
"name": "api-name",
|
|
1668
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1694
1669
|
"hasDynamicHelp": false,
|
|
1695
1670
|
"multiple": false,
|
|
1696
1671
|
"type": "option"
|
|
1697
1672
|
},
|
|
1698
|
-
"
|
|
1699
|
-
"
|
|
1700
|
-
|
|
1673
|
+
"authoring-bundle": {
|
|
1674
|
+
"exclusive": [
|
|
1675
|
+
"api-name"
|
|
1676
|
+
],
|
|
1677
|
+
"name": "authoring-bundle",
|
|
1678
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1701
1679
|
"hasDynamicHelp": false,
|
|
1702
1680
|
"multiple": false,
|
|
1703
1681
|
"type": "option"
|
|
1704
1682
|
},
|
|
1705
|
-
"
|
|
1706
|
-
"
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
"
|
|
1710
|
-
"
|
|
1683
|
+
"all": {
|
|
1684
|
+
"exclusive": [
|
|
1685
|
+
"session-id"
|
|
1686
|
+
],
|
|
1687
|
+
"name": "all",
|
|
1688
|
+
"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.",
|
|
1689
|
+
"allowNo": false,
|
|
1690
|
+
"type": "boolean"
|
|
1711
1691
|
},
|
|
1712
|
-
"
|
|
1713
|
-
"
|
|
1714
|
-
"
|
|
1715
|
-
"
|
|
1716
|
-
"
|
|
1717
|
-
"type": "
|
|
1692
|
+
"no-prompt": {
|
|
1693
|
+
"char": "p",
|
|
1694
|
+
"name": "no-prompt",
|
|
1695
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
1696
|
+
"allowNo": false,
|
|
1697
|
+
"type": "boolean"
|
|
1718
1698
|
}
|
|
1719
1699
|
},
|
|
1720
1700
|
"hasDynamicHelp": true,
|
|
1721
1701
|
"hiddenAliases": [],
|
|
1722
|
-
"id": "agent:
|
|
1702
|
+
"id": "agent:preview:end",
|
|
1723
1703
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1724
1704
|
"pluginName": "@salesforce/plugin-agent",
|
|
1725
1705
|
"pluginType": "core",
|
|
1726
|
-
"state": "preview",
|
|
1727
1706
|
"strict": true,
|
|
1728
|
-
"summary": "
|
|
1707
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
1729
1708
|
"enableJsonFlag": true,
|
|
1709
|
+
"requiresProject": true,
|
|
1710
|
+
"envVariablesSection": {
|
|
1711
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1712
|
+
"body": [
|
|
1713
|
+
{
|
|
1714
|
+
"name": "SF_TARGET_ORG",
|
|
1715
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1716
|
+
}
|
|
1717
|
+
]
|
|
1718
|
+
},
|
|
1719
|
+
"errorCodes": {
|
|
1720
|
+
"header": "ERROR CODES",
|
|
1721
|
+
"body": [
|
|
1722
|
+
{
|
|
1723
|
+
"name": "Succeeded (0)",
|
|
1724
|
+
"description": "Preview session ended successfully and traces saved."
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
"name": "ExactlyOneRequired (2)",
|
|
1728
|
+
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
1729
|
+
},
|
|
1730
|
+
{
|
|
1731
|
+
"name": "NotFound (2)",
|
|
1732
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "PreviewEndFailed (4)",
|
|
1736
|
+
"description": "Failed to end the preview session."
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"name": "PreviewEndPartialFailure (68)",
|
|
1740
|
+
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
1741
|
+
},
|
|
1742
|
+
{
|
|
1743
|
+
"name": "SessionAmbiguous (5)",
|
|
1744
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1745
|
+
}
|
|
1746
|
+
]
|
|
1747
|
+
},
|
|
1730
1748
|
"isESM": true,
|
|
1731
1749
|
"relativePath": [
|
|
1732
1750
|
"lib",
|
|
1733
1751
|
"commands",
|
|
1734
1752
|
"agent",
|
|
1735
|
-
"
|
|
1736
|
-
"
|
|
1753
|
+
"preview",
|
|
1754
|
+
"end.js"
|
|
1737
1755
|
],
|
|
1738
1756
|
"aliasPermutations": [],
|
|
1739
1757
|
"permutations": [
|
|
1740
|
-
"agent:
|
|
1741
|
-
"
|
|
1742
|
-
"
|
|
1743
|
-
"agent:
|
|
1744
|
-
"
|
|
1745
|
-
"
|
|
1758
|
+
"agent:preview:end",
|
|
1759
|
+
"preview:agent:end",
|
|
1760
|
+
"preview:end:agent",
|
|
1761
|
+
"agent:end:preview",
|
|
1762
|
+
"end:agent:preview",
|
|
1763
|
+
"end:preview:agent"
|
|
1746
1764
|
]
|
|
1747
1765
|
},
|
|
1748
|
-
"agent:
|
|
1766
|
+
"agent:preview:send": {
|
|
1749
1767
|
"aliases": [],
|
|
1750
1768
|
"args": {},
|
|
1751
|
-
"description": "
|
|
1769
|
+
"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.",
|
|
1752
1770
|
"examples": [
|
|
1753
|
-
"
|
|
1754
|
-
"
|
|
1771
|
+
"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>",
|
|
1772
|
+
"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",
|
|
1773
|
+
"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"
|
|
1755
1774
|
],
|
|
1756
1775
|
"flags": {
|
|
1757
1776
|
"json": {
|
|
@@ -1786,96 +1805,34 @@
|
|
|
1786
1805
|
"multiple": false,
|
|
1787
1806
|
"type": "option"
|
|
1788
1807
|
},
|
|
1789
|
-
"
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1792
|
-
"
|
|
1793
|
-
"summary": "ID of the MCP server to delete.",
|
|
1794
|
-
"hasDynamicHelp": false,
|
|
1795
|
-
"multiple": false,
|
|
1796
|
-
"type": "option"
|
|
1797
|
-
},
|
|
1798
|
-
"no-prompt": {
|
|
1799
|
-
"name": "no-prompt",
|
|
1800
|
-
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
1801
|
-
"allowNo": false,
|
|
1802
|
-
"type": "boolean"
|
|
1803
|
-
}
|
|
1804
|
-
},
|
|
1805
|
-
"hasDynamicHelp": true,
|
|
1806
|
-
"hiddenAliases": [],
|
|
1807
|
-
"id": "agent:mcp:delete",
|
|
1808
|
-
"pluginAlias": "@salesforce/plugin-agent",
|
|
1809
|
-
"pluginName": "@salesforce/plugin-agent",
|
|
1810
|
-
"pluginType": "core",
|
|
1811
|
-
"state": "preview",
|
|
1812
|
-
"strict": true,
|
|
1813
|
-
"summary": "Delete an MCP server from the API Catalog.",
|
|
1814
|
-
"enableJsonFlag": true,
|
|
1815
|
-
"isESM": true,
|
|
1816
|
-
"relativePath": [
|
|
1817
|
-
"lib",
|
|
1818
|
-
"commands",
|
|
1819
|
-
"agent",
|
|
1820
|
-
"mcp",
|
|
1821
|
-
"delete.js"
|
|
1822
|
-
],
|
|
1823
|
-
"aliasPermutations": [],
|
|
1824
|
-
"permutations": [
|
|
1825
|
-
"agent:mcp:delete",
|
|
1826
|
-
"mcp:agent:delete",
|
|
1827
|
-
"mcp:delete:agent",
|
|
1828
|
-
"agent:delete:mcp",
|
|
1829
|
-
"delete:agent:mcp",
|
|
1830
|
-
"delete:mcp:agent"
|
|
1831
|
-
]
|
|
1832
|
-
},
|
|
1833
|
-
"agent:mcp:fetch": {
|
|
1834
|
-
"aliases": [],
|
|
1835
|
-
"args": {},
|
|
1836
|
-
"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.",
|
|
1837
|
-
"examples": [
|
|
1838
|
-
"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",
|
|
1839
|
-
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
1840
|
-
],
|
|
1841
|
-
"flags": {
|
|
1842
|
-
"json": {
|
|
1843
|
-
"description": "Format output as json.",
|
|
1844
|
-
"helpGroup": "GLOBAL",
|
|
1845
|
-
"name": "json",
|
|
1846
|
-
"allowNo": false,
|
|
1847
|
-
"type": "boolean"
|
|
1848
|
-
},
|
|
1849
|
-
"flags-dir": {
|
|
1850
|
-
"helpGroup": "GLOBAL",
|
|
1851
|
-
"name": "flags-dir",
|
|
1852
|
-
"summary": "Import flag values from a directory.",
|
|
1808
|
+
"session-id": {
|
|
1809
|
+
"name": "session-id",
|
|
1810
|
+
"required": false,
|
|
1811
|
+
"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.",
|
|
1853
1812
|
"hasDynamicHelp": false,
|
|
1854
1813
|
"multiple": false,
|
|
1855
1814
|
"type": "option"
|
|
1856
1815
|
},
|
|
1857
|
-
"
|
|
1858
|
-
"char": "
|
|
1859
|
-
"name": "
|
|
1860
|
-
"noCacheDefault": true,
|
|
1816
|
+
"utterance": {
|
|
1817
|
+
"char": "u",
|
|
1818
|
+
"name": "utterance",
|
|
1861
1819
|
"required": true,
|
|
1862
|
-
"summary": "
|
|
1863
|
-
"hasDynamicHelp":
|
|
1820
|
+
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
1821
|
+
"hasDynamicHelp": false,
|
|
1864
1822
|
"multiple": false,
|
|
1865
1823
|
"type": "option"
|
|
1866
1824
|
},
|
|
1867
|
-
"api-
|
|
1868
|
-
"
|
|
1869
|
-
"name": "api-
|
|
1825
|
+
"api-name": {
|
|
1826
|
+
"char": "n",
|
|
1827
|
+
"name": "api-name",
|
|
1828
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
1870
1829
|
"hasDynamicHelp": false,
|
|
1871
1830
|
"multiple": false,
|
|
1872
1831
|
"type": "option"
|
|
1873
1832
|
},
|
|
1874
|
-
"
|
|
1875
|
-
"
|
|
1876
|
-
"
|
|
1877
|
-
"required": true,
|
|
1878
|
-
"summary": "ID of the MCP server to fetch assets from.",
|
|
1833
|
+
"authoring-bundle": {
|
|
1834
|
+
"name": "authoring-bundle",
|
|
1835
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1879
1836
|
"hasDynamicHelp": false,
|
|
1880
1837
|
"multiple": false,
|
|
1881
1838
|
"type": "option"
|
|
@@ -1883,39 +1840,68 @@
|
|
|
1883
1840
|
},
|
|
1884
1841
|
"hasDynamicHelp": true,
|
|
1885
1842
|
"hiddenAliases": [],
|
|
1886
|
-
"id": "agent:
|
|
1843
|
+
"id": "agent:preview:send",
|
|
1887
1844
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1888
1845
|
"pluginName": "@salesforce/plugin-agent",
|
|
1889
1846
|
"pluginType": "core",
|
|
1890
|
-
"state": "preview",
|
|
1891
1847
|
"strict": true,
|
|
1892
|
-
"summary": "
|
|
1848
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
1893
1849
|
"enableJsonFlag": true,
|
|
1850
|
+
"requiresProject": true,
|
|
1851
|
+
"envVariablesSection": {
|
|
1852
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
1853
|
+
"body": [
|
|
1854
|
+
{
|
|
1855
|
+
"name": "SF_TARGET_ORG",
|
|
1856
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
1857
|
+
}
|
|
1858
|
+
]
|
|
1859
|
+
},
|
|
1860
|
+
"errorCodes": {
|
|
1861
|
+
"header": "ERROR CODES",
|
|
1862
|
+
"body": [
|
|
1863
|
+
{
|
|
1864
|
+
"name": "Succeeded (0)",
|
|
1865
|
+
"description": "Message sent successfully and agent response received."
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
"name": "NotFound (2)",
|
|
1869
|
+
"description": "Agent not found, or no preview session exists for this agent."
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
"name": "PreviewSendFailed (4)",
|
|
1873
|
+
"description": "Failed to send message or receive response from the preview session."
|
|
1874
|
+
},
|
|
1875
|
+
{
|
|
1876
|
+
"name": "SessionAmbiguous (5)",
|
|
1877
|
+
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
1878
|
+
}
|
|
1879
|
+
]
|
|
1880
|
+
},
|
|
1894
1881
|
"isESM": true,
|
|
1895
1882
|
"relativePath": [
|
|
1896
1883
|
"lib",
|
|
1897
1884
|
"commands",
|
|
1898
1885
|
"agent",
|
|
1899
|
-
"
|
|
1900
|
-
"
|
|
1886
|
+
"preview",
|
|
1887
|
+
"send.js"
|
|
1901
1888
|
],
|
|
1902
1889
|
"aliasPermutations": [],
|
|
1903
1890
|
"permutations": [
|
|
1904
|
-
"agent:
|
|
1905
|
-
"
|
|
1906
|
-
"
|
|
1907
|
-
"agent:
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
1891
|
+
"agent:preview:send",
|
|
1892
|
+
"preview:agent:send",
|
|
1893
|
+
"preview:send:agent",
|
|
1894
|
+
"agent:send:preview",
|
|
1895
|
+
"send:agent:preview",
|
|
1896
|
+
"send:preview:agent"
|
|
1910
1897
|
]
|
|
1911
1898
|
},
|
|
1912
|
-
"agent:
|
|
1899
|
+
"agent:preview:sessions": {
|
|
1913
1900
|
"aliases": [],
|
|
1914
1901
|
"args": {},
|
|
1915
|
-
"description": "
|
|
1902
|
+
"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.",
|
|
1916
1903
|
"examples": [
|
|
1917
|
-
"
|
|
1918
|
-
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1904
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
1919
1905
|
],
|
|
1920
1906
|
"flags": {
|
|
1921
1907
|
"json": {
|
|
@@ -1932,69 +1918,53 @@
|
|
|
1932
1918
|
"hasDynamicHelp": false,
|
|
1933
1919
|
"multiple": false,
|
|
1934
1920
|
"type": "option"
|
|
1935
|
-
},
|
|
1936
|
-
"target-org": {
|
|
1937
|
-
"char": "o",
|
|
1938
|
-
"name": "target-org",
|
|
1939
|
-
"noCacheDefault": true,
|
|
1940
|
-
"required": true,
|
|
1941
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1942
|
-
"hasDynamicHelp": true,
|
|
1943
|
-
"multiple": false,
|
|
1944
|
-
"type": "option"
|
|
1945
|
-
},
|
|
1946
|
-
"api-version": {
|
|
1947
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1948
|
-
"name": "api-version",
|
|
1949
|
-
"hasDynamicHelp": false,
|
|
1950
|
-
"multiple": false,
|
|
1951
|
-
"type": "option"
|
|
1952
|
-
},
|
|
1953
|
-
"mcp-server-id": {
|
|
1954
|
-
"char": "i",
|
|
1955
|
-
"name": "mcp-server-id",
|
|
1956
|
-
"required": true,
|
|
1957
|
-
"summary": "The identifier of the MCP server to retrieve.",
|
|
1958
|
-
"hasDynamicHelp": false,
|
|
1959
|
-
"multiple": false,
|
|
1960
|
-
"type": "option"
|
|
1961
1921
|
}
|
|
1962
1922
|
},
|
|
1963
|
-
"hasDynamicHelp":
|
|
1923
|
+
"hasDynamicHelp": false,
|
|
1964
1924
|
"hiddenAliases": [],
|
|
1965
|
-
"id": "agent:
|
|
1925
|
+
"id": "agent:preview:sessions",
|
|
1966
1926
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1967
1927
|
"pluginName": "@salesforce/plugin-agent",
|
|
1968
1928
|
"pluginType": "core",
|
|
1969
|
-
"state": "preview",
|
|
1970
1929
|
"strict": true,
|
|
1971
|
-
"summary": "
|
|
1930
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
1972
1931
|
"enableJsonFlag": true,
|
|
1932
|
+
"requiresProject": true,
|
|
1933
|
+
"errorCodes": {
|
|
1934
|
+
"header": "ERROR CODES",
|
|
1935
|
+
"body": [
|
|
1936
|
+
{
|
|
1937
|
+
"name": "Succeeded (0)",
|
|
1938
|
+
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
1939
|
+
}
|
|
1940
|
+
]
|
|
1941
|
+
},
|
|
1973
1942
|
"isESM": true,
|
|
1974
1943
|
"relativePath": [
|
|
1975
1944
|
"lib",
|
|
1976
1945
|
"commands",
|
|
1977
1946
|
"agent",
|
|
1978
|
-
"
|
|
1979
|
-
"
|
|
1947
|
+
"preview",
|
|
1948
|
+
"sessions.js"
|
|
1980
1949
|
],
|
|
1981
1950
|
"aliasPermutations": [],
|
|
1982
1951
|
"permutations": [
|
|
1983
|
-
"agent:
|
|
1984
|
-
"
|
|
1985
|
-
"
|
|
1986
|
-
"agent:
|
|
1987
|
-
"
|
|
1988
|
-
"
|
|
1952
|
+
"agent:preview:sessions",
|
|
1953
|
+
"preview:agent:sessions",
|
|
1954
|
+
"preview:sessions:agent",
|
|
1955
|
+
"agent:sessions:preview",
|
|
1956
|
+
"sessions:agent:preview",
|
|
1957
|
+
"sessions:preview:agent"
|
|
1989
1958
|
]
|
|
1990
1959
|
},
|
|
1991
|
-
"agent:
|
|
1960
|
+
"agent:preview:start": {
|
|
1992
1961
|
"aliases": [],
|
|
1993
1962
|
"args": {},
|
|
1994
|
-
"description": "
|
|
1963
|
+
"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.",
|
|
1995
1964
|
"examples": [
|
|
1996
|
-
"
|
|
1997
|
-
"
|
|
1965
|
+
"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",
|
|
1966
|
+
"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",
|
|
1967
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1998
1968
|
],
|
|
1999
1969
|
"flags": {
|
|
2000
1970
|
"json": {
|
|
@@ -2029,70 +1999,129 @@
|
|
|
2029
1999
|
"multiple": false,
|
|
2030
2000
|
"type": "option"
|
|
2031
2001
|
},
|
|
2032
|
-
"
|
|
2033
|
-
"
|
|
2034
|
-
"
|
|
2002
|
+
"api-name": {
|
|
2003
|
+
"char": "n",
|
|
2004
|
+
"name": "api-name",
|
|
2005
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2035
2006
|
"hasDynamicHelp": false,
|
|
2036
2007
|
"multiple": false,
|
|
2037
2008
|
"type": "option"
|
|
2038
2009
|
},
|
|
2039
|
-
"
|
|
2040
|
-
"name": "
|
|
2041
|
-
"summary": "
|
|
2010
|
+
"authoring-bundle": {
|
|
2011
|
+
"name": "authoring-bundle",
|
|
2012
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2042
2013
|
"hasDynamicHelp": false,
|
|
2043
2014
|
"multiple": false,
|
|
2044
|
-
"
|
|
2045
|
-
|
|
2015
|
+
"type": "option"
|
|
2016
|
+
},
|
|
2017
|
+
"use-live-actions": {
|
|
2018
|
+
"exclusive": [
|
|
2019
|
+
"simulate-actions"
|
|
2020
|
+
],
|
|
2021
|
+
"name": "use-live-actions",
|
|
2022
|
+
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2023
|
+
"allowNo": false,
|
|
2024
|
+
"type": "boolean"
|
|
2025
|
+
},
|
|
2026
|
+
"simulate-actions": {
|
|
2027
|
+
"exclusive": [
|
|
2028
|
+
"use-live-actions"
|
|
2046
2029
|
],
|
|
2030
|
+
"name": "simulate-actions",
|
|
2031
|
+
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2032
|
+
"allowNo": false,
|
|
2033
|
+
"type": "boolean"
|
|
2034
|
+
},
|
|
2035
|
+
"context-variables": {
|
|
2036
|
+
"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 defaults to Text.",
|
|
2037
|
+
"name": "context-variables",
|
|
2038
|
+
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2039
|
+
"delimiter": ",",
|
|
2040
|
+
"hasDynamicHelp": false,
|
|
2041
|
+
"multiple": true,
|
|
2047
2042
|
"type": "option"
|
|
2048
2043
|
},
|
|
2049
|
-
"
|
|
2050
|
-
"
|
|
2051
|
-
|
|
2044
|
+
"agent-json": {
|
|
2045
|
+
"dependsOn": [
|
|
2046
|
+
"authoring-bundle"
|
|
2047
|
+
],
|
|
2048
|
+
"hidden": true,
|
|
2049
|
+
"name": "agent-json",
|
|
2050
|
+
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2052
2051
|
"hasDynamicHelp": false,
|
|
2053
2052
|
"multiple": false,
|
|
2054
|
-
"options": [
|
|
2055
|
-
"ACTIVE",
|
|
2056
|
-
"DISCONNECTED"
|
|
2057
|
-
],
|
|
2058
2053
|
"type": "option"
|
|
2059
2054
|
}
|
|
2060
2055
|
},
|
|
2061
2056
|
"hasDynamicHelp": true,
|
|
2062
2057
|
"hiddenAliases": [],
|
|
2063
|
-
"id": "agent:
|
|
2058
|
+
"id": "agent:preview:start",
|
|
2064
2059
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2065
2060
|
"pluginName": "@salesforce/plugin-agent",
|
|
2066
2061
|
"pluginType": "core",
|
|
2067
|
-
"state": "preview",
|
|
2068
2062
|
"strict": true,
|
|
2069
|
-
"summary": "
|
|
2063
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2070
2064
|
"enableJsonFlag": true,
|
|
2065
|
+
"requiresProject": true,
|
|
2066
|
+
"envVariablesSection": {
|
|
2067
|
+
"header": "ENVIRONMENT VARIABLES",
|
|
2068
|
+
"body": [
|
|
2069
|
+
{
|
|
2070
|
+
"name": "SF_TARGET_ORG",
|
|
2071
|
+
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2072
|
+
}
|
|
2073
|
+
]
|
|
2074
|
+
},
|
|
2075
|
+
"errorCodes": {
|
|
2076
|
+
"header": "ERROR CODES",
|
|
2077
|
+
"body": [
|
|
2078
|
+
{
|
|
2079
|
+
"name": "Succeeded (0)",
|
|
2080
|
+
"description": "Preview session started successfully."
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
"name": "Failed (1)",
|
|
2084
|
+
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"name": "NotFound (2)",
|
|
2088
|
+
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "ServerError (3)",
|
|
2092
|
+
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2093
|
+
},
|
|
2094
|
+
{
|
|
2095
|
+
"name": "PreviewStartFailed (4)",
|
|
2096
|
+
"description": "Preview session failed to start due to API or network errors."
|
|
2097
|
+
}
|
|
2098
|
+
]
|
|
2099
|
+
},
|
|
2071
2100
|
"isESM": true,
|
|
2072
2101
|
"relativePath": [
|
|
2073
2102
|
"lib",
|
|
2074
2103
|
"commands",
|
|
2075
2104
|
"agent",
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2105
|
+
"preview",
|
|
2106
|
+
"start.js"
|
|
2078
2107
|
],
|
|
2079
2108
|
"aliasPermutations": [],
|
|
2080
2109
|
"permutations": [
|
|
2081
|
-
"agent:
|
|
2082
|
-
"
|
|
2083
|
-
"
|
|
2084
|
-
"agent:
|
|
2085
|
-
"
|
|
2086
|
-
"
|
|
2110
|
+
"agent:preview:start",
|
|
2111
|
+
"preview:agent:start",
|
|
2112
|
+
"preview:start:agent",
|
|
2113
|
+
"agent:start:preview",
|
|
2114
|
+
"start:agent:preview",
|
|
2115
|
+
"start:preview:agent"
|
|
2087
2116
|
]
|
|
2088
2117
|
},
|
|
2089
|
-
"agent:mcp:
|
|
2118
|
+
"agent:mcp:create": {
|
|
2090
2119
|
"aliases": [],
|
|
2091
2120
|
"args": {},
|
|
2092
|
-
"description": "
|
|
2121
|
+
"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.",
|
|
2093
2122
|
"examples": [
|
|
2094
|
-
"
|
|
2095
|
-
"
|
|
2123
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
2124
|
+
"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"
|
|
2096
2125
|
],
|
|
2097
2126
|
"flags": {
|
|
2098
2127
|
"json": {
|
|
@@ -2127,39 +2156,41 @@
|
|
|
2127
2156
|
"multiple": false,
|
|
2128
2157
|
"type": "option"
|
|
2129
2158
|
},
|
|
2130
|
-
"
|
|
2131
|
-
"char": "
|
|
2132
|
-
"name": "
|
|
2159
|
+
"name": {
|
|
2160
|
+
"char": "n",
|
|
2161
|
+
"name": "name",
|
|
2133
2162
|
"required": true,
|
|
2134
|
-
"summary": "
|
|
2163
|
+
"summary": "Unique name of the MCP server.",
|
|
2135
2164
|
"hasDynamicHelp": false,
|
|
2136
2165
|
"multiple": false,
|
|
2137
2166
|
"type": "option"
|
|
2138
2167
|
},
|
|
2139
2168
|
"label": {
|
|
2140
2169
|
"name": "label",
|
|
2141
|
-
"summary": "
|
|
2170
|
+
"summary": "Human-readable label for the MCP server.",
|
|
2142
2171
|
"hasDynamicHelp": false,
|
|
2143
2172
|
"multiple": false,
|
|
2144
2173
|
"type": "option"
|
|
2145
2174
|
},
|
|
2146
2175
|
"description": {
|
|
2147
2176
|
"name": "description",
|
|
2148
|
-
"summary": "
|
|
2177
|
+
"summary": "Description of the MCP server.",
|
|
2149
2178
|
"hasDynamicHelp": false,
|
|
2150
2179
|
"multiple": false,
|
|
2151
2180
|
"type": "option"
|
|
2152
2181
|
},
|
|
2153
2182
|
"server-url": {
|
|
2154
2183
|
"name": "server-url",
|
|
2155
|
-
"
|
|
2184
|
+
"required": true,
|
|
2185
|
+
"summary": "URL of the external MCP server.",
|
|
2156
2186
|
"hasDynamicHelp": false,
|
|
2157
2187
|
"multiple": false,
|
|
2158
2188
|
"type": "option"
|
|
2159
2189
|
},
|
|
2160
2190
|
"auth-type": {
|
|
2161
2191
|
"name": "auth-type",
|
|
2162
|
-
"summary": "Authorization type to
|
|
2192
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
2193
|
+
"default": "NO_AUTH",
|
|
2163
2194
|
"hasDynamicHelp": false,
|
|
2164
2195
|
"multiple": false,
|
|
2165
2196
|
"options": [
|
|
@@ -2170,28 +2201,28 @@
|
|
|
2170
2201
|
},
|
|
2171
2202
|
"identity-provider": {
|
|
2172
2203
|
"name": "identity-provider",
|
|
2173
|
-
"summary": "Identity provider
|
|
2204
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
2174
2205
|
"hasDynamicHelp": false,
|
|
2175
2206
|
"multiple": false,
|
|
2176
2207
|
"type": "option"
|
|
2177
2208
|
},
|
|
2178
2209
|
"client-id": {
|
|
2179
2210
|
"name": "client-id",
|
|
2180
|
-
"summary": "OAuth client ID
|
|
2211
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
2181
2212
|
"hasDynamicHelp": false,
|
|
2182
2213
|
"multiple": false,
|
|
2183
2214
|
"type": "option"
|
|
2184
2215
|
},
|
|
2185
2216
|
"client-secret": {
|
|
2186
2217
|
"name": "client-secret",
|
|
2187
|
-
"summary": "OAuth client secret
|
|
2218
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2188
2219
|
"hasDynamicHelp": false,
|
|
2189
2220
|
"multiple": false,
|
|
2190
2221
|
"type": "option"
|
|
2191
2222
|
},
|
|
2192
2223
|
"scope": {
|
|
2193
2224
|
"name": "scope",
|
|
2194
|
-
"summary": "OAuth scope
|
|
2225
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
2195
2226
|
"hasDynamicHelp": false,
|
|
2196
2227
|
"multiple": false,
|
|
2197
2228
|
"type": "option"
|
|
@@ -2199,13 +2230,13 @@
|
|
|
2199
2230
|
},
|
|
2200
2231
|
"hasDynamicHelp": true,
|
|
2201
2232
|
"hiddenAliases": [],
|
|
2202
|
-
"id": "agent:mcp:
|
|
2233
|
+
"id": "agent:mcp:create",
|
|
2203
2234
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2204
2235
|
"pluginName": "@salesforce/plugin-agent",
|
|
2205
2236
|
"pluginType": "core",
|
|
2206
2237
|
"state": "preview",
|
|
2207
2238
|
"strict": true,
|
|
2208
|
-
"summary": "
|
|
2239
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
2209
2240
|
"enableJsonFlag": true,
|
|
2210
2241
|
"isESM": true,
|
|
2211
2242
|
"relativePath": [
|
|
@@ -2213,28 +2244,25 @@
|
|
|
2213
2244
|
"commands",
|
|
2214
2245
|
"agent",
|
|
2215
2246
|
"mcp",
|
|
2216
|
-
"
|
|
2247
|
+
"create.js"
|
|
2217
2248
|
],
|
|
2218
2249
|
"aliasPermutations": [],
|
|
2219
2250
|
"permutations": [
|
|
2220
|
-
"agent:mcp:
|
|
2221
|
-
"mcp:agent:
|
|
2222
|
-
"mcp:
|
|
2223
|
-
"agent:
|
|
2224
|
-
"
|
|
2225
|
-
"
|
|
2251
|
+
"agent:mcp:create",
|
|
2252
|
+
"mcp:agent:create",
|
|
2253
|
+
"mcp:create:agent",
|
|
2254
|
+
"agent:create:mcp",
|
|
2255
|
+
"create:agent:mcp",
|
|
2256
|
+
"create:mcp:agent"
|
|
2226
2257
|
]
|
|
2227
2258
|
},
|
|
2228
|
-
"agent:
|
|
2259
|
+
"agent:mcp:delete": {
|
|
2229
2260
|
"aliases": [],
|
|
2230
2261
|
"args": {},
|
|
2231
|
-
"description": "
|
|
2262
|
+
"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).",
|
|
2232
2263
|
"examples": [
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
2235
|
-
"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",
|
|
2236
|
-
"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",
|
|
2237
|
-
"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>"
|
|
2264
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
2265
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
2238
2266
|
],
|
|
2239
2267
|
"flags": {
|
|
2240
2268
|
"json": {
|
|
@@ -2269,129 +2297,57 @@
|
|
|
2269
2297
|
"multiple": false,
|
|
2270
2298
|
"type": "option"
|
|
2271
2299
|
},
|
|
2272
|
-
"
|
|
2273
|
-
"
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
"
|
|
2277
|
-
"required": false,
|
|
2278
|
-
"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.",
|
|
2279
|
-
"hasDynamicHelp": false,
|
|
2280
|
-
"multiple": false,
|
|
2281
|
-
"type": "option"
|
|
2282
|
-
},
|
|
2283
|
-
"api-name": {
|
|
2284
|
-
"char": "n",
|
|
2285
|
-
"exclusive": [
|
|
2286
|
-
"authoring-bundle"
|
|
2287
|
-
],
|
|
2288
|
-
"name": "api-name",
|
|
2289
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2290
|
-
"hasDynamicHelp": false,
|
|
2291
|
-
"multiple": false,
|
|
2292
|
-
"type": "option"
|
|
2293
|
-
},
|
|
2294
|
-
"authoring-bundle": {
|
|
2295
|
-
"exclusive": [
|
|
2296
|
-
"api-name"
|
|
2297
|
-
],
|
|
2298
|
-
"name": "authoring-bundle",
|
|
2299
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2300
|
+
"mcp-server-id": {
|
|
2301
|
+
"char": "i",
|
|
2302
|
+
"name": "mcp-server-id",
|
|
2303
|
+
"required": true,
|
|
2304
|
+
"summary": "ID of the MCP server to delete.",
|
|
2300
2305
|
"hasDynamicHelp": false,
|
|
2301
2306
|
"multiple": false,
|
|
2302
2307
|
"type": "option"
|
|
2303
2308
|
},
|
|
2304
|
-
"all": {
|
|
2305
|
-
"exclusive": [
|
|
2306
|
-
"session-id"
|
|
2307
|
-
],
|
|
2308
|
-
"name": "all",
|
|
2309
|
-
"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.",
|
|
2310
|
-
"allowNo": false,
|
|
2311
|
-
"type": "boolean"
|
|
2312
|
-
},
|
|
2313
2309
|
"no-prompt": {
|
|
2314
|
-
"char": "p",
|
|
2315
2310
|
"name": "no-prompt",
|
|
2316
|
-
"summary": "
|
|
2311
|
+
"summary": "Skip the confirmation prompt and delete the MCP server immediately.",
|
|
2317
2312
|
"allowNo": false,
|
|
2318
2313
|
"type": "boolean"
|
|
2319
2314
|
}
|
|
2320
2315
|
},
|
|
2321
2316
|
"hasDynamicHelp": true,
|
|
2322
2317
|
"hiddenAliases": [],
|
|
2323
|
-
"id": "agent:
|
|
2318
|
+
"id": "agent:mcp:delete",
|
|
2324
2319
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2325
2320
|
"pluginName": "@salesforce/plugin-agent",
|
|
2326
2321
|
"pluginType": "core",
|
|
2322
|
+
"state": "preview",
|
|
2327
2323
|
"strict": true,
|
|
2328
|
-
"summary": "
|
|
2324
|
+
"summary": "Delete an MCP server from the API Catalog.",
|
|
2329
2325
|
"enableJsonFlag": true,
|
|
2330
|
-
"requiresProject": true,
|
|
2331
|
-
"envVariablesSection": {
|
|
2332
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2333
|
-
"body": [
|
|
2334
|
-
{
|
|
2335
|
-
"name": "SF_TARGET_ORG",
|
|
2336
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2337
|
-
}
|
|
2338
|
-
]
|
|
2339
|
-
},
|
|
2340
|
-
"errorCodes": {
|
|
2341
|
-
"header": "ERROR CODES",
|
|
2342
|
-
"body": [
|
|
2343
|
-
{
|
|
2344
|
-
"name": "Succeeded (0)",
|
|
2345
|
-
"description": "Preview session ended successfully and traces saved."
|
|
2346
|
-
},
|
|
2347
|
-
{
|
|
2348
|
-
"name": "ExactlyOneRequired (2)",
|
|
2349
|
-
"description": "Neither --api-name nor --authoring-bundle was provided (required when --all is not set)."
|
|
2350
|
-
},
|
|
2351
|
-
{
|
|
2352
|
-
"name": "NotFound (2)",
|
|
2353
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2354
|
-
},
|
|
2355
|
-
{
|
|
2356
|
-
"name": "PreviewEndFailed (4)",
|
|
2357
|
-
"description": "Failed to end the preview session."
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"name": "PreviewEndPartialFailure (68)",
|
|
2361
|
-
"description": "With --all, one or more sessions failed to end while others succeeded."
|
|
2362
|
-
},
|
|
2363
|
-
{
|
|
2364
|
-
"name": "SessionAmbiguous (5)",
|
|
2365
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2366
|
-
}
|
|
2367
|
-
]
|
|
2368
|
-
},
|
|
2369
2326
|
"isESM": true,
|
|
2370
2327
|
"relativePath": [
|
|
2371
2328
|
"lib",
|
|
2372
2329
|
"commands",
|
|
2373
2330
|
"agent",
|
|
2374
|
-
"
|
|
2375
|
-
"
|
|
2331
|
+
"mcp",
|
|
2332
|
+
"delete.js"
|
|
2376
2333
|
],
|
|
2377
2334
|
"aliasPermutations": [],
|
|
2378
2335
|
"permutations": [
|
|
2379
|
-
"agent:
|
|
2380
|
-
"
|
|
2381
|
-
"
|
|
2382
|
-
"agent:
|
|
2383
|
-
"
|
|
2384
|
-
"
|
|
2336
|
+
"agent:mcp:delete",
|
|
2337
|
+
"mcp:agent:delete",
|
|
2338
|
+
"mcp:delete:agent",
|
|
2339
|
+
"agent:delete:mcp",
|
|
2340
|
+
"delete:agent:mcp",
|
|
2341
|
+
"delete:mcp:agent"
|
|
2385
2342
|
]
|
|
2386
2343
|
},
|
|
2387
|
-
"agent:
|
|
2344
|
+
"agent:mcp:fetch": {
|
|
2388
2345
|
"aliases": [],
|
|
2389
2346
|
"args": {},
|
|
2390
|
-
"description": "
|
|
2347
|
+
"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.",
|
|
2391
2348
|
"examples": [
|
|
2392
|
-
"
|
|
2393
|
-
"
|
|
2394
|
-
"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"
|
|
2349
|
+
"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",
|
|
2350
|
+
"Fetch MCP server assets and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0XSxx0000000001 --json"
|
|
2395
2351
|
],
|
|
2396
2352
|
"flags": {
|
|
2397
2353
|
"json": {
|
|
@@ -2421,39 +2377,16 @@
|
|
|
2421
2377
|
},
|
|
2422
2378
|
"api-version": {
|
|
2423
2379
|
"description": "Override the api version used for api requests made by this command",
|
|
2424
|
-
"name": "api-version",
|
|
2425
|
-
"hasDynamicHelp": false,
|
|
2426
|
-
"multiple": false,
|
|
2427
|
-
"type": "option"
|
|
2428
|
-
},
|
|
2429
|
-
"session-id": {
|
|
2430
|
-
"name": "session-id",
|
|
2431
|
-
"required": false,
|
|
2432
|
-
"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.",
|
|
2433
|
-
"hasDynamicHelp": false,
|
|
2434
|
-
"multiple": false,
|
|
2435
|
-
"type": "option"
|
|
2436
|
-
},
|
|
2437
|
-
"utterance": {
|
|
2438
|
-
"char": "u",
|
|
2439
|
-
"name": "utterance",
|
|
2440
|
-
"required": true,
|
|
2441
|
-
"summary": "Utterance to send to the agent, enclosed in double quotes.",
|
|
2442
|
-
"hasDynamicHelp": false,
|
|
2443
|
-
"multiple": false,
|
|
2444
|
-
"type": "option"
|
|
2445
|
-
},
|
|
2446
|
-
"api-name": {
|
|
2447
|
-
"char": "n",
|
|
2448
|
-
"name": "api-name",
|
|
2449
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2380
|
+
"name": "api-version",
|
|
2450
2381
|
"hasDynamicHelp": false,
|
|
2451
2382
|
"multiple": false,
|
|
2452
2383
|
"type": "option"
|
|
2453
2384
|
},
|
|
2454
|
-
"
|
|
2455
|
-
"
|
|
2456
|
-
"
|
|
2385
|
+
"mcp-server-id": {
|
|
2386
|
+
"char": "i",
|
|
2387
|
+
"name": "mcp-server-id",
|
|
2388
|
+
"required": true,
|
|
2389
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
2457
2390
|
"hasDynamicHelp": false,
|
|
2458
2391
|
"multiple": false,
|
|
2459
2392
|
"type": "option"
|
|
@@ -2461,68 +2394,39 @@
|
|
|
2461
2394
|
},
|
|
2462
2395
|
"hasDynamicHelp": true,
|
|
2463
2396
|
"hiddenAliases": [],
|
|
2464
|
-
"id": "agent:
|
|
2397
|
+
"id": "agent:mcp:fetch",
|
|
2465
2398
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2466
2399
|
"pluginName": "@salesforce/plugin-agent",
|
|
2467
2400
|
"pluginType": "core",
|
|
2401
|
+
"state": "preview",
|
|
2468
2402
|
"strict": true,
|
|
2469
|
-
"summary": "
|
|
2403
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
2470
2404
|
"enableJsonFlag": true,
|
|
2471
|
-
"requiresProject": true,
|
|
2472
|
-
"envVariablesSection": {
|
|
2473
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2474
|
-
"body": [
|
|
2475
|
-
{
|
|
2476
|
-
"name": "SF_TARGET_ORG",
|
|
2477
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2478
|
-
}
|
|
2479
|
-
]
|
|
2480
|
-
},
|
|
2481
|
-
"errorCodes": {
|
|
2482
|
-
"header": "ERROR CODES",
|
|
2483
|
-
"body": [
|
|
2484
|
-
{
|
|
2485
|
-
"name": "Succeeded (0)",
|
|
2486
|
-
"description": "Message sent successfully and agent response received."
|
|
2487
|
-
},
|
|
2488
|
-
{
|
|
2489
|
-
"name": "NotFound (2)",
|
|
2490
|
-
"description": "Agent not found, or no preview session exists for this agent."
|
|
2491
|
-
},
|
|
2492
|
-
{
|
|
2493
|
-
"name": "PreviewSendFailed (4)",
|
|
2494
|
-
"description": "Failed to send message or receive response from the preview session."
|
|
2495
|
-
},
|
|
2496
|
-
{
|
|
2497
|
-
"name": "SessionAmbiguous (5)",
|
|
2498
|
-
"description": "Multiple preview sessions found; specify --session-id to choose one."
|
|
2499
|
-
}
|
|
2500
|
-
]
|
|
2501
|
-
},
|
|
2502
2405
|
"isESM": true,
|
|
2503
2406
|
"relativePath": [
|
|
2504
2407
|
"lib",
|
|
2505
2408
|
"commands",
|
|
2506
2409
|
"agent",
|
|
2507
|
-
"
|
|
2508
|
-
"
|
|
2410
|
+
"mcp",
|
|
2411
|
+
"fetch.js"
|
|
2509
2412
|
],
|
|
2510
2413
|
"aliasPermutations": [],
|
|
2511
2414
|
"permutations": [
|
|
2512
|
-
"agent:
|
|
2513
|
-
"
|
|
2514
|
-
"
|
|
2515
|
-
"agent:
|
|
2516
|
-
"
|
|
2517
|
-
"
|
|
2415
|
+
"agent:mcp:fetch",
|
|
2416
|
+
"mcp:agent:fetch",
|
|
2417
|
+
"mcp:fetch:agent",
|
|
2418
|
+
"agent:fetch:mcp",
|
|
2419
|
+
"fetch:agent:mcp",
|
|
2420
|
+
"fetch:mcp:agent"
|
|
2518
2421
|
]
|
|
2519
2422
|
},
|
|
2520
|
-
"agent:
|
|
2423
|
+
"agent:mcp:get": {
|
|
2521
2424
|
"aliases": [],
|
|
2522
2425
|
"args": {},
|
|
2523
|
-
"description": "
|
|
2426
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
2524
2427
|
"examples": [
|
|
2525
|
-
"
|
|
2428
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
2429
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2526
2430
|
],
|
|
2527
2431
|
"flags": {
|
|
2528
2432
|
"json": {
|
|
@@ -2539,53 +2443,69 @@
|
|
|
2539
2443
|
"hasDynamicHelp": false,
|
|
2540
2444
|
"multiple": false,
|
|
2541
2445
|
"type": "option"
|
|
2446
|
+
},
|
|
2447
|
+
"target-org": {
|
|
2448
|
+
"char": "o",
|
|
2449
|
+
"name": "target-org",
|
|
2450
|
+
"noCacheDefault": true,
|
|
2451
|
+
"required": true,
|
|
2452
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2453
|
+
"hasDynamicHelp": true,
|
|
2454
|
+
"multiple": false,
|
|
2455
|
+
"type": "option"
|
|
2456
|
+
},
|
|
2457
|
+
"api-version": {
|
|
2458
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2459
|
+
"name": "api-version",
|
|
2460
|
+
"hasDynamicHelp": false,
|
|
2461
|
+
"multiple": false,
|
|
2462
|
+
"type": "option"
|
|
2463
|
+
},
|
|
2464
|
+
"mcp-server-id": {
|
|
2465
|
+
"char": "i",
|
|
2466
|
+
"name": "mcp-server-id",
|
|
2467
|
+
"required": true,
|
|
2468
|
+
"summary": "The identifier of the MCP server to retrieve.",
|
|
2469
|
+
"hasDynamicHelp": false,
|
|
2470
|
+
"multiple": false,
|
|
2471
|
+
"type": "option"
|
|
2542
2472
|
}
|
|
2543
2473
|
},
|
|
2544
|
-
"hasDynamicHelp":
|
|
2474
|
+
"hasDynamicHelp": true,
|
|
2545
2475
|
"hiddenAliases": [],
|
|
2546
|
-
"id": "agent:
|
|
2476
|
+
"id": "agent:mcp:get",
|
|
2547
2477
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2548
2478
|
"pluginName": "@salesforce/plugin-agent",
|
|
2549
2479
|
"pluginType": "core",
|
|
2480
|
+
"state": "preview",
|
|
2550
2481
|
"strict": true,
|
|
2551
|
-
"summary": "
|
|
2482
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
2552
2483
|
"enableJsonFlag": true,
|
|
2553
|
-
"requiresProject": true,
|
|
2554
|
-
"errorCodes": {
|
|
2555
|
-
"header": "ERROR CODES",
|
|
2556
|
-
"body": [
|
|
2557
|
-
{
|
|
2558
|
-
"name": "Succeeded (0)",
|
|
2559
|
-
"description": "Sessions listed successfully (or empty list if no active sessions)."
|
|
2560
|
-
}
|
|
2561
|
-
]
|
|
2562
|
-
},
|
|
2563
2484
|
"isESM": true,
|
|
2564
2485
|
"relativePath": [
|
|
2565
2486
|
"lib",
|
|
2566
2487
|
"commands",
|
|
2567
2488
|
"agent",
|
|
2568
|
-
"
|
|
2569
|
-
"
|
|
2489
|
+
"mcp",
|
|
2490
|
+
"get.js"
|
|
2570
2491
|
],
|
|
2571
2492
|
"aliasPermutations": [],
|
|
2572
2493
|
"permutations": [
|
|
2573
|
-
"agent:
|
|
2574
|
-
"
|
|
2575
|
-
"
|
|
2576
|
-
"agent:
|
|
2577
|
-
"
|
|
2578
|
-
"
|
|
2494
|
+
"agent:mcp:get",
|
|
2495
|
+
"mcp:agent:get",
|
|
2496
|
+
"mcp:get:agent",
|
|
2497
|
+
"agent:get:mcp",
|
|
2498
|
+
"get:agent:mcp",
|
|
2499
|
+
"get:mcp:agent"
|
|
2579
2500
|
]
|
|
2580
2501
|
},
|
|
2581
|
-
"agent:
|
|
2502
|
+
"agent:mcp:list": {
|
|
2582
2503
|
"aliases": [],
|
|
2583
2504
|
"args": {},
|
|
2584
|
-
"description": "
|
|
2505
|
+
"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.",
|
|
2585
2506
|
"examples": [
|
|
2586
|
-
"
|
|
2587
|
-
"
|
|
2588
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2507
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
2508
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
2589
2509
|
],
|
|
2590
2510
|
"flags": {
|
|
2591
2511
|
"json": {
|
|
@@ -2620,131 +2540,70 @@
|
|
|
2620
2540
|
"multiple": false,
|
|
2621
2541
|
"type": "option"
|
|
2622
2542
|
},
|
|
2623
|
-
"
|
|
2624
|
-
"
|
|
2625
|
-
"
|
|
2626
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2543
|
+
"label": {
|
|
2544
|
+
"name": "label",
|
|
2545
|
+
"summary": "Filter the MCP servers by label.",
|
|
2627
2546
|
"hasDynamicHelp": false,
|
|
2628
2547
|
"multiple": false,
|
|
2629
2548
|
"type": "option"
|
|
2630
2549
|
},
|
|
2631
|
-
"
|
|
2632
|
-
"name": "
|
|
2633
|
-
"summary": "
|
|
2550
|
+
"type": {
|
|
2551
|
+
"name": "type",
|
|
2552
|
+
"summary": "Filter the MCP servers by type.",
|
|
2634
2553
|
"hasDynamicHelp": false,
|
|
2635
2554
|
"multiple": false,
|
|
2636
|
-
"
|
|
2637
|
-
|
|
2638
|
-
"use-live-actions": {
|
|
2639
|
-
"exclusive": [
|
|
2640
|
-
"simulate-actions"
|
|
2641
|
-
],
|
|
2642
|
-
"name": "use-live-actions",
|
|
2643
|
-
"summary": "Execute real actions in the org (Apex classes, flows, etc.). Required with --authoring-bundle.",
|
|
2644
|
-
"allowNo": false,
|
|
2645
|
-
"type": "boolean"
|
|
2646
|
-
},
|
|
2647
|
-
"simulate-actions": {
|
|
2648
|
-
"exclusive": [
|
|
2649
|
-
"use-live-actions"
|
|
2555
|
+
"options": [
|
|
2556
|
+
"EXTERNAL"
|
|
2650
2557
|
],
|
|
2651
|
-
"name": "simulate-actions",
|
|
2652
|
-
"summary": "Use AI to simulate action execution instead of calling real actions. Required with --authoring-bundle.",
|
|
2653
|
-
"allowNo": false,
|
|
2654
|
-
"type": "boolean"
|
|
2655
|
-
},
|
|
2656
|
-
"context-variables": {
|
|
2657
|
-
"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 defaults to Text.",
|
|
2658
|
-
"name": "context-variables",
|
|
2659
|
-
"summary": "Session variables for the agent preview session, in the form Name=Value.",
|
|
2660
|
-
"delimiter": ",",
|
|
2661
|
-
"hasDynamicHelp": false,
|
|
2662
|
-
"multiple": true,
|
|
2663
2558
|
"type": "option"
|
|
2664
2559
|
},
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2667
|
-
|
|
2668
|
-
],
|
|
2669
|
-
"hidden": true,
|
|
2670
|
-
"name": "agent-json",
|
|
2671
|
-
"summary": "Path to a pre-compiled AgentJSON file to use instead of compiling the Agent Script file. Intended for internal use and testing.",
|
|
2560
|
+
"status": {
|
|
2561
|
+
"name": "status",
|
|
2562
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2672
2563
|
"hasDynamicHelp": false,
|
|
2673
2564
|
"multiple": false,
|
|
2565
|
+
"options": [
|
|
2566
|
+
"ACTIVE",
|
|
2567
|
+
"DISCONNECTED"
|
|
2568
|
+
],
|
|
2674
2569
|
"type": "option"
|
|
2675
2570
|
}
|
|
2676
2571
|
},
|
|
2677
2572
|
"hasDynamicHelp": true,
|
|
2678
2573
|
"hiddenAliases": [],
|
|
2679
|
-
"id": "agent:
|
|
2574
|
+
"id": "agent:mcp:list",
|
|
2680
2575
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2681
2576
|
"pluginName": "@salesforce/plugin-agent",
|
|
2682
2577
|
"pluginType": "core",
|
|
2578
|
+
"state": "preview",
|
|
2683
2579
|
"strict": true,
|
|
2684
|
-
"summary": "
|
|
2580
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2685
2581
|
"enableJsonFlag": true,
|
|
2686
|
-
"requiresProject": true,
|
|
2687
|
-
"envVariablesSection": {
|
|
2688
|
-
"header": "ENVIRONMENT VARIABLES",
|
|
2689
|
-
"body": [
|
|
2690
|
-
{
|
|
2691
|
-
"name": "SF_TARGET_ORG",
|
|
2692
|
-
"description": "Username or alias of your default org. Overrides the target-org configuration variable."
|
|
2693
|
-
}
|
|
2694
|
-
]
|
|
2695
|
-
},
|
|
2696
|
-
"errorCodes": {
|
|
2697
|
-
"header": "ERROR CODES",
|
|
2698
|
-
"body": [
|
|
2699
|
-
{
|
|
2700
|
-
"name": "Succeeded (0)",
|
|
2701
|
-
"description": "Preview session started successfully."
|
|
2702
|
-
},
|
|
2703
|
-
{
|
|
2704
|
-
"name": "Failed (1)",
|
|
2705
|
-
"description": "Agent Script compilation failed (syntax errors in the script)."
|
|
2706
|
-
},
|
|
2707
|
-
{
|
|
2708
|
-
"name": "NotFound (2)",
|
|
2709
|
-
"description": "Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your org or region)."
|
|
2710
|
-
},
|
|
2711
|
-
{
|
|
2712
|
-
"name": "ServerError (3)",
|
|
2713
|
-
"description": "Compilation API returned HTTP 500 (server error during compilation)."
|
|
2714
|
-
},
|
|
2715
|
-
{
|
|
2716
|
-
"name": "PreviewStartFailed (4)",
|
|
2717
|
-
"description": "Preview session failed to start due to API or network errors."
|
|
2718
|
-
}
|
|
2719
|
-
]
|
|
2720
|
-
},
|
|
2721
2582
|
"isESM": true,
|
|
2722
2583
|
"relativePath": [
|
|
2723
2584
|
"lib",
|
|
2724
2585
|
"commands",
|
|
2725
2586
|
"agent",
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2587
|
+
"mcp",
|
|
2588
|
+
"list.js"
|
|
2728
2589
|
],
|
|
2729
2590
|
"aliasPermutations": [],
|
|
2730
2591
|
"permutations": [
|
|
2731
|
-
"agent:
|
|
2732
|
-
"
|
|
2733
|
-
"
|
|
2734
|
-
"agent:
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2592
|
+
"agent:mcp:list",
|
|
2593
|
+
"mcp:agent:list",
|
|
2594
|
+
"mcp:list:agent",
|
|
2595
|
+
"agent:list:mcp",
|
|
2596
|
+
"list:agent:mcp",
|
|
2597
|
+
"list:mcp:agent"
|
|
2737
2598
|
]
|
|
2738
2599
|
},
|
|
2739
|
-
"agent:
|
|
2600
|
+
"agent:mcp:update": {
|
|
2740
2601
|
"aliases": [],
|
|
2741
|
-
"args": {},
|
|
2742
|
-
"description": "
|
|
2743
|
-
"examples": [
|
|
2744
|
-
"
|
|
2745
|
-
"
|
|
2746
|
-
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
2747
|
-
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
2602
|
+
"args": {},
|
|
2603
|
+
"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.",
|
|
2604
|
+
"examples": [
|
|
2605
|
+
"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",
|
|
2606
|
+
"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"
|
|
2748
2607
|
],
|
|
2749
2608
|
"flags": {
|
|
2750
2609
|
"json": {
|
|
@@ -2779,85 +2638,102 @@
|
|
|
2779
2638
|
"multiple": false,
|
|
2780
2639
|
"type": "option"
|
|
2781
2640
|
},
|
|
2782
|
-
"
|
|
2783
|
-
"char": "
|
|
2784
|
-
"name": "
|
|
2785
|
-
"
|
|
2641
|
+
"mcp-server-id": {
|
|
2642
|
+
"char": "i",
|
|
2643
|
+
"name": "mcp-server-id",
|
|
2644
|
+
"required": true,
|
|
2645
|
+
"summary": "ID of the MCP server to update.",
|
|
2786
2646
|
"hasDynamicHelp": false,
|
|
2787
2647
|
"multiple": false,
|
|
2788
2648
|
"type": "option"
|
|
2789
2649
|
},
|
|
2790
|
-
"
|
|
2791
|
-
"name": "
|
|
2792
|
-
"summary": "
|
|
2793
|
-
"
|
|
2794
|
-
"
|
|
2650
|
+
"label": {
|
|
2651
|
+
"name": "label",
|
|
2652
|
+
"summary": "New display label for the MCP server.",
|
|
2653
|
+
"hasDynamicHelp": false,
|
|
2654
|
+
"multiple": false,
|
|
2655
|
+
"type": "option"
|
|
2795
2656
|
},
|
|
2796
|
-
"
|
|
2797
|
-
"
|
|
2798
|
-
"
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
"
|
|
2802
|
-
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2803
|
-
"allowNo": false,
|
|
2804
|
-
"type": "boolean"
|
|
2657
|
+
"description": {
|
|
2658
|
+
"name": "description",
|
|
2659
|
+
"summary": "New description for the MCP server.",
|
|
2660
|
+
"hasDynamicHelp": false,
|
|
2661
|
+
"multiple": false,
|
|
2662
|
+
"type": "option"
|
|
2805
2663
|
},
|
|
2806
|
-
"
|
|
2807
|
-
"
|
|
2808
|
-
|
|
2664
|
+
"server-url": {
|
|
2665
|
+
"name": "server-url",
|
|
2666
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2667
|
+
"hasDynamicHelp": false,
|
|
2668
|
+
"multiple": false,
|
|
2669
|
+
"type": "option"
|
|
2670
|
+
},
|
|
2671
|
+
"auth-type": {
|
|
2672
|
+
"name": "auth-type",
|
|
2673
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2674
|
+
"hasDynamicHelp": false,
|
|
2675
|
+
"multiple": false,
|
|
2676
|
+
"options": [
|
|
2677
|
+
"OAUTH",
|
|
2678
|
+
"NO_AUTH"
|
|
2809
2679
|
],
|
|
2810
|
-
"
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
"
|
|
2680
|
+
"type": "option"
|
|
2681
|
+
},
|
|
2682
|
+
"identity-provider": {
|
|
2683
|
+
"name": "identity-provider",
|
|
2684
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2685
|
+
"hasDynamicHelp": false,
|
|
2686
|
+
"multiple": false,
|
|
2687
|
+
"type": "option"
|
|
2688
|
+
},
|
|
2689
|
+
"client-id": {
|
|
2690
|
+
"name": "client-id",
|
|
2691
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2692
|
+
"hasDynamicHelp": false,
|
|
2693
|
+
"multiple": false,
|
|
2694
|
+
"type": "option"
|
|
2695
|
+
},
|
|
2696
|
+
"client-secret": {
|
|
2697
|
+
"name": "client-secret",
|
|
2698
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2699
|
+
"hasDynamicHelp": false,
|
|
2700
|
+
"multiple": false,
|
|
2701
|
+
"type": "option"
|
|
2702
|
+
},
|
|
2703
|
+
"scope": {
|
|
2704
|
+
"name": "scope",
|
|
2705
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2706
|
+
"hasDynamicHelp": false,
|
|
2707
|
+
"multiple": false,
|
|
2708
|
+
"type": "option"
|
|
2814
2709
|
}
|
|
2815
2710
|
},
|
|
2816
2711
|
"hasDynamicHelp": true,
|
|
2817
2712
|
"hiddenAliases": [],
|
|
2818
|
-
"id": "agent:
|
|
2713
|
+
"id": "agent:mcp:update",
|
|
2819
2714
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2820
2715
|
"pluginName": "@salesforce/plugin-agent",
|
|
2821
2716
|
"pluginType": "core",
|
|
2717
|
+
"state": "preview",
|
|
2822
2718
|
"strict": true,
|
|
2823
|
-
"summary": "
|
|
2719
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2824
2720
|
"enableJsonFlag": true,
|
|
2825
|
-
"requiresProject": true,
|
|
2826
|
-
"errorCodes": {
|
|
2827
|
-
"header": "ERROR CODES",
|
|
2828
|
-
"body": [
|
|
2829
|
-
{
|
|
2830
|
-
"name": "Succeeded (0)",
|
|
2831
|
-
"description": "Agent published successfully without errors."
|
|
2832
|
-
},
|
|
2833
|
-
{
|
|
2834
|
-
"name": "Failed (1)",
|
|
2835
|
-
"description": "Compilation errors found in the Agent Script file."
|
|
2836
|
-
}
|
|
2837
|
-
]
|
|
2838
|
-
},
|
|
2839
|
-
"FLAGGABLE_PROMPTS": {
|
|
2840
|
-
"api-name": {
|
|
2841
|
-
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2842
|
-
"promptMessage": "API name of the authoring bundle to publish"
|
|
2843
|
-
}
|
|
2844
|
-
},
|
|
2845
2721
|
"isESM": true,
|
|
2846
2722
|
"relativePath": [
|
|
2847
2723
|
"lib",
|
|
2848
2724
|
"commands",
|
|
2849
2725
|
"agent",
|
|
2850
|
-
"
|
|
2851
|
-
"
|
|
2726
|
+
"mcp",
|
|
2727
|
+
"update.js"
|
|
2852
2728
|
],
|
|
2853
2729
|
"aliasPermutations": [],
|
|
2854
2730
|
"permutations": [
|
|
2855
|
-
"agent:
|
|
2856
|
-
"
|
|
2857
|
-
"
|
|
2858
|
-
"agent:
|
|
2859
|
-
"
|
|
2860
|
-
"
|
|
2731
|
+
"agent:mcp:update",
|
|
2732
|
+
"mcp:agent:update",
|
|
2733
|
+
"mcp:update:agent",
|
|
2734
|
+
"agent:update:mcp",
|
|
2735
|
+
"update:agent:mcp",
|
|
2736
|
+
"update:mcp:agent"
|
|
2861
2737
|
]
|
|
2862
2738
|
},
|
|
2863
2739
|
"agent:test:create": {
|
|
@@ -3997,6 +3873,130 @@
|
|
|
3997
3873
|
"read:trace:agent"
|
|
3998
3874
|
]
|
|
3999
3875
|
},
|
|
3876
|
+
"agent:publish:authoring-bundle": {
|
|
3877
|
+
"aliases": [],
|
|
3878
|
+
"args": {},
|
|
3879
|
+
"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.",
|
|
3880
|
+
"examples": [
|
|
3881
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
3882
|
+
"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",
|
|
3883
|
+
"Publish with verbose output to see all retrieved and deployed metadata components:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --verbose",
|
|
3884
|
+
"Publish with concise output showing only essential information:\n<%= config.bin %> <%= command.id %> --api-name MyAuthoringbundle --concise"
|
|
3885
|
+
],
|
|
3886
|
+
"flags": {
|
|
3887
|
+
"json": {
|
|
3888
|
+
"description": "Format output as json.",
|
|
3889
|
+
"helpGroup": "GLOBAL",
|
|
3890
|
+
"name": "json",
|
|
3891
|
+
"allowNo": false,
|
|
3892
|
+
"type": "boolean"
|
|
3893
|
+
},
|
|
3894
|
+
"flags-dir": {
|
|
3895
|
+
"helpGroup": "GLOBAL",
|
|
3896
|
+
"name": "flags-dir",
|
|
3897
|
+
"summary": "Import flag values from a directory.",
|
|
3898
|
+
"hasDynamicHelp": false,
|
|
3899
|
+
"multiple": false,
|
|
3900
|
+
"type": "option"
|
|
3901
|
+
},
|
|
3902
|
+
"target-org": {
|
|
3903
|
+
"char": "o",
|
|
3904
|
+
"name": "target-org",
|
|
3905
|
+
"noCacheDefault": true,
|
|
3906
|
+
"required": true,
|
|
3907
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3908
|
+
"hasDynamicHelp": true,
|
|
3909
|
+
"multiple": false,
|
|
3910
|
+
"type": "option"
|
|
3911
|
+
},
|
|
3912
|
+
"api-version": {
|
|
3913
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3914
|
+
"name": "api-version",
|
|
3915
|
+
"hasDynamicHelp": false,
|
|
3916
|
+
"multiple": false,
|
|
3917
|
+
"type": "option"
|
|
3918
|
+
},
|
|
3919
|
+
"api-name": {
|
|
3920
|
+
"char": "n",
|
|
3921
|
+
"name": "api-name",
|
|
3922
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3923
|
+
"hasDynamicHelp": false,
|
|
3924
|
+
"multiple": false,
|
|
3925
|
+
"type": "option"
|
|
3926
|
+
},
|
|
3927
|
+
"skip-retrieve": {
|
|
3928
|
+
"name": "skip-retrieve",
|
|
3929
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
3930
|
+
"allowNo": false,
|
|
3931
|
+
"type": "boolean"
|
|
3932
|
+
},
|
|
3933
|
+
"verbose": {
|
|
3934
|
+
"char": "v",
|
|
3935
|
+
"exclusive": [
|
|
3936
|
+
"concise"
|
|
3937
|
+
],
|
|
3938
|
+
"name": "verbose",
|
|
3939
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
3940
|
+
"allowNo": false,
|
|
3941
|
+
"type": "boolean"
|
|
3942
|
+
},
|
|
3943
|
+
"concise": {
|
|
3944
|
+
"exclusive": [
|
|
3945
|
+
"verbose"
|
|
3946
|
+
],
|
|
3947
|
+
"name": "concise",
|
|
3948
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
3949
|
+
"allowNo": false,
|
|
3950
|
+
"type": "boolean"
|
|
3951
|
+
}
|
|
3952
|
+
},
|
|
3953
|
+
"hasDynamicHelp": true,
|
|
3954
|
+
"hiddenAliases": [],
|
|
3955
|
+
"id": "agent:publish:authoring-bundle",
|
|
3956
|
+
"pluginAlias": "@salesforce/plugin-agent",
|
|
3957
|
+
"pluginName": "@salesforce/plugin-agent",
|
|
3958
|
+
"pluginType": "core",
|
|
3959
|
+
"strict": true,
|
|
3960
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
3961
|
+
"enableJsonFlag": true,
|
|
3962
|
+
"requiresProject": true,
|
|
3963
|
+
"errorCodes": {
|
|
3964
|
+
"header": "ERROR CODES",
|
|
3965
|
+
"body": [
|
|
3966
|
+
{
|
|
3967
|
+
"name": "Succeeded (0)",
|
|
3968
|
+
"description": "Agent published successfully without errors."
|
|
3969
|
+
},
|
|
3970
|
+
{
|
|
3971
|
+
"name": "Failed (1)",
|
|
3972
|
+
"description": "Compilation errors found in the Agent Script file."
|
|
3973
|
+
}
|
|
3974
|
+
]
|
|
3975
|
+
},
|
|
3976
|
+
"FLAGGABLE_PROMPTS": {
|
|
3977
|
+
"api-name": {
|
|
3978
|
+
"message": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
3979
|
+
"promptMessage": "API name of the authoring bundle to publish"
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"isESM": true,
|
|
3983
|
+
"relativePath": [
|
|
3984
|
+
"lib",
|
|
3985
|
+
"commands",
|
|
3986
|
+
"agent",
|
|
3987
|
+
"publish",
|
|
3988
|
+
"authoring-bundle.js"
|
|
3989
|
+
],
|
|
3990
|
+
"aliasPermutations": [],
|
|
3991
|
+
"permutations": [
|
|
3992
|
+
"agent:publish:authoring-bundle",
|
|
3993
|
+
"publish:agent:authoring-bundle",
|
|
3994
|
+
"publish:authoring-bundle:agent",
|
|
3995
|
+
"agent:authoring-bundle:publish",
|
|
3996
|
+
"authoring-bundle:agent:publish",
|
|
3997
|
+
"authoring-bundle:publish:agent"
|
|
3998
|
+
]
|
|
3999
|
+
},
|
|
4000
4000
|
"agent:validate:authoring-bundle": {
|
|
4001
4001
|
"aliases": [],
|
|
4002
4002
|
"args": {},
|
|
@@ -4667,5 +4667,5 @@
|
|
|
4667
4667
|
]
|
|
4668
4668
|
}
|
|
4669
4669
|
},
|
|
4670
|
-
"version": "2.0.
|
|
4670
|
+
"version": "2.0.4"
|
|
4671
4671
|
}
|