@viu/emporix-sdk 2.35.0 → 2.36.0

package/dist/index.d.cts

@@ -3004,10 +3004,7 @@ type McpServerConfigRequest = McpServerConfig & {
 type McpServerConfigResponse = McpServerConfig & {
     authorizationHeaderToken?: ExpandableTokenResponse;
 };
-/**
- * An object representing customer's own implementation of the MCP server.
- */
-type BaseMcpServer = {
+type BaseManagedMcpServer = {
     /**
      * Name of the MCP server.
      */
@@ -3018,14 +3015,160 @@ type BaseMcpServer = {
     enabled?: boolean;
     transport?: CustomMcpServerTransportType;
 };
-type McpServerRequest = BaseMcpServer & {
+/**
+ * Type of the managed MCP server resource. Possible values:
+ * * `custom`
+ * * `dynamic`
+ *
+ * **The `dynamic` value is in preview mode** - some of the features may not be fully operational yet.
+ */
+type ManagedMcpServerType = 'custom' | 'dynamic';
+/**
+ * HTTP method used to invoke the Automation function.
+ */
+type McpToolInvocationMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Location of the tool arguments in the HTTP request. Defaults to `body` when omitted.
+ */
+type McpToolInvocationArgsLocation = 'body' | 'query';
+type McpToolInvocationRequest = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId: string;
+    method: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolInvocationResponse = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId?: string;
+    method?: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolConfigRequest = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema: string;
+    invocation: McpToolInvocationRequest;
+};
+type McpToolConfigResponse = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema?: string;
+    invocation?: McpToolInvocationResponse;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolRequest = {
+    /**
+     * Unique name of the tool. Must not contain whitespace characters.
+     */
+    name: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config: McpToolConfigRequest;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolResponse = {
+    /**
+     * Unique name of the tool.
+     */
+    name?: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt?: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config?: McpToolConfigResponse;
+};
+type CustomMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For custom MCP servers it has to be set to `custom` or omitted. Defaults to `custom`.
+     */
+    type?: ManagedMcpServerType;
     config: McpServerConfigRequest;
     metadata?: MetadataRequest;
 };
-type McpServerResponse = BaseMcpServer & {
+type DynamicMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools: Array<McpToolRequest>;
+    metadata?: MetadataRequest;
+};
+type McpServerRequest = CustomMcpServerRequest | DynamicMcpServerRequest;
+type CustomMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * Type of the managed MCP server resource.
+     */
+    type?: ManagedMcpServerType;
     config?: McpServerConfigResponse;
     metadata?: MetadataResponse$1;
 };
+type DynamicMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type?: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools?: Array<McpToolResponse>;
+    metadata?: MetadataResponse$1;
+};
+type McpServerResponse = CustomMcpServerResponse | DynamicMcpServerResponse;
 type CommerceEventsResponse = {
     /**
      * List of events available to use by an agent with the `COMMERCE_EVENTS` trigger.
@@ -3033,9 +3176,9 @@ type CommerceEventsResponse = {
     events?: Array<string>;
 };
 /**
- * Type of the MCP server. The `custom` type allows you to integrate with your own MCP server instance, while the `predefined` type allows you to integrate with one of the instances provided by Emporix.
+ * Type of the MCP server attachment on an agent. The `custom` type references a tenant-managed MCP server with a URL. The `predefined` type references an Emporix domain MCP server. The `dynamic` type references a tenant-managed dynamic MCP server and may include an optional tool-name allow-list.
  */
-type McpServerType = 'custom' | 'predefined';
+type McpServerType = 'custom' | 'predefined' | 'dynamic';
 /**
  * Type of the communication between the agent and the MCP server. The `streamable_http` protocol is recommended, since the `sse` protocol is deprecated.
  */
@@ -3066,17 +3209,42 @@ type CustomAgentMcpServerRequest = BaseAgentMcpServer & {
         id: string;
     };
 };
-type CustomAgentMcpServerResponse = CustomAgentMcpServerRequest & {
+type DynamicAgentMcpServerRequest = BaseAgentMcpServer & {
+    /**
+     * For a dynamic MCP server attachment it has to be set to `dynamic`.
+     */
+    type?: unknown;
+    mcpServer: {
+        /**
+         * ID of the dynamic MCP server.
+         */
+        id: string;
+    };
+    /**
+     * Optional allow-list of tool names from the dynamic MCP server.
+     */
+    tools?: Array<string>;
+};
+type AgentMcpServerResponse = {
+    type: McpServerType;
     mcpServer?: McpServerResponse & unknown;
+    /**
+     * Present for `predefined` attachments.
+     */
+    domain?: 'customer' | 'extensibility' | 'order' | 'product' | 'frontend';
+    /**
+     * Tool-name allow-list. Present for `predefined` attachments and for `dynamic` attachments when a subset is configured. Omitted on `dynamic` means all enabled tools on the MCP server.
+     */
+    tools?: Array<string>;
 };
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | PredefinedAgentMcpServer>;
+type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | DynamicAgentMcpServerRequest | PredefinedAgentMcpServer>;
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersResponse = Array<CustomAgentMcpServerResponse | PredefinedAgentMcpServer>;
+type AgentMcpServersResponse = Array<AgentMcpServerResponse>;
 type BaseLlm = {
     /**
      * The exact name of the model.

package/dist/index.d.ts

@@ -3004,10 +3004,7 @@ type McpServerConfigRequest = McpServerConfig & {
 type McpServerConfigResponse = McpServerConfig & {
     authorizationHeaderToken?: ExpandableTokenResponse;
 };
-/**
- * An object representing customer's own implementation of the MCP server.
- */
-type BaseMcpServer = {
+type BaseManagedMcpServer = {
     /**
      * Name of the MCP server.
      */
@@ -3018,14 +3015,160 @@ type BaseMcpServer = {
     enabled?: boolean;
     transport?: CustomMcpServerTransportType;
 };
-type McpServerRequest = BaseMcpServer & {
+/**
+ * Type of the managed MCP server resource. Possible values:
+ * * `custom`
+ * * `dynamic`
+ *
+ * **The `dynamic` value is in preview mode** - some of the features may not be fully operational yet.
+ */
+type ManagedMcpServerType = 'custom' | 'dynamic';
+/**
+ * HTTP method used to invoke the Automation function.
+ */
+type McpToolInvocationMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Location of the tool arguments in the HTTP request. Defaults to `body` when omitted.
+ */
+type McpToolInvocationArgsLocation = 'body' | 'query';
+type McpToolInvocationRequest = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId: string;
+    method: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolInvocationResponse = {
+    /**
+     * Identifier of the Automation function to invoke when the tool is called.
+     */
+    functionId?: string;
+    method?: McpToolInvocationMethod;
+    argsLocation?: McpToolInvocationArgsLocation;
+};
+type McpToolConfigRequest = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema: string;
+    invocation: McpToolInvocationRequest;
+};
+type McpToolConfigResponse = {
+    /**
+     * OAuth scopes required to invoke the tool.
+     */
+    requiredScopes?: Array<string>;
+    /**
+     * JSON Schema document describing the tool input, provided as a JSON string.
+     */
+    inputSchema?: string;
+    invocation?: McpToolInvocationResponse;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolRequest = {
+    /**
+     * Unique name of the tool. Must not contain whitespace characters.
+     */
+    name: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config: McpToolConfigRequest;
+};
+/**
+ * Tool definition for a dynamic MCP server.
+ *
+ * **Dynamic MCP tools are in preview mode** - some of the features may not be fully operational yet.
+ */
+type McpToolResponse = {
+    /**
+     * Unique name of the tool.
+     */
+    name?: string;
+    /**
+     * Human-readable description of the tool.
+     */
+    description?: string;
+    /**
+     * Prompt that defines when and why the agent should call this tool.
+     */
+    prompt?: string;
+    /**
+     * An indicator whether the tool is enabled.
+     */
+    enabled?: boolean;
+    config?: McpToolConfigResponse;
+};
+type CustomMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For custom MCP servers it has to be set to `custom` or omitted. Defaults to `custom`.
+     */
+    type?: ManagedMcpServerType;
     config: McpServerConfigRequest;
     metadata?: MetadataRequest;
 };
-type McpServerResponse = BaseMcpServer & {
+type DynamicMcpServerRequest = BaseManagedMcpServer & {
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools: Array<McpToolRequest>;
+    metadata?: MetadataRequest;
+};
+type McpServerRequest = CustomMcpServerRequest | DynamicMcpServerRequest;
+type CustomMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * Type of the managed MCP server resource.
+     */
+    type?: ManagedMcpServerType;
     config?: McpServerConfigResponse;
     metadata?: MetadataResponse$1;
 };
+type DynamicMcpServerResponse = BaseManagedMcpServer & {
+    /**
+     * Unique identifier of the MCP server.
+     */
+    id?: string;
+    /**
+     * For dynamic MCP servers it has to be set to `dynamic`.
+     */
+    type?: ManagedMcpServerType;
+    /**
+     * List of tools exposed by this MCP server.
+     *
+     * **The `tools` field is in preview mode** - some of the features may not be fully operational yet.
+     */
+    tools?: Array<McpToolResponse>;
+    metadata?: MetadataResponse$1;
+};
+type McpServerResponse = CustomMcpServerResponse | DynamicMcpServerResponse;
 type CommerceEventsResponse = {
     /**
      * List of events available to use by an agent with the `COMMERCE_EVENTS` trigger.
@@ -3033,9 +3176,9 @@ type CommerceEventsResponse = {
     events?: Array<string>;
 };
 /**
- * Type of the MCP server. The `custom` type allows you to integrate with your own MCP server instance, while the `predefined` type allows you to integrate with one of the instances provided by Emporix.
+ * Type of the MCP server attachment on an agent. The `custom` type references a tenant-managed MCP server with a URL. The `predefined` type references an Emporix domain MCP server. The `dynamic` type references a tenant-managed dynamic MCP server and may include an optional tool-name allow-list.
  */
-type McpServerType = 'custom' | 'predefined';
+type McpServerType = 'custom' | 'predefined' | 'dynamic';
 /**
  * Type of the communication between the agent and the MCP server. The `streamable_http` protocol is recommended, since the `sse` protocol is deprecated.
  */
@@ -3066,17 +3209,42 @@ type CustomAgentMcpServerRequest = BaseAgentMcpServer & {
         id: string;
     };
 };
-type CustomAgentMcpServerResponse = CustomAgentMcpServerRequest & {
+type DynamicAgentMcpServerRequest = BaseAgentMcpServer & {
+    /**
+     * For a dynamic MCP server attachment it has to be set to `dynamic`.
+     */
+    type?: unknown;
+    mcpServer: {
+        /**
+         * ID of the dynamic MCP server.
+         */
+        id: string;
+    };
+    /**
+     * Optional allow-list of tool names from the dynamic MCP server.
+     */
+    tools?: Array<string>;
+};
+type AgentMcpServerResponse = {
+    type: McpServerType;
     mcpServer?: McpServerResponse & unknown;
+    /**
+     * Present for `predefined` attachments.
+     */
+    domain?: 'customer' | 'extensibility' | 'order' | 'product' | 'frontend';
+    /**
+     * Tool-name allow-list. Present for `predefined` attachments and for `dynamic` attachments when a subset is configured. Omitted on `dynamic` means all enabled tools on the MCP server.
+     */
+    tools?: Array<string>;
 };
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | PredefinedAgentMcpServer>;
+type AgentMcpServersRequest = Array<CustomAgentMcpServerRequest | DynamicAgentMcpServerRequest | PredefinedAgentMcpServer>;
 /**
  * List of MCP servers which agents should have access to.
  */
-type AgentMcpServersResponse = Array<CustomAgentMcpServerResponse | PredefinedAgentMcpServer>;
+type AgentMcpServersResponse = Array<AgentMcpServerResponse>;
 type BaseLlm = {
     /**
      * The exact name of the model.

package/dist/index.js

@@ -698,7 +698,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "2.35.0";
+var version = "2.36.0";
 
 // src/version.ts
 var SDK_VERSION = version;