mcp-instana 0.3.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

src/core/smart_router_tool.py

@@ -0,0 +1,574 @@
+"""
+Smart Router Tool
+
+This module provides a unified MCP tool that routes queries to the appropriate
+application-specific tools for Instana monitoring.
+"""
+
+import logging
+from typing import Any, Dict, List, Optional, Union
+
+from mcp.types import ToolAnnotations
+
+from src.core.utils import BaseInstanaClient, register_as_tool
+
+logger = logging.getLogger(__name__)
+
+
+class SmartRouterMCPTool(BaseInstanaClient):
+    """
+    Smart router that routes queries to Application Metrics, Alert Configuration, and Catalog tools.
+    The LLM agent determines the appropriate operation based on query understanding.
+    """
+
+    def __init__(self, read_token: str, base_url: str):
+        """Initialize the Smart Router MCP tool."""
+        super().__init__(read_token=read_token, base_url=base_url)
+
+        # Initialize the application tool clients
+        from src.application.application_alert_config import ApplicationAlertMCPTools
+        from src.application.application_call_group import ApplicationCallGroupMCPTools
+        from src.application.application_catalog import ApplicationCatalogMCPTools
+        from src.application.application_global_alert_config import (
+            ApplicationGlobalAlertMCPTools,
+        )
+        from src.application.application_resources import ApplicationResourcesMCPTools
+        from src.application.application_settings import ApplicationSettingsMCPTools
+
+        self.app_call_group_client = ApplicationCallGroupMCPTools(read_token, base_url)
+        self.app_alert_config_client = ApplicationAlertMCPTools(read_token, base_url)
+        self.app_global_alert_config_client = ApplicationGlobalAlertMCPTools(read_token, base_url)
+        self.app_resources_client = ApplicationResourcesMCPTools(read_token, base_url)
+        self.app_settings_client = ApplicationSettingsMCPTools(read_token, base_url)
+        self.app_catalog_client = ApplicationCatalogMCPTools(read_token, base_url)
+
+        logger.info("Smart Router initialized with Application tools")
+
+    @register_as_tool(
+        title="Manage Instana Application Resources",
+        annotations=ToolAnnotations(readOnlyHint=False, destructiveHint=False)
+    )
+    async def manage_instana_resources(
+        self,
+        resource_type: str,
+        operation: str,
+        params: Optional[Dict[str, Any]] = None,
+        ctx=None
+    ) -> Dict[str, Any]:
+        """
+        Unified Instana application resource manager for metrics, alerts, configurations, and catalog.
+
+        Resource Types:
+        - "metrics": Query application metrics, services, and endpoints
+        - "alert_config": Manage application-specific alert configurations
+        - "global_alert_config": Manage global application alert configurations
+        - "settings": Manage application perspectives, endpoints, services, manual services
+        - "catalog": Access application tag and metric catalog information
+
+        METRICS (resource_type="metrics"):
+            operation: "application"
+            params: {query, time_frame, metrics, tag_filter_expression, group, order, pagination, include_internal, include_synthetic}
+
+            List services: group={"groupbyTag": "service.name", "groupbyTagEntity": "DESTINATION"}
+            List endpoints: group={"groupbyTag": "endpoint.name", "groupbyTagEntity": "DESTINATION"}
+
+        ALERT_CONFIG (resource_type="alert_config"):
+            operations: find_active, find_versions, find, create, update, delete, enable, disable, restore, update_baseline
+            params: {application_id OR application_name, id, alert_ids, valid_on, created, payload}
+            Note: Provide application_name (auto-resolved to ID) or application_id
+
+        GLOBAL_ALERT_CONFIG (resource_type="global_alert_config"):
+            operations: find_active, find_versions, find, create, update, delete, enable, disable, restore
+            params: {application_id OR application_name, id, alert_ids, valid_on, created, payload}
+            Note: Provide application_name (auto-resolved to ID) or application_id
+
+        SETTINGS (resource_type="settings"):
+            operations: get_all, get, create, update, delete, order, replace_all
+            params: {resource_subtype, id, application_name, payload, request_body}
+
+            resource_subtypes: "application", "endpoint", "service", "manual_service"
+
+            Creating application perspectives (resource_subtype="application", operation="create"):
+            - REQUIRED: label (application name)
+            - OPTIONAL: scope (default: INCLUDE_ALL_DOWNSTREAM), boundaryScope (default: ALL),
+                       accessRules (default: READ_WRITE_GLOBAL), tagFilterExpression
+
+            Minimal example:
+            params={"resource_subtype": "application", "payload": {"label": "My App"}}
+
+            Full example:
+            params={
+                "resource_subtype": "application",
+                "payload": {
+                    "label": "My App",
+                    "scope": "INCLUDE_ALL_DOWNSTREAM",
+                    "boundaryScope": "ALL",
+                    "accessRules": [{"accessType": "READ_WRITE", "relationType": "GLOBAL"}],
+                    "tagFilterExpression": {"type": "TAG_FILTER", "name": "service.name", "operator": "CONTAINS", "entity": "DESTINATION", "value": "my-service"}
+                }
+            }
+
+        CATALOG (resource_type="catalog"):
+            operations: get_tag_catalog, get_metric_catalog
+            params: {use_case, data_source, var_from}
+
+            Get tag catalog: operation="get_tag_catalog", params={"use_case": "GROUPING", "data_source": "CALLS"}
+            Get metric catalog: operation="get_metric_catalog"
+
+        Args:
+            resource_type: "metrics", "alert_config", "global_alert_config", "settings", or "catalog"
+            operation: Specific operation for the resource type
+            params: Operation-specific parameters (optional)
+            ctx: MCP context (internal)
+
+        Returns:
+            Dictionary with results from the appropriate tool
+
+        Examples:
+            # List services
+            resource_type="metrics", operation="application", params={
+                "tag_filter_expression": {"type": "TAG_FILTER", "name": "application.name", "operator": "EQUALS", "entity": "DESTINATION", "value": "All Services"},
+                "group": {"groupbyTag": "service.name", "groupbyTagEntity": "DESTINATION"}
+            }
+
+            # Find active alerts by name
+            resource_type="alert_config", operation="find_active", params={"application_name": "All Services"}
+
+            # Get application config by name
+            resource_type="settings", operation="get", params={"resource_subtype": "application", "application_name": "MCP_TEST_DEMO"}
+
+            # Create application perspective
+            resource_type="settings", operation="create", params={"resource_subtype": "application", "payload": {"label": "My App"}}
+
+            # Get application tag catalog
+            resource_type="catalog", operation="get_tag_catalog", params={"use_case": "GROUPING", "data_source": "CALLS"}
+
+            # Get application metric catalog
+            resource_type="catalog", operation="get_metric_catalog"
+        """
+        try:
+            logger.info(f"Smart Router received: resource_type={resource_type}, operation={operation}")
+
+            # Initialize params if not provided
+            if params is None:
+                params = {}
+
+            # Validate resource_type
+            if resource_type not in ["metrics", "alert_config", "global_alert_config", "settings", "catalog"]:
+                return {
+                    "error": f"Invalid resource_type '{resource_type}'. Must be 'metrics', 'alert_config', 'global_alert_config', 'settings', or 'catalog'",
+                    "suggestion": "Choose 'metrics' for querying data, 'alert_config' for application-specific alerts, 'global_alert_config' for global alerts, 'settings' for application perspective configurations, or 'catalog' for tag and metric catalog information"
+                }
+
+            # Route to the appropriate resource handler
+            if resource_type == "metrics":
+                return await self._handle_metrics(operation, params, ctx)
+            elif resource_type == "alert_config":
+                return await self._handle_alert_config(operation, params, ctx)
+            elif resource_type == "global_alert_config":
+                return await self._handle_global_alert_config(operation, params, ctx)
+            elif resource_type == "settings":
+                return await self._handle_settings(operation, params, ctx)
+            elif resource_type == "catalog":
+                return await self._handle_catalog(operation, params, ctx)
+            else:
+                return {
+                    "error": f"Unsupported resource_type: {resource_type}",
+                    "supported_types": ["metrics", "alert_config", "global_alert_config", "settings", "catalog"]
+                }
+
+        except Exception as e:
+            logger.error(f"Error in smart router: {e}", exc_info=True)
+            return {
+                "error": f"Smart router error: {e!s}",
+                "resource_type": resource_type,
+                "operation": operation
+            }
+
+    async def _handle_metrics(
+        self,
+        operation: str,
+        params: Dict[str, Any],
+        ctx
+    ) -> Dict[str, Any]:
+        """Handle application metrics queries."""
+        if operation != "application":
+            return {
+                "error": f"Invalid operation '{operation}' for metrics. Only 'application' is supported.",
+                "valid_operations": ["application"]
+            }
+
+        # Extract parameters
+        query = params.get("query", "")
+        time_frame = params.get("time_frame")
+        metrics = params.get("metrics")
+        tag_filter_expression = params.get("tag_filter_expression")
+        group = params.get("group")
+        order = params.get("order")
+        pagination = params.get("pagination")
+        include_internal = params.get("include_internal")
+        include_synthetic = params.get("include_synthetic")
+
+        # Route to Application Call Group Metrics
+        logger.info("Routing to Application Call Group Metrics")
+
+        result = await self.app_call_group_client.get_grouped_calls_metrics(
+            metrics=metrics,
+            time_frame=time_frame,
+            group=group,
+            tag_filter_expression=tag_filter_expression,
+            include_internal=include_internal,
+            include_synthetic=include_synthetic,
+            order=order,
+            pagination=pagination,
+            ctx=ctx
+        )
+
+        return {
+            "resource_type": "metrics",
+            "technology": "application",
+            "query": query,
+            "results": result
+        }
+
+    async def _handle_alert_config(
+        self,
+        operation: str,
+        params: Dict[str, Any],
+        ctx
+    ) -> Dict[str, Any]:
+        """Handle Application Alert Config operations."""
+        valid_operations = [
+            "find_active", "find_versions", "find", "create", "update",
+            "delete", "enable", "disable", "restore", "update_baseline"
+        ]
+
+        if operation not in valid_operations:
+            return {
+                "error": f"Invalid operation '{operation}' for alert_config",
+                "valid_operations": valid_operations
+            }
+
+        # Extract parameters
+        application_id = params.get("application_id")
+        application_name = params.get("application_name")
+        id = params.get("id")
+        alert_ids = params.get("alert_ids")
+        valid_on = params.get("valid_on")
+        created = params.get("created")
+        payload = params.get("payload")
+
+        # If application_name is provided but not application_id, resolve it
+        if application_name and not application_id:
+            logger.info(f"Resolving application name '{application_name}' to application ID")
+            app_id_result = await self._get_application_id_by_name(application_name, ctx)
+
+            if "error" in app_id_result:
+                return {
+                    "resource_type": "alert_config",
+                    "operation": operation,
+                    "error": f"Failed to resolve application name '{application_name}': {app_id_result['error']}"
+                }
+
+            application_id = app_id_result.get("application_id")
+            logger.info(f"Resolved application '{application_name}' to ID: {application_id}")
+
+        # Route to the alert config client
+        result = await self.app_alert_config_client.execute_alert_config_operation(
+            operation=operation,
+            application_id=application_id,
+            id=id,
+            alert_ids=alert_ids,
+            valid_on=valid_on,
+            created=created,
+            payload=payload,
+            ctx=ctx
+        )
+
+        return {
+            "resource_type": "alert_config",
+            "operation": operation,
+            "application_name": application_name,
+            "application_id": application_id,
+            "results": result
+        }
+
+    async def _handle_global_alert_config(
+        self,
+        operation: str,
+        params: Dict[str, Any],
+        ctx
+    ) -> Dict[str, Any]:
+        """Handle Global Application Alert Config operations."""
+        valid_operations = [
+            "find_active", "find_versions", "find", "create", "update",
+            "delete", "enable", "disable", "restore"
+        ]
+
+        if operation not in valid_operations:
+            return {
+                "error": f"Invalid operation '{operation}' for global_alert_config",
+                "valid_operations": valid_operations
+            }
+
+        # Extract parameters
+        application_id = params.get("application_id")
+        application_name = params.get("application_name")
+        id = params.get("id")
+        alert_ids = params.get("alert_ids")
+        valid_on = params.get("valid_on")
+        created = params.get("created")
+        payload = params.get("payload")
+
+        # If application_name is provided but not application_id, resolve it
+        if application_name and not application_id:
+            logger.info(f"Resolving application name '{application_name}' to application ID")
+            app_id_result = await self._get_application_id_by_name(application_name, ctx)
+
+            if "error" in app_id_result:
+                return {
+                    "resource_type": "global_alert_config",
+                    "operation": operation,
+                    "error": f"Failed to resolve application name '{application_name}': {app_id_result['error']}"
+                }
+
+            application_id = app_id_result.get("application_id")
+            logger.info(f"Resolved application '{application_name}' to ID: {application_id}")
+
+        # Route to the global alert config client
+        result = await self.app_global_alert_config_client.execute_alert_config_operation(
+            operation=operation,
+            application_id=application_id,
+            id=id,
+            alert_ids=alert_ids,
+            valid_on=valid_on,
+            created=created,
+            payload=payload,
+            ctx=ctx
+        )
+
+        return {
+            "resource_type": "global_alert_config",
+            "operation": operation,
+            "application_name": application_name,
+            "application_id": application_id,
+            "results": result
+        }
+
+    async def _handle_settings(
+        self,
+        operation: str,
+        params: Dict[str, Any],
+        ctx
+    ) -> Dict[str, Any]:
+        """Handle Application Settings operations."""
+        valid_operations = [
+            "get_all", "get", "create", "update", "delete", "order", "replace_all"
+        ]
+
+        if operation not in valid_operations:
+            return {
+                "error": f"Invalid operation '{operation}' for settings",
+                "valid_operations": valid_operations
+            }
+
+        # Extract parameters
+        resource_subtype = params.get("resource_subtype")
+        id = params.get("id")
+        application_name = params.get("application_name")
+        payload = params.get("payload")
+        request_body = params.get("request_body")
+
+        # Validate resource_subtype
+        valid_subtypes = ["application", "endpoint", "service", "manual_service"]
+        if not resource_subtype or resource_subtype not in valid_subtypes:
+            return {
+                "error": f"Invalid or missing resource_subtype. Must be one of: {valid_subtypes}",
+                "resource_subtype": resource_subtype
+            }
+
+        # If application_name is provided for application resource_subtype and operation is "get"
+        # resolve it to application ID
+        if resource_subtype == "application" and operation == "get" and application_name and not id:
+            logger.info(f"Resolving application name '{application_name}' to application config ID")
+
+            # First, get all application configs
+            all_configs_result = await self.app_settings_client.execute_settings_operation(
+                operation="get_all",
+                resource_subtype="application",
+                ctx=ctx
+            )
+
+            # Search for matching application name in configs
+            if isinstance(all_configs_result, list):
+                for config in all_configs_result:
+                    if isinstance(config, dict):
+                        config_label = config.get('label', '')
+                        config_id = config.get('id', '')
+
+                        # Case-insensitive match
+                        if config_label.lower() == application_name.lower() and config_id:
+                            logger.info(f"Found application config '{config_label}' with ID: {config_id}")
+                            id = config_id
+                            break
+
+                if not id:
+                    return {
+                        "resource_type": "settings",
+                        "resource_subtype": resource_subtype,
+                        "operation": operation,
+                        "error": f"No application perspective found with name '{application_name}'"
+                    }
+            else:
+                return {
+                    "resource_type": "settings",
+                    "resource_subtype": resource_subtype,
+                    "operation": operation,
+                    "error": "Failed to retrieve application perspectives for name resolution"
+                }
+
+        # Route to the settings client
+        result = await self.app_settings_client.execute_settings_operation(
+            operation=operation,
+            resource_subtype=resource_subtype,
+            id=id,
+            payload=payload,
+            request_body=request_body,
+            ctx=ctx
+        )
+
+        return {
+            "resource_type": "settings",
+            "resource_subtype": resource_subtype,
+            "operation": operation,
+            "application_name": application_name if application_name else None,
+            "resolved_id": id if application_name else None,
+            "results": result
+        }
+
+    async def _get_application_id_by_name(
+        self,
+        application_name: str,
+        ctx
+    ) -> Dict[str, Any]:
+        """
+        Get application ID by application name using the Application Resources API.
+
+        Args:
+            application_name: Name of the application
+            ctx: MCP context
+
+        Returns:
+            Dictionary with application_id or error
+        """
+        try:
+            from datetime import datetime
+
+            logger.info(f"Resolving application name '{application_name}' to application ID using Application Resources API")
+
+            # Set time range (last hour)
+            to_time = int(datetime.now().timestamp() * 1000)
+            window_size = 60 * 60 * 1000  # 1 hour
+
+            # Use the app_resources_client to get applications
+            result = await self.app_resources_client._get_applications_internal(
+                name_filter=application_name,
+                window_size=window_size,
+                to_time=to_time,
+                ctx=ctx
+            )
+
+            logger.debug(f"Application Resources API result: {result}")
+
+            # Extract items from the result
+            items = result.get('items', []) if isinstance(result, dict) else []
+
+            if not items:
+                logger.warning(f"No application found with name filter '{application_name}'")
+                return {"error": f"No application found with name '{application_name}'"}
+
+            # Find exact match (case-insensitive)
+            for item in items:
+                if isinstance(item, dict):
+                    label = item.get('label', '')
+                    app_id = item.get('id', '')
+
+                    if label.lower() == application_name.lower() and app_id:
+                        logger.info(f"Found application '{label}' with ID: {app_id}")
+                        return {
+                            "application_id": app_id,
+                            "application_name": label
+                        }
+
+            # If no exact match, return the first result
+            first_item = items[0]
+            if isinstance(first_item, dict):
+                label = first_item.get('label', '')
+                app_id = first_item.get('id', '')
+
+                if app_id:
+                    logger.info(f"Using closest match: '{label}' with ID: {app_id}")
+                    return {
+                        "application_id": app_id,
+                        "application_name": label
+                    }
+
+            return {"error": f"No application found with name '{application_name}'"}
+
+        except Exception as e:
+            logger.error(f"Error fetching application ID: {e}", exc_info=True)
+            return {"error": f"Failed to fetch application ID: {e!s}"}
+
+    async def _handle_catalog(
+        self,
+        operation: str,
+        params: Dict[str, Any],
+        ctx
+    ) -> Dict[str, Any]:
+        """Handle Application Catalog operations."""
+        valid_operations = ["get_tag_catalog", "get_metric_catalog"]
+
+        if operation not in valid_operations:
+            return {
+                "error": f"Invalid operation '{operation}' for catalog",
+                "valid_operations": valid_operations
+            }
+
+        # Extract parameters
+        use_case = params.get("use_case")
+        data_source = params.get("data_source")
+        var_from = params.get("var_from")
+
+        # Route to the appropriate catalog method
+        if operation == "get_tag_catalog":
+            logger.info("Routing to Application Tag Catalog")
+            result = await self.app_catalog_client.get_application_tag_catalog(
+                use_case=use_case,
+                data_source=data_source,
+                var_from=var_from,
+                ctx=ctx
+            )
+
+            return {
+                "resource_type": "catalog",
+                "operation": operation,
+                "results": result
+            }
+
+        elif operation == "get_metric_catalog":
+            logger.info("Routing to Application Metric Catalog")
+            result = await self.app_catalog_client.get_application_metric_catalog(
+                ctx=ctx
+            )
+
+            return {
+                "resource_type": "catalog",
+                "operation": operation,
+                "results": result
+            }
+
+        return {
+            "error": f"Unsupported catalog operation: {operation}",
+            "valid_operations": valid_operations
+        }
+

src/core/utils.py

@@ -13,6 +13,14 @@ import requests
 # Import MCP dependencies
 from mcp.types import ToolAnnotations
 
+# Import for getting package version from meta data rather than server.py
+try:
+    from importlib.metadata import version
+    __version__ = version("mcp-instana")
+except Exception:
+    # Fallback version if package metadata is not available
+    __version__ = "0.3.1"
+
 # Registry to store all tools
 MCP_TOOLS = {}
 
@@ -112,10 +120,6 @@ def with_header_auth(api_class, allow_mock=True):
                             error_msg = "Instana base URL must start with http:// or https://"
                             print(f" {error_msg}", file=sys.stderr)
                             return {"error": error_msg}
-
-                        print(" Using header-based authentication (HTTP mode)", file=sys.stderr)
-                        print(" instana_base_url: ", instana_base_url)
-
                         # Import SDK components
                         from instana_client.api_client import ApiClient
                         from instana_client.configuration import Configuration
@@ -125,9 +129,10 @@ def with_header_auth(api_class, allow_mock=True):
                         configuration.host = instana_base_url
                         configuration.api_key['ApiKeyAuth'] = instana_token
                         configuration.api_key_prefix['ApiKeyAuth'] = 'apiToken'
-                        configuration.default_headers = {"User-Agent": "MCP-server/0.1.0"}
 
                         api_client_instance = ApiClient(configuration=configuration)
+                        user_agent_value = f"MCP-server/{__version__}"
+                        api_client_instance.set_default_header("User-Agent", header_value=user_agent_value)
                         api_instance = api_class(api_client=api_client_instance)
 
                         # Add the API instance to kwargs so the decorated function can use it
@@ -178,9 +183,12 @@ def with_header_auth(api_class, allow_mock=True):
                     configuration.host = self.base_url
                     configuration.api_key['ApiKeyAuth'] = self.read_token
                     configuration.api_key_prefix['ApiKeyAuth'] = 'apiToken'
-                    configuration.default_headers = {"User-Agent": "MCP-server/0.1.0"}
-
                     api_client_instance = ApiClient(configuration=configuration)
+                    # Set User-Agent header instead of User-Agent
+                    user_agent_value = f"MCP-server/{__version__}"
+                    # Add custom tracking headers
+                    api_client_instance.set_default_header("User-Agent", user_agent_value)
+                    print(f"✅ Set User-Agent header: {user_agent_value}", file=sys.stderr)
                     api_instance = api_class(api_client=api_client_instance)
 
                     kwargs['api_client'] = api_instance
@@ -212,7 +220,8 @@ class BaseInstanaClient:
         return {
             "Authorization": f"apiToken {self.read_token}",
             "Content-Type": "application/json",
-            "Accept": "application/json"
+            "Accept": "application/json",
+            "User-Agent": f"MCP-server/{__version__}",
         }
 
     async def make_request(self, endpoint: str, params: Union[Dict[str, Any], None] = None, method: str = "GET", json: Union[Dict[str, Any], None] = None) -> Dict[str, Any]: