@salesforce/plugin-agent 1.42.1 → 1.43.0

package/messages/agent.mcp.get.md

@@ -0,0 +1,25 @@
+# summary
+
+Get a single MCP server registered in the API Catalog.
+
+# description
+
+Retrieves the details of an MCP (Model Context Protocol) server by its identifier, including its name, label, type, status, and server URL.
+
+# examples
+
+- Get an MCP server by id in the default target org:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001
+
+- Get an MCP server and output as JSON:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --mcp-server-id 0Mx000000000001 --json
+
+# flags.mcp-server-id.summary
+
+The identifier of the MCP server to retrieve.
+
+# error.failed
+
+Failed to get MCP server: %s

package/messages/agent.mcp.list.md

@@ -0,0 +1,33 @@
+# summary
+
+List the MCP servers registered in the API Catalog.
+
+# 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.
+
+# examples
+
+- List all MCP servers in the default target org:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg
+
+- List external MCP servers filtered by status and output as JSON:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --type EXTERNAL --status ACTIVE --json
+
+# flags.label.summary
+
+Filter the MCP servers by label.
+
+# flags.type.summary
+
+Filter the MCP servers by type.
+
+# flags.status.summary
+
+Filter the MCP servers by connection status. Only ACTIVE and DISCONNECTED are supported as filters.
+
+# error.failed
+
+Failed to list MCP servers: %s

package/messages/agent.mcp.update.md

@@ -0,0 +1,65 @@
+# summary
+
+Update an MCP server registered in the API Catalog.
+
+# 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.
+
+# examples
+
+- Update the label and description of an MCP server in the default target org:
+
+  <%= config.bin %> <%= command.id %> --mcp-server-id 0XSxx0000000001 --label "Orders MCP" --description "Order tooling" --target-org myOrg
+
+- Update the server URL and switch the authorization to OAuth, piping the client secret from stdin and outputting as JSON:
+
+  cat 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
+
+# flags.mcp-server-id.summary
+
+ID of the MCP server to update.
+
+# flags.label.summary
+
+New display label for the MCP server.
+
+# flags.description.summary
+
+New description for the MCP server.
+
+# flags.server-url.summary
+
+New endpoint URL of the MCP server.
+
+# flags.auth-type.summary
+
+Authorization type to apply to the MCP server (OAUTH or NO_AUTH).
+
+# flags.identity-provider.summary
+
+Identity provider name for OAuth authorization (required when --auth-type is OAUTH).
+
+# flags.client-id.summary
+
+OAuth client ID (required when --auth-type is OAUTH).
+
+# flags.client-secret.summary
+
+OAuth client secret (required when --auth-type is OAUTH). Pass "-" to read it from stdin (piped) and keep it out of shell history.
+
+# flags.scope.summary
+
+OAuth scope (required when --auth-type is OAUTH).
+
+# error.failed
+
+Failed to update MCP server: %s
+
+# error.noFields
+
+No fields to update. Provide at least one of --label, --description, --server-url, or --auth-type.
+
+# error.missingOauthFields
+
+OAuth authorization requires --identity-provider, --client-id, --client-secret, and --scope.

package/messages/shared.md

@@ -28,6 +28,22 @@ Explicitly specify which test runner to use (agentforce-studio or testing-center
 
 By default, the command automatically detects which test runner to use based on the test definition metadata type in your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition metadata. 'testing-center' uses AiEvaluationDefinition metadata.
 
+# flags.context-variables.summary
+
+Session variables for the agent preview session, in the form Name=Value.
+
+# flags.context-variables.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.
+
+Linked 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.
+
+State variables use the bare developerName, no prefix. These seed mutable agent state declared in agentVersion.stateVariables. Example: MyStateVar=some-value.
+
+Both namespaces can be mixed in one value. Example: --context-variables '$Context.MyLinkedVar=foo,MyStateVar=bar'.
+
+Tips: (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.
+
 # error.invalidAgentType
 
 agentType must be either "customer" or "internal". Found: [%s]