universal-mcp 0.1.8rc4__py3-none-any.whl → 0.1.9__py3-none-any.whl

universal_mcp/applications/falai/README.md

@@ -0,0 +1,42 @@
+
+# Falai MCP Server
+
+An MCP Server for the Falai API.
+
+## Supported Integrations
+
+- AgentR
+- API Key (Coming Soon)
+- OAuth (Coming Soon)
+
+## Tools
+
+This is automatically generated from OpenAPI schema for the Falai API.
+
+## Supported Integrations
+
+This tool can be integrated with any service that supports HTTP requests.
+
+## Tool List
+
+| Tool | Description |
+|------|-------------|
+| run | Run a Fal AI application directly and wait for the result. Suitable for short-running applications with synchronous execution from the caller's perspective. |
+| submit | Submits a request to the Fal AI queue for asynchronous processing and returns a request ID for tracking the job. |
+| status | Checks the status of a previously submitted Fal AI request and retrieves its current execution state |
+| result | Retrieves the result of a completed Fal AI request, waiting for completion if the request is still running. |
+| cancel | Asynchronously cancels a running or queued Fal AI request. |
+| upload_file | Uploads a local file to the Fal CDN and returns its public URL |
+| generate_image | Asynchronously generates images using the 'fal-ai/flux/dev' application with customizable parameters and default settings |
+
+
+## Usage
+
+- Login to AgentR
+- Follow the quickstart guide to setup MCP Server for your client
+- Visit Apps Store and enable the Falai app
+- Restart the MCP Server
+
+### Local Development
+
+- Follow the README to test with the local MCP Server

universal_mcp/applications/falai/app.py

@@ -0,0 +1,332 @@
+from pathlib import Path
+from typing import Any, Literal
+
+from fal_client import AsyncClient, AsyncRequestHandle, Status
+from loguru import logger
+
+from universal_mcp.applications import APIApplication
+from universal_mcp.exceptions import NotAuthorizedError, ToolError
+from universal_mcp.integrations import Integration
+
+Priority = Literal["normal", "low"]
+
+
+class FalaiApp(APIApplication):
+    """
+    Application for interacting with the Fal AI platform.
+
+    Provides tools to run, submit, check status, retrieve results, cancel jobs,
+    upload files to the Fal CDN, and a specialized tool for generating images.
+
+    Authentication is handled by the configured Integration provided by the
+    Universal MCP server, fetching the necessary API key.
+    """
+
+    def __init__(self, integration: Integration, **kwargs) -> None:
+        super().__init__(name="falai", integration=integration, **kwargs)
+        self._fal_client = None
+
+    @property
+    def fal_client(self) -> AsyncClient:
+        if self._fal_client is None:
+            credentials = self.integration.get_credentials()
+            if isinstance(credentials, dict) and "api_key" in credentials:
+                fal_api_key = credentials["api_key"]
+            else:
+                logger.error(
+                    f"Integration {type(self.integration).__name__} returned credentials in unexpected format."
+                )
+                raise ValueError(
+                    "Integration did not provide credentials in the expected 'api_key' format."
+                )
+            if not fal_api_key:
+                raise NotAuthorizedError(
+                    "Integration returned empty or invalid API key."
+                )
+            self._fal_client = AsyncClient(key=fal_api_key)
+        return self._fal_client
+
+    async def run(
+        self,
+        arguments: Any,
+        application: str = "fal-ai/flux/dev",
+        path: str = "",
+        timeout: float | None = None,
+        hint: str | None = None,
+    ) -> Any:
+        """
+        Run a Fal AI application directly and wait for the result. Suitable for short-running applications with synchronous execution from the caller's perspective.
+
+        Args:
+            arguments: A dictionary of arguments for the application
+            application: The name or ID of the Fal application (defaults to 'fal-ai/flux/dev')
+            path: Optional subpath for the application endpoint
+            timeout: Optional timeout in seconds for the request
+            hint: Optional hint for runner selection
+
+        Returns:
+            The result of the application execution as a Python object (converted from JSON response)
+
+        Raises:
+            ToolError: Raised when the Fal API request fails, wrapping the original exception
+
+        Tags:
+            run, execute, ai, synchronous, fal, important
+        """
+        try:
+            result = await self.fal_client.run(
+                application=application,
+                arguments=arguments,
+                path=path,
+                timeout=timeout,
+                hint=hint,
+            )
+            return result
+        except Exception as e:
+            logger.error(
+                f"Error running Fal application {application}: {e}", exc_info=True
+            )
+            raise ToolError(f"Failed to run Fal application {application}: {e}") from e
+
+    async def submit(
+        self,
+        arguments: Any,
+        application: str = "fal-ai/flux/dev",
+        path: str = "",
+        hint: str | None = None,
+        webhook_url: str | None = None,
+        priority: Priority | None = None,
+    ) -> str:
+        """
+        Submits a request to the Fal AI queue for asynchronous processing and returns a request ID for tracking the job.
+
+        Args:
+            arguments: A dictionary of arguments for the application
+            application: The name or ID of the Fal application, defaulting to 'fal-ai/flux/dev'
+            path: Optional subpath for the application endpoint
+            hint: Optional hint for runner selection
+            webhook_url: Optional URL to receive a webhook when the request completes
+            priority: Optional queue priority ('normal' or 'low')
+
+        Returns:
+            The request ID (str) of the submitted asynchronous job
+
+        Raises:
+            ToolError: Raised when the Fal API request fails, wrapping the original exception
+
+        Tags:
+            submit, async_job, start, ai, queue
+        """
+        try:
+            handle: AsyncRequestHandle = await self.fal_client.submit(
+                application=application,
+                arguments=arguments,
+                path=path,
+                hint=hint,
+                webhook_url=webhook_url,
+                priority=priority,
+            )
+            request_id = handle.request_id
+            return request_id
+        except Exception as e:
+            logger.error(
+                f"Error submitting Fal application {application}: {e}", exc_info=True
+            )
+            raise ToolError(
+                f"Failed to submit Fal application {application}: {e}"
+            ) from e
+
+    async def status(
+        self,
+        request_id: str,
+        application: str = "fal-ai/flux/dev",
+        with_logs: bool = False,
+    ) -> Status:
+        """
+        Checks the status of a previously submitted Fal AI request and retrieves its current execution state
+
+        Args:
+            request_id: The unique identifier of the submitted request, obtained from a previous submit operation
+            application: The name or ID of the Fal application (defaults to 'fal-ai/flux/dev')
+            with_logs: Boolean flag to include execution logs in the status response (defaults to False)
+
+        Returns:
+            A Status object containing the current state of the request (Queued, InProgress, or Completed)
+
+        Raises:
+            ToolError: Raised when the Fal API request fails or when the provided request ID is invalid
+
+        Tags:
+            status, check, async_job, monitoring, ai
+        """
+        try:
+            handle = self.fal_client.get_handle(
+                application=application, request_id=request_id
+            )
+            status = await handle.status(with_logs=with_logs)
+            return status
+        except Exception as e:
+            logger.error(
+                f"Error getting status for Fal request_id {request_id}: {e}",
+                exc_info=True,
+            )
+            raise ToolError(
+                f"Failed to get status for Fal request_id {request_id}: {e}"
+            ) from e
+
+    async def result(
+        self, request_id: str, application: str = "fal-ai/flux/dev"
+    ) -> Any:
+        """
+        Retrieves the result of a completed Fal AI request, waiting for completion if the request is still running.
+
+        Args:
+            request_id: The unique identifier of the submitted request
+            application: The name or ID of the Fal application (defaults to 'fal-ai/flux/dev')
+
+        Returns:
+            The result of the application execution, converted from JSON response to Python data structures (dict/list)
+
+        Raises:
+            ToolError: When the Fal API request fails or the request does not complete successfully
+
+        Tags:
+            result, async-job, status, wait, ai
+        """
+        try:
+            handle = self.fal_client.get_handle(
+                application=application, request_id=request_id
+            )
+            result = await handle.get()
+            return result
+        except Exception as e:
+            logger.error(
+                f"Error getting result for Fal request_id {request_id}: {e}",
+                exc_info=True,
+            )
+            raise ToolError(
+                f"Failed to get result for Fal request_id {request_id}: {e}"
+            ) from e
+
+    async def cancel(
+        self, request_id: str, application: str = "fal-ai/flux/dev"
+    ) -> None:
+        """
+        Asynchronously cancels a running or queued Fal AI request.
+
+        Args:
+            request_id: The unique identifier of the submitted Fal AI request to cancel
+            application: The name or ID of the Fal application (defaults to 'fal-ai/flux/dev')
+
+        Returns:
+            None. The function doesn't return any value.
+
+        Raises:
+            ToolError: Raised when the cancellation request fails due to API errors or if the request cannot be cancelled
+
+        Tags:
+            cancel, async_job, ai, fal, management
+        """
+        try:
+            handle = self.fal_client.get_handle(
+                application=application, request_id=request_id
+            )
+            await handle.cancel()
+            return None
+        except Exception as e:
+            logger.error(
+                f"Error cancelling Fal request_id {request_id}: {e}", exc_info=True
+            )
+            raise ToolError(f"Failed to cancel Fal request_id {request_id}: {e}") from e
+
+    async def upload_file(self, path: str) -> str:
+        """
+        Uploads a local file to the Fal CDN and returns its public URL
+
+        Args:
+            path: The absolute or relative path to the local file
+
+        Returns:
+            A string containing the public URL of the uploaded file on the CDN
+
+        Raises:
+            ToolError: If the file is not found or if the upload operation fails
+
+        Tags:
+            upload, file, cdn, storage, async, important
+        """
+        try:
+            file_url = await self.fal_client.upload_file(Path(path))
+            return file_url
+        except FileNotFoundError as e:
+            logger.error(f"File not found for upload: {path}", exc_info=True)
+            raise ToolError(f"File not found: {path}") from e
+        except Exception as e:
+            logger.error(f"Error uploading file {path} to Fal CDN: {e}", exc_info=True)
+            raise ToolError(f"Failed to upload file {path}: {e}") from e
+
+    async def generate_image(
+        self,
+        prompt: str,
+        seed: int | None = 6252023,
+        image_size: str | None = "landscape_4_3",
+        num_images: int | None = 1,
+        extra_arguments: dict[str, Any] | None = None,
+        path: str = "",
+        timeout: float | None = None,
+        hint: str | None = None,
+    ) -> Any:
+        """
+        Asynchronously generates images using the 'fal-ai/flux/dev' application with customizable parameters and default settings
+
+        Args:
+            prompt: The text prompt used to guide the image generation
+            seed: Random seed for reproducible image generation (default: 6252023)
+            image_size: Dimensions of the generated image (default: 'landscape_4_3')
+            num_images: Number of images to generate in one request (default: 1)
+            extra_arguments: Additional arguments dictionary to pass to the application, can override defaults
+            path: Subpath for the application endpoint (rarely used)
+            timeout: Maximum time in seconds to wait for the request to complete
+            hint: Hint string for runner selection
+
+        Returns:
+            A dictionary containing the generated image URLs and related metadata
+
+        Raises:
+            ToolError: When the image generation request fails or encounters an error
+
+        Tags:
+            generate, image, ai, async, important, flux, customizable, default
+        """
+        application = "fal-ai/flux/dev"
+        arguments = {
+            "prompt": prompt,
+            "seed": seed,
+            "image_size": image_size,
+            "num_images": num_images,
+        }
+        if extra_arguments:
+            arguments.update(extra_arguments)
+            logger.debug(f"Merged extra_arguments. Final arguments: {arguments}")
+        try:
+            result = await self.run(
+                application=application,
+                arguments=arguments,
+                path=path,
+                timeout=timeout,
+                hint=hint,
+            )
+            return result
+        except Exception:
+            raise
+
+    def list_tools(self) -> list[callable]:
+        return [
+            self.run,
+            self.submit,
+            self.status,
+            self.result,
+            self.cancel,
+            self.upload_file,
+            self.generate_image,
+        ]

universal_mcp/applications/gong/README.md

@@ -0,0 +1,88 @@
+
+# Gong MCP Server
+
+An MCP Server for the Gong API.
+
+## Supported Integrations
+
+- AgentR
+- API Key (Coming Soon)
+- OAuth (Coming Soon)
+
+## Tools
+
+This is automatically generated from OpenAPI schema for the Gong API.
+
+## Supported Integrations
+
+This tool can be integrated with any service that supports HTTP requests.
+
+## Tool List
+
+| Tool | Description |
+|------|-------------|
+| list_calls | Retrieves a list of call records within the specified date range, with optional pagination and workspace filtering. |
+| add_call | Creates and submits a new call record with detailed metadata to the remote service. |
+| get_call | Retrieves details for a specific call by its identifier. |
+| list_calls_extensive | Retrieves a list of extensive call records matching the specified filter criteria, with optional pagination and content selection. |
+| get_permission_profile | Retrieve the details of a permission profile by its profile ID. |
+| update_permission_profile | Updates an existing permission profile with the specified access settings and permissions. |
+| create_permission_profile | Creates a new permission profile in the specified workspace with customizable access and permission settings. |
+| update_meeting | Updates the details of an existing meeting with new information such as time, invitees, and title. |
+| delete_meeting | Deletes a meeting by its ID, optionally specifying the organizer's email. |
+| content_viewed | Reports a content view event to the customer engagement system with detailed metadata about the event and content. |
+| content_shared | Reports a content sharing event to the customer engagement system with detailed metadata about the shared content, sharer, and recipients. |
+| custom_action | Submits a custom customer engagement action event with detailed reporting and context information to the server. |
+| list_generic_crm_integration | Retrieves a list of generic CRM integrations from the API. |
+| register_generic_crm_integration | Registers a generic CRM integration for a given owner email and integration name. |
+| delete_generic_crm_integration | Deletes a generic CRM integration using the provided integration and client request IDs. |
+| add_users_access_to_calls | Updates user access permissions for calls by sending a PUT request with the specified access list. |
+| get_users_access_to_calls | Retrieves user access information for calls based on the provided filter criteria. |
+| delete_users_access_to_calls | Deletes a list of users' access permissions to calls. |
+| list_multiple_users | Retrieves a list of users based on a provided filter and optional pagination cursor. |
+| list_interaction_stats | Retrieves interaction statistics based on specified filter criteria, with optional pagination support. |
+| list_answered_scorecards | Retrieves a paginated list of answered scorecards based on the provided filter criteria. |
+| list_multiple_users_day_by_day_activity | Retrieves day-by-day activity statistics for multiple users based on a provided filter. |
+| list_multiple_users_aggregate_activity | Aggregates and returns activity statistics for multiple users based on specified filters. |
+| list_multiple_users_aggregate_by_period | Aggregates activity statistics for multiple users over a specified period using given filter criteria. |
+| add_meeting | Creates a new meeting with the specified details and returns the server's response as a dictionary. |
+| integration_status | Retrieves the integration status for specified email addresses via the meetings API. |
+| integration_settings | Sends integration type settings to the integration settings API endpoint and returns the server's response as a dictionary. |
+| get_flows_for_prospects | Fetches flow data for the specified CRM prospect IDs from the API. |
+| assign_prospects | Assigns a list of CRM prospect IDs to a specified flow instance and owner via an API POST request. |
+| add_digital_interaction | Submits a digital interaction event record to the API with required metadata and content. |
+| purge_phone_number | Erases all data associated with the specified phone number via the data privacy API. |
+| purge_email_address | Permanently erases all data associated with the specified email address from the system. |
+| list_crm_schema_fields | Retrieves the schema fields for a specified CRM object type associated with a given integration. |
+| upload_crm_schema_field | Uploads CRM entity schema fields to the integration service for the specified CRM object type. |
+| get_crm_objects | Retrieves CRM objects by their CRM IDs from a specified integration and object type. |
+| get_call_transcripts | Retrieves call transcripts based on the specified filter and optional pagination cursor. |
+| list_workspaces | Retrieves a list of all available workspaces from the API. |
+| list_users | Retrieves a paginated list of users from the API, with optional filtering by cursor and inclusion of avatar data. |
+| get_user | Retrieves user information by user ID from the API. |
+| get_user_history | Retrieves the settings history for a specific user by user ID. |
+| list_trackers | Retrieves a list of trackers for the specified workspace from the API. |
+| list_scorecards | Retrieves a list of scorecard settings from the API. |
+| list_permission_profile_users | Retrieves a list of users associated with a specified permission profile. |
+| list_logs | Retrieves a list of logs for the specified log type and time range, with optional cursor-based pagination. |
+| get_library_structure | Retrieves the hierarchical structure of library folders, optionally filtered by workspace ID. |
+| get_calls_in_specific_folder | Retrieves the list of calls contained within a specified folder from the remote library API. |
+| list_flows | Retrieves a list of flows owned by the specified user, with optional pagination and workspace filtering. |
+| find_all_references_to_phone_number | Fetches all references to a specified phone number from the data privacy API. |
+| find_all_references_to_email_address | Finds and returns all data references associated with a given email address. |
+| get_request_status | Retrieves the status of a CRM request using the provided integration and client request IDs. |
+| list_crmcalls_manual_association | Retrieves a list of manually associated CRM call records, with optional filtering by date and pagination. |
+| list_permission_profile | Retrieves the list of permission profiles for the specified workspace. |
+
+
+
+## Usage
+
+- Login to AgentR
+- Follow the quickstart guide to setup MCP Server for your client
+- Visit Apps Store and enable the Gong app
+- Restart the MCP Server
+
+### Local Development
+
+- Follow the README to test with the local MCP Server