universal-mcp-applications 0.1.20__py3-none-any.whl → 0.1.22__py3-none-any.whl

universal_mcp/applications/openai/app.py

@@ -1,6 +1,9 @@
 import base64
 from typing import Any, Literal
 
+from universal_mcp.applications.application import APIApplication
+from universal_mcp.integrations import Integration
+
 from openai import NOT_GIVEN, AsyncOpenAI, OpenAIError
 from openai._types import FileTypes as OpenAiFileTypes
 from openai.types import FilePurpose as OpenAiFilePurpose
@@ -15,8 +18,6 @@ from openai.types.audio_model import AudioModel as OpenAiAudioModel
 from openai.types.chat import ChatCompletionMessageParam
 from openai.types.file_object import FileObject
 from openai.types.image_model import ImageModel as OpenAiImageModel
-from universal_mcp.applications.application import APIApplication
-from universal_mcp.integrations import Integration
 
 
 class OpenaiApp(APIApplication):
@@ -62,7 +63,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Generates a model response for a chat conversation. It supports both standard and streaming modes; if streaming, it internally aggregates response chunks into a single complete object, simplifying stream handling. Returns the completion data as a dictionary on success or an error string on failure.
-        
+
         Args:
             messages: A list of messages comprising the conversation so far.
             model: ID of the model to use. Defaults to "gpt-4o".
@@ -79,12 +80,12 @@ class OpenaiApp(APIApplication):
             presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far.
             stop: Up to 4 sequences where the API will stop generating further tokens.
             user: A unique identifier representing your end-user.
-        
+
         Returns:
             A dictionary containing the chat completion response on success,
             or a string containing an error message on failure.
             If stream=True, usage data in the response will be None.
-        
+
         Tags:
             chat, llm, important
         """
@@ -164,16 +165,16 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Uploads a file to the user's OpenAI account for use across various endpoints like 'assistants'. It accepts a file path or object and a purpose string, returning a dictionary with the created file object's details upon success.
-        
+
         Args:
             file: The File object (not file name) or path to be uploaded.
                   Can be bytes, a PathLike object, or a file-like object.
             purpose: The intended purpose of the uploaded file (e.g., 'fine-tune', 'assistants').
-        
+
         Returns:
             A dictionary containing the file object details on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             files, upload, storage
         """
@@ -195,17 +196,17 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Retrieves a paginated list of files uploaded to the OpenAI account. Allows filtering by purpose and controlling the output with limit, `after` cursor, and sort order parameters to efficiently navigate through the file collection.
-        
+
         Args:
             purpose: Only return files with the given purpose.
             limit: A limit on the number of objects to be returned.
             after: A cursor for use in pagination.
             order: Sort order by the `created_at` timestamp.
-        
+
         Returns:
             A dictionary representing a page of file objects on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             files, list, storage
         """
@@ -231,14 +232,14 @@ class OpenaiApp(APIApplication):
     async def retrieve_file_metadata(self, file_id: str) -> dict[str, Any] | str:
         """
         Retrieves the metadata (e.g., purpose, creation date) for a specific file from the OpenAI account using its ID. Unlike `retrieve_file_content`, this function does not download the file's contents. It returns a dictionary with file details on success or an error string on failure.
-        
+
         Args:
             file_id: The ID of the file to retrieve.
-        
+
         Returns:
             A dictionary containing the file object details on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             files, retrieve, storage
         """
@@ -256,14 +257,14 @@ class OpenaiApp(APIApplication):
     async def delete_file(self, file_id: str) -> dict[str, Any] | str:
         """
         Permanently deletes a file from the user's OpenAI account using its unique file ID. This action is irreversible. It returns a dictionary confirming the deletion on success or an error message string on failure. This is the 'delete' operation in the file management lifecycle.
-        
+
         Args:
             file_id: The ID of the file to delete.
-        
+
         Returns:
             A dictionary containing the deletion status on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             files, delete, storage
         """
@@ -279,14 +280,14 @@ class OpenaiApp(APIApplication):
     async def retrieve_file_content(self, file_id: str) -> dict[str, Any] | str:
         """
         Retrieves a file's content from OpenAI using its ID. It returns plain text for common text formats (e.g., JSON, CSV). For binary or undecodable files, it returns a dictionary with base64-encoded data, differentiating it from `retrieve_file` which only fetches metadata.
-        
+
         Args:
             file_id: The ID of the file whose content to retrieve.
-        
+
         Returns:
             The file content as a string if text, a dictionary with base64 encoded
             content if binary, or an error message string on failure.
-        
+
         Tags:
             files, content, download
         """
@@ -347,7 +348,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Generates new images from a textual prompt using OpenAI's DALL-E models. It allows customization of parameters like image size, quality, style, and response format (URL or base64 JSON). Unlike other image functions in this class, it creates images entirely from scratch based on text.
-        
+
         Args:
             prompt: A text description of the desired image(s).
             model: The model to use for image generation. Defaults to "dall-e-3".
@@ -364,11 +365,11 @@ class OpenaiApp(APIApplication):
                   For "dall-e-3": "1024x1024", "1792x1024", or "1024x1792".
             style: The style of the generated images ("vivid" or "natural"). Only for "dall-e-3".
             user: A unique identifier representing your end-user.
-        
+
         Returns:
             A dictionary containing the image generation response on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             images, generate, dalle, important
         """
@@ -416,7 +417,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Modifies a source image using the DALL-E 2 model based on a text prompt. An optional mask can be supplied to specify the exact area for editing. This function is distinct from generating images from scratch (`generate_image`) or creating simple variations (`create_image_variation`).
-        
+
         Args:
             image: The image to edit. Must be a valid PNG file, less than 4MB, and square.
             prompt: A text description of the desired image(s).
@@ -427,11 +428,11 @@ class OpenaiApp(APIApplication):
             response_format: The format of the returned images ("url" or "b64_json"). Defaults to "url".
             size: The size of the generated images. Must be one of "256x256", "512x512", or "1024x1024".
             user: A unique identifier representing your end-user.
-        
+
         Returns:
             A dictionary containing the image edit response on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             images, edit, dalle
         """
@@ -469,7 +470,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Generates one or more variations of a provided image using the OpenAI API, specifically the DALL-E 2 model. It allows customization of the number, size, and response format of the resulting images. Returns a dictionary with image data on success or an error string on failure.
-        
+
         Args:
             image: The image to use as the basis for the variation(s). Must be a valid PNG file.
             model: The model to use. Defaults to "dall-e-2", which is currently the only
@@ -478,11 +479,11 @@ class OpenaiApp(APIApplication):
             response_format: The format of the returned images ("url" or "b64_json"). Defaults to "url".
             size: The size of the generated images. Must be one of "256x256", "512x512", or "1024x1024".
             user: A unique identifier representing your end-user.
-        
+
         Returns:
             A dictionary containing the image variation response on success,
             or a string containing an error message on failure.
-        
+
         Tags:
             images, variation, dalle
         """
@@ -522,7 +523,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Transcribes an audio file into text in its original language using models like Whisper or GPT-4o. It supports multiple response formats and internally aggregates streaming data into a final object. This differs from `create_translation`, which translates audio specifically into English text.
-        
+
         Args:
             file: The audio file object (not file name) to transcribe.
             model: ID of the model to use (e.g., "whisper-1", "gpt-4o-transcribe").
@@ -538,12 +539,12 @@ class OpenaiApp(APIApplication):
                      Only works with response_format="json" and gpt-4o models.
             stream: If True, streams the response. The method will aggregate the stream
                     into a final response object. Streaming is not supported for "whisper-1".
-        
+
         Returns:
             A dictionary containing the transcription or a string, depending on `response_format`.
             If `stream` is True, an aggregated response dictionary.
             Returns an error message string on failure.
-        
+
         Tags:
             audio, transcription, speech-to-text, important
         """
@@ -615,18 +616,18 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Translates audio from any supported language into English text using OpenAI's API. Unlike `create_transcription`, which converts audio to text in its original language, this function's output is always English. It supports various response formats like JSON, text, or SRT for the translated content.
-        
+
         Args:
             file: The audio file object (not file name) to translate.
             model: ID of the model to use (currently, only "whisper-1" is supported).
             prompt: Optional text to guide the model's style (should be in English).
             response_format: The format of the translated text.
             temperature: Sampling temperature between 0 and 1.
-        
+
         Returns:
             A dictionary containing the translation or a string, depending on `response_format`.
             Returns an error message string on failure.
-        
+
         Tags:
             audio, translation, speech-to-text
         """
@@ -681,7 +682,7 @@ class OpenaiApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Generates audio from input text using a specified TTS model and voice. This text-to-speech function allows customizing audio format and speed. On success, it returns a dictionary containing the base64-encoded audio content and its corresponding MIME type, or an error string on failure.
-        
+
         Args:
             input_text: The text to generate audio for (max 4096 characters).
             model: The TTS model to use (e.g., "tts-1", "tts-1-hd", "gpt-4o-mini-tts").
@@ -689,12 +690,12 @@ class OpenaiApp(APIApplication):
             response_format: The format of the audio ("mp3", "opus", "aac", "flac", "wav", "pcm"). Defaults to "mp3".
             speed: Speed of the generated audio (0.25 to 4.0). Defaults to 1.0.
             instructions: Control voice with additional instructions (not for tts-1/tts-1-hd).
-        
-        
+
+
         Returns:
             A dictionary containing the base64 encoded audio content and content type,
             or an error message string on failure.
-        
+
         Tags:
             audio, speech, text-to-speech, tts, important
         """

universal_mcp/applications/outlook/app.py

@@ -19,19 +19,19 @@ class OutlookApp(APIApplication):
     ) -> Any:
         """
         Replies to an email using its message ID, with either a simple comment or a full message object including attachments. Unlike `send_mail`, which creates a new email, this function targets an existing message. It defaults to the current user if no user ID is specified.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             message_id (string): message-id
             comment (string): A comment to include in the reply. Example: 'Thank you for your email. Here is my reply.'.
             message (object): A message object to specify additional properties for the reply, such as attachments. Example: {'subject': 'RE: Project Update', 'body': {'contentType': 'Text', 'content': 'Thank you for the update. Looking forward to the next steps.'}, 'toRecipients': [{'emailAddress': {'address': 'alice@contoso.com'}}], 'attachments': [{'@odata.type': '#microsoft.graph.fileAttachment', 'name': 'agenda.pdf', 'contentType': 'application/pdf', 'contentBytes': 'SGVsbG8gV29ybGQh'}]}.
-        
+
         Returns:
             Any: Success
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.message, important
         """
@@ -71,18 +71,18 @@ class OutlookApp(APIApplication):
     ) -> Any:
         """
         Sends a new email on behalf of a specified or current user, using a dictionary for content like recipients and subject. Unlike `reply_to_message`, which replies to an existing message, this function composes and sends an entirely new email from scratch.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             message (object): message Example: {'subject': 'Meet for lunch?', 'body': {'contentType': 'Text', 'content': 'The new cafeteria is open.'}, 'toRecipients': [{'emailAddress': {'address': 'frannis@contoso.com'}}], 'ccRecipients': [{'emailAddress': {'address': 'danas@contoso.com'}}], 'bccRecipients': [{'emailAddress': {'address': 'bccuser@contoso.com'}}], 'attachments': [{'@odata.type': '#microsoft.graph.fileAttachment', 'name': 'attachment.txt', 'contentType': 'text/plain', 'contentBytes': 'SGVsbG8gV29ybGQh'}]}.
             saveToSentItems (boolean): saveToSentItems Example: 'False'.
-        
+
         Returns:
             Any: Success
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.user.Actions, important
         """
@@ -122,20 +122,20 @@ class OutlookApp(APIApplication):
     ) -> Any:
         """
         Retrieves a specific mail folder's metadata by its ID for a given user. The response can be customized to include hidden folders or select specific properties. Unlike `list_user_messages`, this function fetches folder details, not the emails contained within it.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             mailFolder_id (string): mailFolder-id
             includeHiddenFolders (string): Include Hidden Folders
             select (array): Select properties to be returned
             expand (array): Expand related entities
-        
+
         Returns:
             Any: Retrieved navigation property
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.mailFolder, important
         """
@@ -177,7 +177,7 @@ class OutlookApp(APIApplication):
     ) -> dict[str, Any]:
         """
         Retrieves a list of messages from a user's mailbox. This function supports powerful querying using optional parameters for filtering, searching, sorting, and pagination, unlike `get_user_message`, which fetches a single email by its ID.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             select (list): Select properties to be returned. Defaults to ['bodyPreview'].
@@ -196,13 +196,13 @@ class OutlookApp(APIApplication):
             count (boolean): Include count of items
             orderby (array): Order items by property values
             expand (array): Expand related entities
-        
+
         Returns:
             dict[str, Any]: Retrieved collection
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.message, important
         """
@@ -251,20 +251,20 @@ class OutlookApp(APIApplication):
     ) -> Any:
         """
         Retrieves a specific email message by its ID for a given user, with options to select specific fields or expand related data. Unlike `list_user_messages`, which fetches a collection of emails with advanced filtering, this function is designed to retrieve a single, known message.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             message_id (string): message-id
             includeHiddenMessages (string): Include Hidden Messages
             select (array): Select properties to be returned
             expand (array): Expand related entities
-        
+
         Returns:
             Any: Retrieved navigation property
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.message, important
         """
@@ -294,17 +294,17 @@ class OutlookApp(APIApplication):
     def user_delete_message(self, message_id: str, user_id: str | None = None) -> Any:
         """
         Permanently deletes a specific email, identified by `message_id`, from a user's mailbox. If `user_id` is not provided, it defaults to the current authenticated user. Unlike retrieval functions such as `get_user_message`, this performs a destructive action to remove the specified email from Outlook.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             message_id (string): message-id
-        
+
         Returns:
             Any: Success
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.message, important
         """
@@ -338,7 +338,7 @@ class OutlookApp(APIApplication):
     ) -> dict[str, Any]:
         """
         Retrieves attachments for a specific email message, identified by its ID. Supports advanced querying for filtering, sorting, and pagination, allowing users to select specific fields to return in the result set, focusing only on attachments rather than the full message content.
-        
+
         Args:
             user_id (string, optional): user-id. If not provided, will automatically get the current user's ID.
             message_id (string): message-id
@@ -350,13 +350,13 @@ class OutlookApp(APIApplication):
             orderby (array): Order items by property values
             select (array): Select properties to be returned
             expand (array): Expand related entities
-        
+
         Returns:
             dict[str, Any]: Retrieved collection
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             users.message, important
         """
@@ -393,14 +393,14 @@ class OutlookApp(APIApplication):
     ) -> dict[str, Any]:
         """
         Fetches the `userPrincipalName` for the currently authenticated user from the `/me` endpoint. This internal helper is used by other methods to automatically obtain the user's ID for API calls when a `user_id` is not explicitly provided.
-        
-        
+
+
         Returns:
             dict[str, Any]: Current user information
-        
+
         Raises:
             HTTPStatusError: Raised when the API request fails with detailed error information including status code and response body.
-        
+
         Tags:
             me, important
         """

universal_mcp/applications/perplexity/app.py

@@ -25,20 +25,20 @@ class PerplexityApp(APIApplication):
     ) -> dict[str, Any] | str:
         """
         Queries the Perplexity Chat Completions API for a web-search-grounded answer. It sends the user's prompt and model parameters to the `/chat/completions` endpoint, then parses the response to return the synthesized content and a list of supporting source citations, ideal for real-time information retrieval.
-        
+
         Args:
             query: The search query or question to ask. For example: "What are the latest developments in AI regulation?"
             model: The Perplexity model to use.
             temperature: Controls randomness in the model's output. Higher values make the output more random, lower values make it more deterministic. Defaults to 1.
             system_prompt: The initial system message to guide the model's behavior.
-        
+
         Returns:
             A dictionary containing the generated 'content' (str) and a list of 'citations' (list) from the web search.
-        
+
         Raises:
             AuthenticationError: Raised when API authentication fails due to missing or invalid credentials.
             HTTPError: Raised when the API request fails or returns an error status.
-        
+
         Tags:
             search, web, research, citations, current events, important
         """