@salesforce/plugin-agent 2.0.4 → 2.0.5
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/oclif.manifest.json +607 -607
- package/package.json +4 -4
package/oclif.manifest.json
CHANGED
|
@@ -1604,16 +1604,13 @@
|
|
|
1604
1604
|
"test-spec:generate:agent"
|
|
1605
1605
|
]
|
|
1606
1606
|
},
|
|
1607
|
-
"agent:
|
|
1607
|
+
"agent:mcp:create": {
|
|
1608
1608
|
"aliases": [],
|
|
1609
1609
|
"args": {},
|
|
1610
|
-
"description": "
|
|
1610
|
+
"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.",
|
|
1611
1611
|
"examples": [
|
|
1612
|
-
"
|
|
1613
|
-
"
|
|
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>"
|
|
1612
|
+
"Create an MCP server with no authentication:\n<%= config.bin %> <%= command.id %> --name myServer --server-url https://mcp.example.com --target-org myOrg",
|
|
1613
|
+
"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"
|
|
1617
1614
|
],
|
|
1618
1615
|
"flags": {
|
|
1619
1616
|
"json": {
|
|
@@ -1648,129 +1645,113 @@
|
|
|
1648
1645
|
"multiple": false,
|
|
1649
1646
|
"type": "option"
|
|
1650
1647
|
},
|
|
1651
|
-
"
|
|
1652
|
-
"
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
"
|
|
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.",
|
|
1648
|
+
"name": {
|
|
1649
|
+
"char": "n",
|
|
1650
|
+
"name": "name",
|
|
1651
|
+
"required": true,
|
|
1652
|
+
"summary": "Unique name of the MCP server.",
|
|
1658
1653
|
"hasDynamicHelp": false,
|
|
1659
1654
|
"multiple": false,
|
|
1660
1655
|
"type": "option"
|
|
1661
1656
|
},
|
|
1662
|
-
"
|
|
1663
|
-
"
|
|
1664
|
-
"
|
|
1665
|
-
"authoring-bundle"
|
|
1666
|
-
],
|
|
1667
|
-
"name": "api-name",
|
|
1668
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
1657
|
+
"label": {
|
|
1658
|
+
"name": "label",
|
|
1659
|
+
"summary": "Human-readable label for the MCP server.",
|
|
1669
1660
|
"hasDynamicHelp": false,
|
|
1670
1661
|
"multiple": false,
|
|
1671
1662
|
"type": "option"
|
|
1672
1663
|
},
|
|
1673
|
-
"
|
|
1674
|
-
"
|
|
1675
|
-
|
|
1676
|
-
],
|
|
1677
|
-
"name": "authoring-bundle",
|
|
1678
|
-
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
1664
|
+
"description": {
|
|
1665
|
+
"name": "description",
|
|
1666
|
+
"summary": "Description of the MCP server.",
|
|
1679
1667
|
"hasDynamicHelp": false,
|
|
1680
1668
|
"multiple": false,
|
|
1681
1669
|
"type": "option"
|
|
1682
1670
|
},
|
|
1683
|
-
"
|
|
1684
|
-
"
|
|
1685
|
-
|
|
1671
|
+
"server-url": {
|
|
1672
|
+
"name": "server-url",
|
|
1673
|
+
"required": true,
|
|
1674
|
+
"summary": "URL of the external MCP server.",
|
|
1675
|
+
"hasDynamicHelp": false,
|
|
1676
|
+
"multiple": false,
|
|
1677
|
+
"type": "option"
|
|
1678
|
+
},
|
|
1679
|
+
"auth-type": {
|
|
1680
|
+
"name": "auth-type",
|
|
1681
|
+
"summary": "Authorization type to use when connecting to the MCP server.",
|
|
1682
|
+
"default": "NO_AUTH",
|
|
1683
|
+
"hasDynamicHelp": false,
|
|
1684
|
+
"multiple": false,
|
|
1685
|
+
"options": [
|
|
1686
|
+
"OAUTH",
|
|
1687
|
+
"NO_AUTH"
|
|
1686
1688
|
],
|
|
1687
|
-
"
|
|
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"
|
|
1689
|
+
"type": "option"
|
|
1691
1690
|
},
|
|
1692
|
-
"
|
|
1693
|
-
"
|
|
1694
|
-
"
|
|
1695
|
-
"
|
|
1696
|
-
"
|
|
1697
|
-
"type": "
|
|
1691
|
+
"identity-provider": {
|
|
1692
|
+
"name": "identity-provider",
|
|
1693
|
+
"summary": "Identity provider to use for OAuth authorization. Required when auth-type is OAUTH.",
|
|
1694
|
+
"hasDynamicHelp": false,
|
|
1695
|
+
"multiple": false,
|
|
1696
|
+
"type": "option"
|
|
1697
|
+
},
|
|
1698
|
+
"client-id": {
|
|
1699
|
+
"name": "client-id",
|
|
1700
|
+
"summary": "OAuth client ID. Required when auth-type is OAUTH.",
|
|
1701
|
+
"hasDynamicHelp": false,
|
|
1702
|
+
"multiple": false,
|
|
1703
|
+
"type": "option"
|
|
1704
|
+
},
|
|
1705
|
+
"client-secret": {
|
|
1706
|
+
"name": "client-secret",
|
|
1707
|
+
"summary": "OAuth client secret. Required when auth-type is OAUTH. Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
1708
|
+
"hasDynamicHelp": false,
|
|
1709
|
+
"multiple": false,
|
|
1710
|
+
"type": "option"
|
|
1711
|
+
},
|
|
1712
|
+
"scope": {
|
|
1713
|
+
"name": "scope",
|
|
1714
|
+
"summary": "OAuth scope to request. Required when auth-type is OAUTH.",
|
|
1715
|
+
"hasDynamicHelp": false,
|
|
1716
|
+
"multiple": false,
|
|
1717
|
+
"type": "option"
|
|
1698
1718
|
}
|
|
1699
1719
|
},
|
|
1700
1720
|
"hasDynamicHelp": true,
|
|
1701
1721
|
"hiddenAliases": [],
|
|
1702
|
-
"id": "agent:
|
|
1722
|
+
"id": "agent:mcp:create",
|
|
1703
1723
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1704
1724
|
"pluginName": "@salesforce/plugin-agent",
|
|
1705
1725
|
"pluginType": "core",
|
|
1726
|
+
"state": "preview",
|
|
1706
1727
|
"strict": true,
|
|
1707
|
-
"summary": "
|
|
1728
|
+
"summary": "Create an MCP server in the API Catalog.",
|
|
1708
1729
|
"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
|
-
},
|
|
1748
1730
|
"isESM": true,
|
|
1749
1731
|
"relativePath": [
|
|
1750
1732
|
"lib",
|
|
1751
1733
|
"commands",
|
|
1752
1734
|
"agent",
|
|
1753
|
-
"
|
|
1754
|
-
"
|
|
1735
|
+
"mcp",
|
|
1736
|
+
"create.js"
|
|
1755
1737
|
],
|
|
1756
1738
|
"aliasPermutations": [],
|
|
1757
1739
|
"permutations": [
|
|
1758
|
-
"agent:
|
|
1759
|
-
"
|
|
1760
|
-
"
|
|
1761
|
-
"agent:
|
|
1762
|
-
"
|
|
1763
|
-
"
|
|
1740
|
+
"agent:mcp:create",
|
|
1741
|
+
"mcp:agent:create",
|
|
1742
|
+
"mcp:create:agent",
|
|
1743
|
+
"agent:create:mcp",
|
|
1744
|
+
"create:agent:mcp",
|
|
1745
|
+
"create:mcp:agent"
|
|
1764
1746
|
]
|
|
1765
1747
|
},
|
|
1766
|
-
"agent:
|
|
1748
|
+
"agent:mcp:delete": {
|
|
1767
1749
|
"aliases": [],
|
|
1768
1750
|
"args": {},
|
|
1769
|
-
"description": "
|
|
1751
|
+
"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).",
|
|
1770
1752
|
"examples": [
|
|
1771
|
-
"
|
|
1772
|
-
"
|
|
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"
|
|
1753
|
+
"Delete an MCP server, confirming interactively:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg",
|
|
1754
|
+
"Delete an MCP server without a confirmation prompt:\n<%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt"
|
|
1774
1755
|
],
|
|
1775
1756
|
"flags": {
|
|
1776
1757
|
"json": {
|
|
@@ -1805,34 +1786,96 @@
|
|
|
1805
1786
|
"multiple": false,
|
|
1806
1787
|
"type": "option"
|
|
1807
1788
|
},
|
|
1808
|
-
"
|
|
1809
|
-
"
|
|
1810
|
-
"
|
|
1811
|
-
"
|
|
1789
|
+
"mcp-server-id": {
|
|
1790
|
+
"char": "i",
|
|
1791
|
+
"name": "mcp-server-id",
|
|
1792
|
+
"required": true,
|
|
1793
|
+
"summary": "ID of the MCP server to delete.",
|
|
1812
1794
|
"hasDynamicHelp": false,
|
|
1813
1795
|
"multiple": false,
|
|
1814
1796
|
"type": "option"
|
|
1815
1797
|
},
|
|
1816
|
-
"
|
|
1817
|
-
"
|
|
1818
|
-
"
|
|
1819
|
-
"
|
|
1820
|
-
"
|
|
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.",
|
|
1821
1853
|
"hasDynamicHelp": false,
|
|
1822
1854
|
"multiple": false,
|
|
1823
1855
|
"type": "option"
|
|
1824
1856
|
},
|
|
1825
|
-
"
|
|
1826
|
-
"char": "
|
|
1827
|
-
"name": "
|
|
1828
|
-
"
|
|
1857
|
+
"target-org": {
|
|
1858
|
+
"char": "o",
|
|
1859
|
+
"name": "target-org",
|
|
1860
|
+
"noCacheDefault": true,
|
|
1861
|
+
"required": true,
|
|
1862
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1863
|
+
"hasDynamicHelp": true,
|
|
1864
|
+
"multiple": false,
|
|
1865
|
+
"type": "option"
|
|
1866
|
+
},
|
|
1867
|
+
"api-version": {
|
|
1868
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1869
|
+
"name": "api-version",
|
|
1829
1870
|
"hasDynamicHelp": false,
|
|
1830
1871
|
"multiple": false,
|
|
1831
1872
|
"type": "option"
|
|
1832
1873
|
},
|
|
1833
|
-
"
|
|
1834
|
-
"
|
|
1835
|
-
"
|
|
1874
|
+
"mcp-server-id": {
|
|
1875
|
+
"char": "i",
|
|
1876
|
+
"name": "mcp-server-id",
|
|
1877
|
+
"required": true,
|
|
1878
|
+
"summary": "ID of the MCP server to fetch assets from.",
|
|
1836
1879
|
"hasDynamicHelp": false,
|
|
1837
1880
|
"multiple": false,
|
|
1838
1881
|
"type": "option"
|
|
@@ -1840,68 +1883,39 @@
|
|
|
1840
1883
|
},
|
|
1841
1884
|
"hasDynamicHelp": true,
|
|
1842
1885
|
"hiddenAliases": [],
|
|
1843
|
-
"id": "agent:
|
|
1886
|
+
"id": "agent:mcp:fetch",
|
|
1844
1887
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1845
1888
|
"pluginName": "@salesforce/plugin-agent",
|
|
1846
1889
|
"pluginType": "core",
|
|
1890
|
+
"state": "preview",
|
|
1847
1891
|
"strict": true,
|
|
1848
|
-
"summary": "
|
|
1892
|
+
"summary": "Fetch the live assets (tools, prompts, resources) advertised by an MCP server.",
|
|
1849
1893
|
"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
|
-
},
|
|
1881
1894
|
"isESM": true,
|
|
1882
1895
|
"relativePath": [
|
|
1883
1896
|
"lib",
|
|
1884
1897
|
"commands",
|
|
1885
1898
|
"agent",
|
|
1886
|
-
"
|
|
1887
|
-
"
|
|
1899
|
+
"mcp",
|
|
1900
|
+
"fetch.js"
|
|
1888
1901
|
],
|
|
1889
1902
|
"aliasPermutations": [],
|
|
1890
1903
|
"permutations": [
|
|
1891
|
-
"agent:
|
|
1892
|
-
"
|
|
1893
|
-
"
|
|
1894
|
-
"agent:
|
|
1895
|
-
"
|
|
1896
|
-
"
|
|
1904
|
+
"agent:mcp:fetch",
|
|
1905
|
+
"mcp:agent:fetch",
|
|
1906
|
+
"mcp:fetch:agent",
|
|
1907
|
+
"agent:fetch:mcp",
|
|
1908
|
+
"fetch:agent:mcp",
|
|
1909
|
+
"fetch:mcp:agent"
|
|
1897
1910
|
]
|
|
1898
1911
|
},
|
|
1899
|
-
"agent:
|
|
1912
|
+
"agent:mcp:get": {
|
|
1900
1913
|
"aliases": [],
|
|
1901
1914
|
"args": {},
|
|
1902
|
-
"description": "
|
|
1915
|
+
"description": "Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.",
|
|
1903
1916
|
"examples": [
|
|
1904
|
-
"
|
|
1917
|
+
"Get an MCP server by id in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001",
|
|
1918
|
+
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
1905
1919
|
],
|
|
1906
1920
|
"flags": {
|
|
1907
1921
|
"json": {
|
|
@@ -1918,53 +1932,69 @@
|
|
|
1918
1932
|
"hasDynamicHelp": false,
|
|
1919
1933
|
"multiple": false,
|
|
1920
1934
|
"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"
|
|
1921
1961
|
}
|
|
1922
1962
|
},
|
|
1923
|
-
"hasDynamicHelp":
|
|
1963
|
+
"hasDynamicHelp": true,
|
|
1924
1964
|
"hiddenAliases": [],
|
|
1925
|
-
"id": "agent:
|
|
1965
|
+
"id": "agent:mcp:get",
|
|
1926
1966
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
1927
1967
|
"pluginName": "@salesforce/plugin-agent",
|
|
1928
1968
|
"pluginType": "core",
|
|
1969
|
+
"state": "preview",
|
|
1929
1970
|
"strict": true,
|
|
1930
|
-
"summary": "
|
|
1971
|
+
"summary": "Get a single MCP server registered in the API Catalog.",
|
|
1931
1972
|
"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
|
-
},
|
|
1942
1973
|
"isESM": true,
|
|
1943
1974
|
"relativePath": [
|
|
1944
1975
|
"lib",
|
|
1945
1976
|
"commands",
|
|
1946
1977
|
"agent",
|
|
1947
|
-
"
|
|
1948
|
-
"
|
|
1978
|
+
"mcp",
|
|
1979
|
+
"get.js"
|
|
1949
1980
|
],
|
|
1950
1981
|
"aliasPermutations": [],
|
|
1951
1982
|
"permutations": [
|
|
1952
|
-
"agent:
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
1955
|
-
"agent:
|
|
1956
|
-
"
|
|
1957
|
-
"
|
|
1983
|
+
"agent:mcp:get",
|
|
1984
|
+
"mcp:agent:get",
|
|
1985
|
+
"mcp:get:agent",
|
|
1986
|
+
"agent:get:mcp",
|
|
1987
|
+
"get:agent:mcp",
|
|
1988
|
+
"get:mcp:agent"
|
|
1958
1989
|
]
|
|
1959
1990
|
},
|
|
1960
|
-
"agent:
|
|
1991
|
+
"agent:mcp:list": {
|
|
1961
1992
|
"aliases": [],
|
|
1962
1993
|
"args": {},
|
|
1963
|
-
"description": "
|
|
1994
|
+
"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.",
|
|
1964
1995
|
"examples": [
|
|
1965
|
-
"
|
|
1966
|
-
"
|
|
1967
|
-
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
1996
|
+
"List all MCP servers in the default target org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
|
|
1997
|
+
"List external MCP servers filtered by status and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json"
|
|
1968
1998
|
],
|
|
1969
1999
|
"flags": {
|
|
1970
2000
|
"json": {
|
|
@@ -1999,129 +2029,70 @@
|
|
|
1999
2029
|
"multiple": false,
|
|
2000
2030
|
"type": "option"
|
|
2001
2031
|
},
|
|
2002
|
-
"
|
|
2003
|
-
"
|
|
2004
|
-
"
|
|
2005
|
-
"summary": "API name of the activated published agent you want to preview.",
|
|
2032
|
+
"label": {
|
|
2033
|
+
"name": "label",
|
|
2034
|
+
"summary": "Filter the MCP servers by label.",
|
|
2006
2035
|
"hasDynamicHelp": false,
|
|
2007
2036
|
"multiple": false,
|
|
2008
2037
|
"type": "option"
|
|
2009
2038
|
},
|
|
2010
|
-
"
|
|
2011
|
-
"name": "
|
|
2012
|
-
"summary": "
|
|
2039
|
+
"type": {
|
|
2040
|
+
"name": "type",
|
|
2041
|
+
"summary": "Filter the MCP servers by type.",
|
|
2013
2042
|
"hasDynamicHelp": false,
|
|
2014
2043
|
"multiple": false,
|
|
2015
|
-
"
|
|
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"
|
|
2044
|
+
"options": [
|
|
2045
|
+
"EXTERNAL"
|
|
2029
2046
|
],
|
|
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,
|
|
2042
2047
|
"type": "option"
|
|
2043
2048
|
},
|
|
2044
|
-
"
|
|
2045
|
-
"
|
|
2046
|
-
|
|
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.",
|
|
2049
|
+
"status": {
|
|
2050
|
+
"name": "status",
|
|
2051
|
+
"summary": "Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.",
|
|
2051
2052
|
"hasDynamicHelp": false,
|
|
2052
2053
|
"multiple": false,
|
|
2054
|
+
"options": [
|
|
2055
|
+
"ACTIVE",
|
|
2056
|
+
"DISCONNECTED"
|
|
2057
|
+
],
|
|
2053
2058
|
"type": "option"
|
|
2054
2059
|
}
|
|
2055
2060
|
},
|
|
2056
2061
|
"hasDynamicHelp": true,
|
|
2057
2062
|
"hiddenAliases": [],
|
|
2058
|
-
"id": "agent:
|
|
2063
|
+
"id": "agent:mcp:list",
|
|
2059
2064
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2060
2065
|
"pluginName": "@salesforce/plugin-agent",
|
|
2061
2066
|
"pluginType": "core",
|
|
2067
|
+
"state": "preview",
|
|
2062
2068
|
"strict": true,
|
|
2063
|
-
"summary": "
|
|
2069
|
+
"summary": "List the MCP servers registered in the API Catalog.",
|
|
2064
2070
|
"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
|
-
},
|
|
2100
2071
|
"isESM": true,
|
|
2101
2072
|
"relativePath": [
|
|
2102
2073
|
"lib",
|
|
2103
2074
|
"commands",
|
|
2104
2075
|
"agent",
|
|
2105
|
-
"
|
|
2106
|
-
"
|
|
2076
|
+
"mcp",
|
|
2077
|
+
"list.js"
|
|
2107
2078
|
],
|
|
2108
2079
|
"aliasPermutations": [],
|
|
2109
2080
|
"permutations": [
|
|
2110
|
-
"agent:
|
|
2111
|
-
"
|
|
2112
|
-
"
|
|
2113
|
-
"agent:
|
|
2114
|
-
"
|
|
2115
|
-
"
|
|
2081
|
+
"agent:mcp:list",
|
|
2082
|
+
"mcp:agent:list",
|
|
2083
|
+
"mcp:list:agent",
|
|
2084
|
+
"agent:list:mcp",
|
|
2085
|
+
"list:agent:mcp",
|
|
2086
|
+
"list:mcp:agent"
|
|
2116
2087
|
]
|
|
2117
2088
|
},
|
|
2118
|
-
"agent:mcp:
|
|
2089
|
+
"agent:mcp:update": {
|
|
2119
2090
|
"aliases": [],
|
|
2120
2091
|
"args": {},
|
|
2121
|
-
"description": "
|
|
2092
|
+
"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.",
|
|
2122
2093
|
"examples": [
|
|
2123
|
-
"
|
|
2124
|
-
"
|
|
2094
|
+
"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",
|
|
2095
|
+
"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"
|
|
2125
2096
|
],
|
|
2126
2097
|
"flags": {
|
|
2127
2098
|
"json": {
|
|
@@ -2156,41 +2127,39 @@
|
|
|
2156
2127
|
"multiple": false,
|
|
2157
2128
|
"type": "option"
|
|
2158
2129
|
},
|
|
2159
|
-
"
|
|
2160
|
-
"char": "
|
|
2161
|
-
"name": "
|
|
2130
|
+
"mcp-server-id": {
|
|
2131
|
+
"char": "i",
|
|
2132
|
+
"name": "mcp-server-id",
|
|
2162
2133
|
"required": true,
|
|
2163
|
-
"summary": "
|
|
2134
|
+
"summary": "ID of the MCP server to update.",
|
|
2164
2135
|
"hasDynamicHelp": false,
|
|
2165
2136
|
"multiple": false,
|
|
2166
2137
|
"type": "option"
|
|
2167
2138
|
},
|
|
2168
2139
|
"label": {
|
|
2169
2140
|
"name": "label",
|
|
2170
|
-
"summary": "
|
|
2141
|
+
"summary": "New display label for the MCP server.",
|
|
2171
2142
|
"hasDynamicHelp": false,
|
|
2172
2143
|
"multiple": false,
|
|
2173
2144
|
"type": "option"
|
|
2174
2145
|
},
|
|
2175
2146
|
"description": {
|
|
2176
2147
|
"name": "description",
|
|
2177
|
-
"summary": "
|
|
2148
|
+
"summary": "New description for the MCP server.",
|
|
2178
2149
|
"hasDynamicHelp": false,
|
|
2179
2150
|
"multiple": false,
|
|
2180
2151
|
"type": "option"
|
|
2181
2152
|
},
|
|
2182
2153
|
"server-url": {
|
|
2183
2154
|
"name": "server-url",
|
|
2184
|
-
"
|
|
2185
|
-
"summary": "URL of the external MCP server.",
|
|
2155
|
+
"summary": "New endpoint URL of the MCP server.",
|
|
2186
2156
|
"hasDynamicHelp": false,
|
|
2187
2157
|
"multiple": false,
|
|
2188
2158
|
"type": "option"
|
|
2189
2159
|
},
|
|
2190
2160
|
"auth-type": {
|
|
2191
2161
|
"name": "auth-type",
|
|
2192
|
-
"summary": "Authorization type to
|
|
2193
|
-
"default": "NO_AUTH",
|
|
2162
|
+
"summary": "Authorization type to apply to the MCP server (OAUTH or NO_AUTH).",
|
|
2194
2163
|
"hasDynamicHelp": false,
|
|
2195
2164
|
"multiple": false,
|
|
2196
2165
|
"options": [
|
|
@@ -2201,28 +2170,28 @@
|
|
|
2201
2170
|
},
|
|
2202
2171
|
"identity-provider": {
|
|
2203
2172
|
"name": "identity-provider",
|
|
2204
|
-
"summary": "Identity provider
|
|
2173
|
+
"summary": "Identity provider name for OAuth authorization (required when --auth-type is OAUTH).",
|
|
2205
2174
|
"hasDynamicHelp": false,
|
|
2206
2175
|
"multiple": false,
|
|
2207
2176
|
"type": "option"
|
|
2208
2177
|
},
|
|
2209
2178
|
"client-id": {
|
|
2210
2179
|
"name": "client-id",
|
|
2211
|
-
"summary": "OAuth client ID
|
|
2180
|
+
"summary": "OAuth client ID (required when --auth-type is OAUTH).",
|
|
2212
2181
|
"hasDynamicHelp": false,
|
|
2213
2182
|
"multiple": false,
|
|
2214
2183
|
"type": "option"
|
|
2215
2184
|
},
|
|
2216
2185
|
"client-secret": {
|
|
2217
2186
|
"name": "client-secret",
|
|
2218
|
-
"summary": "OAuth client secret
|
|
2187
|
+
"summary": "OAuth client secret (required when --auth-type is OAUTH). Pass \"-\" to read it from stdin (piped) and keep it out of shell history.",
|
|
2219
2188
|
"hasDynamicHelp": false,
|
|
2220
2189
|
"multiple": false,
|
|
2221
2190
|
"type": "option"
|
|
2222
2191
|
},
|
|
2223
2192
|
"scope": {
|
|
2224
2193
|
"name": "scope",
|
|
2225
|
-
"summary": "OAuth scope
|
|
2194
|
+
"summary": "OAuth scope (required when --auth-type is OAUTH).",
|
|
2226
2195
|
"hasDynamicHelp": false,
|
|
2227
2196
|
"multiple": false,
|
|
2228
2197
|
"type": "option"
|
|
@@ -2230,13 +2199,13 @@
|
|
|
2230
2199
|
},
|
|
2231
2200
|
"hasDynamicHelp": true,
|
|
2232
2201
|
"hiddenAliases": [],
|
|
2233
|
-
"id": "agent:mcp:
|
|
2202
|
+
"id": "agent:mcp:update",
|
|
2234
2203
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2235
2204
|
"pluginName": "@salesforce/plugin-agent",
|
|
2236
2205
|
"pluginType": "core",
|
|
2237
2206
|
"state": "preview",
|
|
2238
2207
|
"strict": true,
|
|
2239
|
-
"summary": "
|
|
2208
|
+
"summary": "Update an MCP server registered in the API Catalog.",
|
|
2240
2209
|
"enableJsonFlag": true,
|
|
2241
2210
|
"isESM": true,
|
|
2242
2211
|
"relativePath": [
|
|
@@ -2244,25 +2213,28 @@
|
|
|
2244
2213
|
"commands",
|
|
2245
2214
|
"agent",
|
|
2246
2215
|
"mcp",
|
|
2247
|
-
"
|
|
2216
|
+
"update.js"
|
|
2248
2217
|
],
|
|
2249
2218
|
"aliasPermutations": [],
|
|
2250
2219
|
"permutations": [
|
|
2251
|
-
"agent:mcp:
|
|
2252
|
-
"mcp:agent:
|
|
2253
|
-
"mcp:
|
|
2254
|
-
"agent:
|
|
2255
|
-
"
|
|
2256
|
-
"
|
|
2220
|
+
"agent:mcp:update",
|
|
2221
|
+
"mcp:agent:update",
|
|
2222
|
+
"mcp:update:agent",
|
|
2223
|
+
"agent:update:mcp",
|
|
2224
|
+
"update:agent:mcp",
|
|
2225
|
+
"update:mcp:agent"
|
|
2257
2226
|
]
|
|
2258
2227
|
},
|
|
2259
|
-
"agent:
|
|
2228
|
+
"agent:preview:end": {
|
|
2260
2229
|
"aliases": [],
|
|
2261
2230
|
"args": {},
|
|
2262
|
-
"description": "
|
|
2231
|
+
"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.",
|
|
2263
2232
|
"examples": [
|
|
2264
|
-
"
|
|
2265
|
-
"
|
|
2233
|
+
"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",
|
|
2234
|
+
"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",
|
|
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>"
|
|
2266
2238
|
],
|
|
2267
2239
|
"flags": {
|
|
2268
2240
|
"json": {
|
|
@@ -2297,57 +2269,129 @@
|
|
|
2297
2269
|
"multiple": false,
|
|
2298
2270
|
"type": "option"
|
|
2299
2271
|
},
|
|
2300
|
-
"
|
|
2301
|
-
"
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
"
|
|
2272
|
+
"session-id": {
|
|
2273
|
+
"exclusive": [
|
|
2274
|
+
"all"
|
|
2275
|
+
],
|
|
2276
|
+
"name": "session-id",
|
|
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.",
|
|
2305
2300
|
"hasDynamicHelp": false,
|
|
2306
2301
|
"multiple": false,
|
|
2307
2302
|
"type": "option"
|
|
2308
2303
|
},
|
|
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
|
+
},
|
|
2309
2313
|
"no-prompt": {
|
|
2314
|
+
"char": "p",
|
|
2310
2315
|
"name": "no-prompt",
|
|
2311
|
-
"summary": "
|
|
2316
|
+
"summary": "Don't prompt for confirmation before ending sessions. Has an effect only when used with --all.",
|
|
2312
2317
|
"allowNo": false,
|
|
2313
2318
|
"type": "boolean"
|
|
2314
2319
|
}
|
|
2315
2320
|
},
|
|
2316
2321
|
"hasDynamicHelp": true,
|
|
2317
2322
|
"hiddenAliases": [],
|
|
2318
|
-
"id": "agent:
|
|
2323
|
+
"id": "agent:preview:end",
|
|
2319
2324
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2320
2325
|
"pluginName": "@salesforce/plugin-agent",
|
|
2321
2326
|
"pluginType": "core",
|
|
2322
|
-
"state": "preview",
|
|
2323
2327
|
"strict": true,
|
|
2324
|
-
"summary": "
|
|
2328
|
+
"summary": "End an existing programmatic agent preview session and get trace location.",
|
|
2325
2329
|
"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
|
+
},
|
|
2326
2369
|
"isESM": true,
|
|
2327
2370
|
"relativePath": [
|
|
2328
2371
|
"lib",
|
|
2329
2372
|
"commands",
|
|
2330
2373
|
"agent",
|
|
2331
|
-
"
|
|
2332
|
-
"
|
|
2374
|
+
"preview",
|
|
2375
|
+
"end.js"
|
|
2333
2376
|
],
|
|
2334
2377
|
"aliasPermutations": [],
|
|
2335
2378
|
"permutations": [
|
|
2336
|
-
"agent:
|
|
2337
|
-
"
|
|
2338
|
-
"
|
|
2339
|
-
"agent:
|
|
2340
|
-
"
|
|
2341
|
-
"
|
|
2379
|
+
"agent:preview:end",
|
|
2380
|
+
"preview:agent:end",
|
|
2381
|
+
"preview:end:agent",
|
|
2382
|
+
"agent:end:preview",
|
|
2383
|
+
"end:agent:preview",
|
|
2384
|
+
"end:preview:agent"
|
|
2342
2385
|
]
|
|
2343
2386
|
},
|
|
2344
|
-
"agent:
|
|
2387
|
+
"agent:preview:send": {
|
|
2345
2388
|
"aliases": [],
|
|
2346
2389
|
"args": {},
|
|
2347
|
-
"description": "
|
|
2390
|
+
"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.",
|
|
2348
2391
|
"examples": [
|
|
2349
|
-
"
|
|
2350
|
-
"
|
|
2392
|
+
"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>",
|
|
2393
|
+
"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",
|
|
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"
|
|
2351
2395
|
],
|
|
2352
2396
|
"flags": {
|
|
2353
2397
|
"json": {
|
|
@@ -2382,11 +2426,34 @@
|
|
|
2382
2426
|
"multiple": false,
|
|
2383
2427
|
"type": "option"
|
|
2384
2428
|
},
|
|
2385
|
-
"
|
|
2386
|
-
"
|
|
2387
|
-
"
|
|
2388
|
-
"
|
|
2389
|
-
"
|
|
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.",
|
|
2450
|
+
"hasDynamicHelp": false,
|
|
2451
|
+
"multiple": false,
|
|
2452
|
+
"type": "option"
|
|
2453
|
+
},
|
|
2454
|
+
"authoring-bundle": {
|
|
2455
|
+
"name": "authoring-bundle",
|
|
2456
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2390
2457
|
"hasDynamicHelp": false,
|
|
2391
2458
|
"multiple": false,
|
|
2392
2459
|
"type": "option"
|
|
@@ -2394,39 +2461,68 @@
|
|
|
2394
2461
|
},
|
|
2395
2462
|
"hasDynamicHelp": true,
|
|
2396
2463
|
"hiddenAliases": [],
|
|
2397
|
-
"id": "agent:
|
|
2464
|
+
"id": "agent:preview:send",
|
|
2398
2465
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2399
2466
|
"pluginName": "@salesforce/plugin-agent",
|
|
2400
2467
|
"pluginType": "core",
|
|
2401
|
-
"state": "preview",
|
|
2402
2468
|
"strict": true,
|
|
2403
|
-
"summary": "
|
|
2469
|
+
"summary": "Send a message to an existing agent preview session.",
|
|
2404
2470
|
"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
|
+
},
|
|
2405
2502
|
"isESM": true,
|
|
2406
2503
|
"relativePath": [
|
|
2407
2504
|
"lib",
|
|
2408
2505
|
"commands",
|
|
2409
2506
|
"agent",
|
|
2410
|
-
"
|
|
2411
|
-
"
|
|
2507
|
+
"preview",
|
|
2508
|
+
"send.js"
|
|
2412
2509
|
],
|
|
2413
2510
|
"aliasPermutations": [],
|
|
2414
2511
|
"permutations": [
|
|
2415
|
-
"agent:
|
|
2416
|
-
"
|
|
2417
|
-
"
|
|
2418
|
-
"agent:
|
|
2419
|
-
"
|
|
2420
|
-
"
|
|
2512
|
+
"agent:preview:send",
|
|
2513
|
+
"preview:agent:send",
|
|
2514
|
+
"preview:send:agent",
|
|
2515
|
+
"agent:send:preview",
|
|
2516
|
+
"send:agent:preview",
|
|
2517
|
+
"send:preview:agent"
|
|
2421
2518
|
]
|
|
2422
2519
|
},
|
|
2423
|
-
"agent:
|
|
2520
|
+
"agent:preview:sessions": {
|
|
2424
2521
|
"aliases": [],
|
|
2425
2522
|
"args": {},
|
|
2426
|
-
"description": "
|
|
2523
|
+
"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.",
|
|
2427
2524
|
"examples": [
|
|
2428
|
-
"
|
|
2429
|
-
"Get an MCP server and output as JSON:\n<%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json"
|
|
2525
|
+
"List all cached agent preview sessions:\n<%= config.bin %> <%= command.id %>"
|
|
2430
2526
|
],
|
|
2431
2527
|
"flags": {
|
|
2432
2528
|
"json": {
|
|
@@ -2443,69 +2539,53 @@
|
|
|
2443
2539
|
"hasDynamicHelp": false,
|
|
2444
2540
|
"multiple": false,
|
|
2445
2541
|
"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"
|
|
2472
2542
|
}
|
|
2473
2543
|
},
|
|
2474
|
-
"hasDynamicHelp":
|
|
2544
|
+
"hasDynamicHelp": false,
|
|
2475
2545
|
"hiddenAliases": [],
|
|
2476
|
-
"id": "agent:
|
|
2546
|
+
"id": "agent:preview:sessions",
|
|
2477
2547
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2478
2548
|
"pluginName": "@salesforce/plugin-agent",
|
|
2479
2549
|
"pluginType": "core",
|
|
2480
|
-
"state": "preview",
|
|
2481
2550
|
"strict": true,
|
|
2482
|
-
"summary": "
|
|
2551
|
+
"summary": "List all known programmatic agent preview sessions.",
|
|
2483
2552
|
"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
|
+
},
|
|
2484
2563
|
"isESM": true,
|
|
2485
2564
|
"relativePath": [
|
|
2486
2565
|
"lib",
|
|
2487
2566
|
"commands",
|
|
2488
2567
|
"agent",
|
|
2489
|
-
"
|
|
2490
|
-
"
|
|
2568
|
+
"preview",
|
|
2569
|
+
"sessions.js"
|
|
2491
2570
|
],
|
|
2492
2571
|
"aliasPermutations": [],
|
|
2493
2572
|
"permutations": [
|
|
2494
|
-
"agent:
|
|
2495
|
-
"
|
|
2496
|
-
"
|
|
2497
|
-
"agent:
|
|
2498
|
-
"
|
|
2499
|
-
"
|
|
2573
|
+
"agent:preview:sessions",
|
|
2574
|
+
"preview:agent:sessions",
|
|
2575
|
+
"preview:sessions:agent",
|
|
2576
|
+
"agent:sessions:preview",
|
|
2577
|
+
"sessions:agent:preview",
|
|
2578
|
+
"sessions:preview:agent"
|
|
2500
2579
|
]
|
|
2501
2580
|
},
|
|
2502
|
-
"agent:
|
|
2581
|
+
"agent:preview:start": {
|
|
2503
2582
|
"aliases": [],
|
|
2504
2583
|
"args": {},
|
|
2505
|
-
"description": "
|
|
2584
|
+
"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.",
|
|
2506
2585
|
"examples": [
|
|
2507
|
-
"
|
|
2508
|
-
"
|
|
2586
|
+
"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",
|
|
2587
|
+
"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",
|
|
2588
|
+
"Start a preview session with an activated published agent (always uses live actions):\n<%= config.bin %> <%= command.id %> --api-name My_Published_Agent"
|
|
2509
2589
|
],
|
|
2510
2590
|
"flags": {
|
|
2511
2591
|
"json": {
|
|
@@ -2540,70 +2620,131 @@
|
|
|
2540
2620
|
"multiple": false,
|
|
2541
2621
|
"type": "option"
|
|
2542
2622
|
},
|
|
2543
|
-
"
|
|
2544
|
-
"
|
|
2545
|
-
"
|
|
2623
|
+
"api-name": {
|
|
2624
|
+
"char": "n",
|
|
2625
|
+
"name": "api-name",
|
|
2626
|
+
"summary": "API name of the activated published agent you want to preview.",
|
|
2546
2627
|
"hasDynamicHelp": false,
|
|
2547
2628
|
"multiple": false,
|
|
2548
2629
|
"type": "option"
|
|
2549
2630
|
},
|
|
2550
|
-
"
|
|
2551
|
-
"name": "
|
|
2552
|
-
"summary": "
|
|
2631
|
+
"authoring-bundle": {
|
|
2632
|
+
"name": "authoring-bundle",
|
|
2633
|
+
"summary": "API name of the authoring bundle metadata component that contains the agent's Agent Script file.",
|
|
2553
2634
|
"hasDynamicHelp": false,
|
|
2554
2635
|
"multiple": false,
|
|
2555
|
-
"
|
|
2556
|
-
|
|
2636
|
+
"type": "option"
|
|
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"
|
|
2557
2650
|
],
|
|
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,
|
|
2558
2663
|
"type": "option"
|
|
2559
2664
|
},
|
|
2560
|
-
"
|
|
2561
|
-
"
|
|
2562
|
-
|
|
2665
|
+
"agent-json": {
|
|
2666
|
+
"dependsOn": [
|
|
2667
|
+
"authoring-bundle"
|
|
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.",
|
|
2563
2672
|
"hasDynamicHelp": false,
|
|
2564
2673
|
"multiple": false,
|
|
2565
|
-
"options": [
|
|
2566
|
-
"ACTIVE",
|
|
2567
|
-
"DISCONNECTED"
|
|
2568
|
-
],
|
|
2569
2674
|
"type": "option"
|
|
2570
2675
|
}
|
|
2571
2676
|
},
|
|
2572
2677
|
"hasDynamicHelp": true,
|
|
2573
2678
|
"hiddenAliases": [],
|
|
2574
|
-
"id": "agent:
|
|
2679
|
+
"id": "agent:preview:start",
|
|
2575
2680
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2576
2681
|
"pluginName": "@salesforce/plugin-agent",
|
|
2577
2682
|
"pluginType": "core",
|
|
2578
|
-
"state": "preview",
|
|
2579
2683
|
"strict": true,
|
|
2580
|
-
"summary": "
|
|
2684
|
+
"summary": "Start a programmatic agent preview session.",
|
|
2581
2685
|
"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
|
+
},
|
|
2582
2721
|
"isESM": true,
|
|
2583
2722
|
"relativePath": [
|
|
2584
2723
|
"lib",
|
|
2585
2724
|
"commands",
|
|
2586
2725
|
"agent",
|
|
2587
|
-
"
|
|
2588
|
-
"
|
|
2726
|
+
"preview",
|
|
2727
|
+
"start.js"
|
|
2589
2728
|
],
|
|
2590
2729
|
"aliasPermutations": [],
|
|
2591
2730
|
"permutations": [
|
|
2592
|
-
"agent:
|
|
2593
|
-
"
|
|
2594
|
-
"
|
|
2595
|
-
"agent:
|
|
2596
|
-
"
|
|
2597
|
-
"
|
|
2731
|
+
"agent:preview:start",
|
|
2732
|
+
"preview:agent:start",
|
|
2733
|
+
"preview:start:agent",
|
|
2734
|
+
"agent:start:preview",
|
|
2735
|
+
"start:agent:preview",
|
|
2736
|
+
"start:preview:agent"
|
|
2598
2737
|
]
|
|
2599
2738
|
},
|
|
2600
|
-
"agent:
|
|
2739
|
+
"agent:publish:authoring-bundle": {
|
|
2601
2740
|
"aliases": [],
|
|
2602
2741
|
"args": {},
|
|
2603
|
-
"description": "
|
|
2604
|
-
"examples": [
|
|
2605
|
-
"
|
|
2606
|
-
"
|
|
2742
|
+
"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.",
|
|
2743
|
+
"examples": [
|
|
2744
|
+
"Publish an authoring bundle by being prompted for its API name; use your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2745
|
+
"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",
|
|
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"
|
|
2607
2748
|
],
|
|
2608
2749
|
"flags": {
|
|
2609
2750
|
"json": {
|
|
@@ -2638,102 +2779,85 @@
|
|
|
2638
2779
|
"multiple": false,
|
|
2639
2780
|
"type": "option"
|
|
2640
2781
|
},
|
|
2641
|
-
"
|
|
2642
|
-
"char": "
|
|
2643
|
-
"name": "
|
|
2644
|
-
"
|
|
2645
|
-
"summary": "ID of the MCP server to update.",
|
|
2646
|
-
"hasDynamicHelp": false,
|
|
2647
|
-
"multiple": false,
|
|
2648
|
-
"type": "option"
|
|
2649
|
-
},
|
|
2650
|
-
"label": {
|
|
2651
|
-
"name": "label",
|
|
2652
|
-
"summary": "New display label for the MCP server.",
|
|
2653
|
-
"hasDynamicHelp": false,
|
|
2654
|
-
"multiple": false,
|
|
2655
|
-
"type": "option"
|
|
2656
|
-
},
|
|
2657
|
-
"description": {
|
|
2658
|
-
"name": "description",
|
|
2659
|
-
"summary": "New description for the MCP server.",
|
|
2782
|
+
"api-name": {
|
|
2783
|
+
"char": "n",
|
|
2784
|
+
"name": "api-name",
|
|
2785
|
+
"summary": "API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from.",
|
|
2660
2786
|
"hasDynamicHelp": false,
|
|
2661
2787
|
"multiple": false,
|
|
2662
2788
|
"type": "option"
|
|
2663
2789
|
},
|
|
2664
|
-
"
|
|
2665
|
-
"name": "
|
|
2666
|
-
"summary": "
|
|
2667
|
-
"
|
|
2668
|
-
"
|
|
2669
|
-
"type": "option"
|
|
2790
|
+
"skip-retrieve": {
|
|
2791
|
+
"name": "skip-retrieve",
|
|
2792
|
+
"summary": "Don't retrieve the metadata associated with the agent to your DX project.",
|
|
2793
|
+
"allowNo": false,
|
|
2794
|
+
"type": "boolean"
|
|
2670
2795
|
},
|
|
2671
|
-
"
|
|
2672
|
-
"
|
|
2673
|
-
"
|
|
2674
|
-
|
|
2675
|
-
"multiple": false,
|
|
2676
|
-
"options": [
|
|
2677
|
-
"OAUTH",
|
|
2678
|
-
"NO_AUTH"
|
|
2796
|
+
"verbose": {
|
|
2797
|
+
"char": "v",
|
|
2798
|
+
"exclusive": [
|
|
2799
|
+
"concise"
|
|
2679
2800
|
],
|
|
2680
|
-
"
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
"
|
|
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"
|
|
2801
|
+
"name": "verbose",
|
|
2802
|
+
"summary": "Display detailed output showing all metadata components retrieved and deployed during the publish process.",
|
|
2803
|
+
"allowNo": false,
|
|
2804
|
+
"type": "boolean"
|
|
2702
2805
|
},
|
|
2703
|
-
"
|
|
2704
|
-
"
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
"
|
|
2708
|
-
"
|
|
2806
|
+
"concise": {
|
|
2807
|
+
"exclusive": [
|
|
2808
|
+
"verbose"
|
|
2809
|
+
],
|
|
2810
|
+
"name": "concise",
|
|
2811
|
+
"summary": "Display minimal output with only essential information about the publish operation.",
|
|
2812
|
+
"allowNo": false,
|
|
2813
|
+
"type": "boolean"
|
|
2709
2814
|
}
|
|
2710
2815
|
},
|
|
2711
2816
|
"hasDynamicHelp": true,
|
|
2712
2817
|
"hiddenAliases": [],
|
|
2713
|
-
"id": "agent:
|
|
2818
|
+
"id": "agent:publish:authoring-bundle",
|
|
2714
2819
|
"pluginAlias": "@salesforce/plugin-agent",
|
|
2715
2820
|
"pluginName": "@salesforce/plugin-agent",
|
|
2716
2821
|
"pluginType": "core",
|
|
2717
|
-
"state": "preview",
|
|
2718
2822
|
"strict": true,
|
|
2719
|
-
"summary": "
|
|
2823
|
+
"summary": "Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.",
|
|
2720
2824
|
"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
|
+
},
|
|
2721
2845
|
"isESM": true,
|
|
2722
2846
|
"relativePath": [
|
|
2723
2847
|
"lib",
|
|
2724
2848
|
"commands",
|
|
2725
2849
|
"agent",
|
|
2726
|
-
"
|
|
2727
|
-
"
|
|
2850
|
+
"publish",
|
|
2851
|
+
"authoring-bundle.js"
|
|
2728
2852
|
],
|
|
2729
2853
|
"aliasPermutations": [],
|
|
2730
2854
|
"permutations": [
|
|
2731
|
-
"agent:
|
|
2732
|
-
"
|
|
2733
|
-
"
|
|
2734
|
-
"agent:
|
|
2735
|
-
"
|
|
2736
|
-
"
|
|
2855
|
+
"agent:publish:authoring-bundle",
|
|
2856
|
+
"publish:agent:authoring-bundle",
|
|
2857
|
+
"publish:authoring-bundle:agent",
|
|
2858
|
+
"agent:authoring-bundle:publish",
|
|
2859
|
+
"authoring-bundle:agent:publish",
|
|
2860
|
+
"authoring-bundle:publish:agent"
|
|
2737
2861
|
]
|
|
2738
2862
|
},
|
|
2739
2863
|
"agent:test:create": {
|
|
@@ -3873,130 +3997,6 @@
|
|
|
3873
3997
|
"read:trace:agent"
|
|
3874
3998
|
]
|
|
3875
3999
|
},
|
|
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.5"
|
|
4671
4671
|
}
|