pyxecm 3.6.1__tar.gz → 3.6.2__tar.gz

{pyxecm-3.6.1 → pyxecm-3.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.6.1
+Version: 3.6.2
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>

{pyxecm-3.6.1 → pyxecm-3.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.6.1"
+version = "3.6.2"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',

{pyxecm-3.6.1 → pyxecm-3.6.2}/src/pyxecm/otca.py

@@ -122,18 +122,22 @@ class OTCA:
         # Stats endpoint:
         otca_config["usageStatsUrl"] = base_url + "/v1/usage-stats"
 
+        # Tools Url
+        tools_url = base_url + "/v1/tools"
+        otca_config["toolsUrl"] = tools_url
+
         # MCP Client endpoints:
-        otca_config["mcpClientServersUrl"] = base_url + "/mcp-client/servers"
-        otca_config["mcpClientToolsUrl"] = base_url + "/mcp-client/tools"
-        otca_config["mcpClientToolsRefreshUrl"] = base_url + "/mcp-client/tools/refresh"
-        otca_config["mcpClientHealthUrl"] = base_url + "/mcp-client/health"
+        mcp_client_url = base_url + "/mcp-client"
+        otca_config["mcpClientServersUrl"] = mcp_client_url + "/servers"
+        otca_config["mcpClientToolsUrl"] = mcp_client_url + "/tools"
+        otca_config["mcpClientToolsRefreshUrl"] = otca_config["mcpClientToolsUrl"] + "/refresh"
+        otca_config["mcpClientToolsSyncUrl"] = otca_config["mcpClientToolsUrl"] + "/sync"
+        otca_config["mcpClientHealthUrl"] = mcp_client_url + "/health"
 
         # MCP Server endpoints:
-        otca_config["mcpServerAllToolsUrl"] = base_url + "/mcp-server/list/alltools"
-        otca_config["mcpServerRegisterToolsUrl"] = base_url + "/mcp-server/register/tools"
-        otca_config["mcpServerToolsUrl"] = base_url + "/mcp-server/list/tools"
-        otca_config["mcpServerDeleteToolsUrl"] = base_url + "/mcp-server/tools"
-        otca_config["mcpServerHealthUrl"] = base_url + "/mcp-server/health"
+        mcp_server_url = base_url + "/mcp-server"
+        otca_config["mcpServerToolsUrl"] = mcp_server_url + "/tools"
+        otca_config["mcpServerHealthUrl"] = mcp_server_url + "/health"
 
         otca_config["contentSystem"] = self.get_content_system()
         otca_config["clientId"] = client_id
@@ -1268,6 +1272,27 @@ class OTCA:
 
     # end method definition
 
+    def get_tools(self) -> list | None:
+        """List all tools available from remote MCP servers.
+
+        Returns:
+            list | None:
+                List of available MCP tools or None in case of an error.
+
+        """
+
+        request_url = self.config()["toolsUrl"]
+        request_header = self.request_header(service_type="user")
+
+        return self.do_request(
+            url=request_url,
+            method="GET",
+            headers=request_header,
+            failure_message="Canbnot get list of tools",
+        )
+
+    # end method definition
+
     # --- MCP Client Methods ---
 
     def create_mcp_server(self, server_config: dict) -> dict | None:
@@ -1410,6 +1435,29 @@ class OTCA:
             list | None:
                 List of available MCP tools or None in case of an error.
 
+        Example:
+        [
+            {
+                'id': 2,
+                'key': 'ALLOWED_MCP_TOOLS',
+                'value': [
+                    {
+                        'name': 'current_time',
+                        'description': 'Use this to get the current date and time, return it as a string.'
+                    },
+                    {
+                        'name': 'otcm_recman_agent',
+                        'description': "Invoke Records Management agent and its related tools."
+                    },
+                    {
+                        'name': 'otcm_workspace_agent',
+                        'description': "Invoke the workspace operations agent for OpenText Content Management.'
+                    }
+                ],
+                'subscription_id': None
+            }
+        ]
+
         """
 
         request_url = self.config()["mcpClientToolsUrl"]
@@ -1476,7 +1524,7 @@ class OTCA:
 
         """
 
-        request_url = self.config()["mcpServerAllToolsUrl"]
+        request_url = self.config()["mcpServerToolsUrl"]
         request_header = self.request_header(service_type="user")
 
         return self.do_request(
@@ -1501,7 +1549,7 @@ class OTCA:
 
         """
 
-        request_url = self.config()["mcpServerRegisterToolsUrl"]
+        request_url = self.config()["mcpServerToolsUrl"]
         request_header = self.request_header(service_type="user")
 
         return self.do_request(
@@ -1548,7 +1596,7 @@ class OTCA:
 
         """
 
-        request_url = self.config()["mcpServerDeleteToolsUrl"]
+        request_url = self.config()["mcpServerToolsUrl"]
         request_header = self.request_header(service_type="user")
 
         return self.do_request(

{pyxecm-3.6.1 → pyxecm-3.6.2}/src/pyxecm/otcs.py

@@ -27519,7 +27519,13 @@ class OTCS:
                     workspace_id,
                 )
                 return None
-        template_names = [item.text for item in root.findall("startup/processing/templates/template")]
+        template_names = [
+            item.text for item in root.findall("startup/processing/templates/template") if item is not None
+        ]
+        # below for scenarios where they only configure one template for testing
+        if not template_names:
+            # A single template appears only in startup/processing/template instead
+            template_names = [item.text for item in root.findall("startup/processing/template") if item is not None]
 
         return template_names
 
@@ -29199,11 +29205,19 @@ class OTCS:
             if isinstance(due_in, dict):
                 map_value(due_in, "due_in_unit", self.REMINDER_UNIT_NAMES)
             seq_repeat = schedule.get("seq_repeat")
-            if "Every 2 weeks" in seq_repeat:
-                followup["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("bi-weekly")
-            elif "Every 2 months" in seq_repeat:
-                followup["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("every 2 months")
-            # TODO: Handle other repeat patterns such as "quarterly", "semi-annually", and "yearly"
+            if seq_repeat:
+                if "Every day" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("daily")
+                if "Every 2 weeks" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("bi-weekly")
+                elif "Every 2 months" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("every 2 months")
+                elif "every 3 months" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("quarterly")
+                elif "every 6 months" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("semi-annually")
+                elif "Every year" in seq_repeat:
+                    schedule["repeat_on"] = OTCS.REMINDER_SEQUENCE_MAP.get("yearly")
 
         # OTCS reports this flag as 0 / 1 while the reminder methods take a boolean:
         if isinstance(followup.get("activation_by_day"), int):

{pyxecm-3.6.1 → pyxecm-3.6.2}/src/pyxecm_customizer/payload.py

@@ -608,6 +608,7 @@ class Payload:
         self._embeddings = self.get_payload_section("embeddings")
         self._nifi_flows = self.get_payload_section("nifi")
         self._aviator_mcp_servers = self.get_payload_section("aviatorMcpServers")
+        self._aviator_mcp_tools = self.get_payload_section("aviatorMcpTools")
 
         return self._payload
 
@@ -2951,6 +2952,14 @@ class Payload:
                             self.logger.warning(
                                 "aviatorMcpServers in payload but Content Aviator (OTCA) is not configured! MCP servers will not be processed.",
                             )
+                    case "aviatorMcpTools":
+                        if self._otca and isinstance(self._otca, OTCA):
+                            self._log_header_callback("Process Aviator MCP Tools")
+                            self.process_mcp_tools()
+                        else:
+                            self.logger.warning(
+                                "aviatorMcpTools in payload but Content Aviator (OTCA) is not configured! MCP tools will not be processed.",
+                            )
                     case _:
                         self.logger.error(
                             "Illegal payload section name -> '%s' in payloadSections!",
@@ -32224,3 +32233,137 @@ class Payload:
         return success
 
     # end method definition
+
+    @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="process_mcp_tools")
+    def process_mcp_tools(self, section_name: str = "aviatorMcpTools") -> bool:
+        """Register Content Aviator agents as MCP tools.
+
+        Payload item keys:
+            - enabled (bool, optional, default=True)
+            - name (str, required)
+
+        Args:
+            section_name (str, optional):
+                The name of the payload section. It can be overridden
+                for cases where multiple sections of same type
+                are used (e.g. the "Post" sections).
+                This name is also used for the "success" status
+                files written to the Admin Personal Workspace.
+
+        Returns:
+            bool:
+                True, if payload has been processed without errors, False otherwise.
+
+        """
+
+        if not self._aviator_mcp_tools:
+            self.logger.info(
+                "Payload section -> '%s' is empty. Skipping...",
+                section_name,
+            )
+            return True
+
+        # If this payload section has been processed successfully before we
+        # can return True and skip processing it once more:
+        if self.check_status_file(payload_section_name=section_name):
+            return True
+
+        success: bool = True
+
+        # list_mcp_tools() returns a list of settings entries (e.g. key -> 'ALLOWED_MCP_TOOLS')
+        # whose "value" is the actual list of tool dictionaries with "name" and "description":
+        existing_mcp_tools = self._otca.list_registered_mcp_tools()
+        if existing_mcp_tools is None:
+            self.logger.warning(
+                "Failed to retrieve the list of available MCP tools from Content Aviator. Cannot check if tools are already registered."
+            )
+
+        existing_mcp_tool_names = [
+            tool.get("name")
+            for entry in existing_mcp_tools or []
+            for tool in entry.get("value") or []
+            if tool.get("name")
+        ]
+        if existing_mcp_tool_names:
+            self.logger.info(
+                "Already registered MCP tools in Content Aviator: %s",
+                ", ".join(existing_mcp_tool_names),
+            )
+
+        for mcp_tool in self._aviator_mcp_tools:
+            tool_name = mcp_tool.get("name")
+            if not tool_name:
+                self.logger.error("Content Aviator MCP tool needs a name in payload! Skipping...")
+                success = False
+                continue
+
+            # Check if element has been disabled in payload (enabled = false).
+            # In this case we skip the element:
+            if not mcp_tool.get("enabled", True):
+                self.logger.info(
+                    "Payload for Content Aviator MCP tool -> '%s' is disabled. Skipping...",
+                    tool_name,
+                )
+                continue
+
+            if tool_name in existing_mcp_tool_names:
+                self.logger.info(
+                    "Content Aviator MCP tool -> '%s' is already registered in Content Aviator. No need to register it again. Skipping...",
+                    tool_name,
+                )
+                continue
+
+            response = self._otca.register_mcp_tools(tools=[tool_name])
+            if response:
+                tool_id = response.get("id", "Unknown ID")
+                # The response value is the complete list of tools registered for the
+                # tenant - we need to pick the entry of the tool we just registered:
+                value = response.get("value") or []
+                tool_entry = next((entry for entry in value if entry.get("name") == tool_name), None)
+                if tool_entry is None:
+                    self.logger.warning(
+                        "Content Aviator MCP tool -> '%s' is not included in the registration response!",
+                        tool_name,
+                    )
+                tool_description = (
+                    tool_entry.get("description", "Unknown Description") if tool_entry else "Unknown Description"
+                )
+                self.logger.info(
+                    "Registered Content Aviator MCP tool -> '%s' (%s).",
+                    tool_name,
+                    tool_id,
+                )
+                mcp_tool["id"] = tool_id  # record the ID of the MCP tool settings record in the payload
+                mcp_tool["description"] = tool_description  # record the created tool description in the payload
+                mcp_tool["registered"] = True
+            else:
+                self.logger.error(
+                    "Failed to register Content Aviator MCP tool -> '%s'!",
+                    tool_name,
+                )
+                mcp_tool["registered"] = False
+                success = False
+        # end for mcp_tool in self._aviator_mcp_tools
+
+        registered_tools = [tool.get("name") for tool in self._aviator_mcp_tools if tool.get("registered") is True]
+        if registered_tools:
+            self.logger.info(
+                "Successfully registered the following additional MCP tools: %s",
+                registered_tools,
+            )
+        failed_tools = [tool.get("name") for tool in self._aviator_mcp_tools if tool.get("registered") is False]
+        if failed_tools:
+            self.logger.info(
+                "Failed to register the following MCP tools: %s",
+                failed_tools,
+            )
+
+        self.write_status_file(
+            success=success,
+            payload_section_name=section_name,
+            payload_section=self._aviator_mcp_tools,
+        )
+
+        return success
+
+    # end method definition