universal-mcp-applications 0.1.17__py3-none-any.whl → 0.1.33__py3-none-any.whl

universal_mcp/applications/google_searchconsole/app.py

@@ -16,15 +16,15 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def delete_sitemap(self, siteUrl: str, feedpath: str) -> None:
         """
-        Deletes a sitemap from a specified Google Search Console property. It targets the sitemap using the site's URL and the sitemap's `feedpath`, then issues an HTTP DELETE request. This action is distinct from `delete_site`, which removes the entire property, not just a sitemap.
-        
+        Deletes a specific sitemap from a Google Search Console property using its URL (`feedpath`). This function is distinct from `delete_site`, which removes the entire site property, not just a single sitemap file. It issues an HTTP DELETE request to the specified API endpoint.
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
             feedpath (str): The URL of the sitemap to delete. Example: 'http://www.example.com/sitemap.xml'.
-        
+
         Returns:
             None: If the request is successful.
-        
+
         Tags:
             sitemap_management
         """
@@ -38,15 +38,15 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def get_sitemap(self, siteUrl: str, feedpath: str) -> dict[str, Any]:
         """
-        Retrieves detailed information for a single, specific sitemap using its full URL (`feedpath`). Unlike `list_sitemaps`, which fetches all sitemaps for a site, this function targets and returns one sitemap resource, providing its status, last processed date, and other API metadata.
-        
+        Retrieves detailed information for a single sitemap from a specified Google Search Console property. Unlike `list_sitemaps` which fetches all sitemaps, this function targets one sitemap by its URL (`feedpath`) to return its resource details, including status and last processed date.
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
             feedpath (str): The URL of the sitemap to retrieve. Example: 'http://www.example.com/sitemap.xml'.
-        
+
         Returns:
             Dict[str, Any]: Sitemap resource.
-        
+
         Tags:
             sitemap_management
         """
@@ -62,16 +62,16 @@ class GoogleSearchconsoleApp(APIApplication):
         self, siteUrl: str, sitemapIndex: str | None = None
     ) -> dict[str, Any]:
         """
-        Retrieves a list of sitemaps submitted for a specific site. Optionally, it can list the sitemaps contained within a specified sitemap index file instead of all sitemaps for the site. This contrasts with get_sitemap, which fetches a single sitemap's details.
-        
+        Retrieves a list of sitemaps for a specific site property. It can optionally list sitemaps contained within a specified sitemap index file. This function contrasts with `get_sitemap`, which fetches details for only a single, specified sitemap rather than a collection.
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
             sitemapIndex (Optional[str]): The URL of the sitemap index.
                                           Example: 'http://www.example.com/sitemap_index.xml'.
-        
+
         Returns:
             Dict[str, Any]: List of sitemap resources.
-        
+
         Tags:
             sitemap_management, important
         """
@@ -88,15 +88,15 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def submit_sitemap(self, siteUrl: str, feedpath: str) -> None:
         """
-        Submits a sitemap to a specified Google Search Console site property. This function notifies Google of the sitemap's location for crawling via a PUT request. It is the primary action for adding or updating a sitemap, complementing `get_sitemap`, `list_sitemaps`, and `delete_sitemap`.
-        
+        Submits a sitemap to a specified Google Search Console property using its URL (feedpath). It notifies Google to crawl the sitemap's location, complementing other sitemap management functions (`list_sitemaps`, `delete_sitemap`) by adding or updating a sitemap's registration for a given site.
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
             feedpath (str): The URL of the sitemap to submit. Example: 'http://www.example.com/sitemap.xml'.
-        
+
         Returns:
             None: If the request is successful.
-        
+
         Tags:
             sitemap_management
         """
@@ -112,14 +112,14 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def add_site(self, siteUrl: str) -> dict[str, Any]:
         """
-        Adds a site to the user's Google Search Console account, which requires subsequent ownership verification. Upon success, it returns a dictionary containing the site resource. This method creates a new site entry, unlike `list_sites` which only retrieves existing ones.
-        
+        Adds a site property to the user's Google Search Console account using its URL. This action requires subsequent ownership verification. Unlike `list_sites`, which only retrieves existing properties, this function creates a new entry and returns the corresponding site resource upon successful creation.
+
         Args:
             siteUrl (str): The URL of the site to add. Example: 'http://www.example.com/'.
-        
+
         Returns:
             Dict[str, Any]: Site resource upon successful addition.
-        
+
         Tags:
             site_management, important
         """
@@ -134,14 +134,14 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def delete_site(self, siteUrl: str) -> None:
         """
-        Removes a website property from the user's Google Search Console account using its URL. This function sends a DELETE request to the API, distinguishing it from `delete_sitemap` which only removes a sitemap file rather than the entire site property from the user's management list.
-        
+        Removes a website property from the user's Google Search Console account using its URL. Unlike `delete_sitemap`, which only targets a sitemap file, this function deletes the entire site property, revoking management access and removing it from the user's list of managed sites.
+
         Args:
             siteUrl (str): The URL of the site to delete. Example: 'http://www.example.com/'.
-        
+
         Returns:
             None: If the request is successful.
-        
+
         Tags:
             site_management
         """
@@ -152,14 +152,14 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def get_site(self, siteUrl: str) -> dict[str, Any]:
         """
-        Retrieves the resource for a specific site property from Google Search Console, using its URL as an identifier. Unlike `list_sites`, which retrieves all user properties, this function fetches detailed information for a single, known site.
-        
+        Retrieves detailed information for a specific site property from Google Search Console using its URL. Unlike `list_sites`, which fetches all properties associated with the user's account, this function targets and returns the resource for a single, known site.
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
-        
+
         Returns:
             Dict[str, Any]: Site resource.
-        
+
         Tags:
             site_management
         """
@@ -171,11 +171,11 @@ class GoogleSearchconsoleApp(APIApplication):
 
     def list_sites(self) -> dict[str, Any]:
         """
-        Retrieves a list of all websites and domain properties the authenticated user can access in Google Search Console. Unlike `get_site`, which fetches a single property, this function returns a comprehensive overview of all managed sites associated with the user's account.
-        
+        Retrieves all websites and domain properties the authenticated user manages in Google Search Console. While `get_site` fetches a single, specific property, this function returns a comprehensive list of all sites linked to the user's account, providing a complete overview of managed properties.
+
         Returns:
             Dict[str, Any]: List of site resources.
-        
+
         Tags:
             site_management
         """
@@ -191,16 +191,16 @@ class GoogleSearchconsoleApp(APIApplication):
     ) -> dict[str, Any]:
         """
         Retrieves the Google Index status for a specified URL within a given Search Console property. This function queries the URL Inspection API to return detailed information about how Google sees the page, including its indexing eligibility and any detected issues.
-        
+
         Args:
             inspectionUrl (str): The URL to inspect. Example: 'https://www.example.com/mypage'.
             siteUrl (str): The site URL (property) to inspect the URL under.
                            Must be a property in Search Console. Example: 'sc-domain:example.com' or 'https://www.example.com/'.
             languageCode (Optional[str]): Optional. The BCP-47 language code for the inspection. Example: 'en-US'.
-        
+
         Returns:
             Dict[str, Any]: Inspection result containing details about the URL's indexing status.
-        
+
         Tags:
             url_inspection, indexing
         """
@@ -234,7 +234,7 @@ class GoogleSearchconsoleApp(APIApplication):
     ) -> dict[str, Any]:
         """
         Queries and retrieves search traffic data for a specified site within a given date range. Supports advanced filtering, grouping by various dimensions (e.g., query, page, device), and aggregation to customize the analytics report from the Google Search Console API.
-        
+
         Args:
             siteUrl (str): The site's URL, including protocol (e.g. 'http://www.example.com/').
             startDate (str): Start date of the requested period in YYYY-MM-DD format.
@@ -264,10 +264,10 @@ class GoogleSearchconsoleApp(APIApplication):
             search_type (Optional[str]): Filter by search type.
                 Example: "web", "image", "video", "news", "discover", "googleNews".
                 This corresponds to the 'type' parameter in the API.
-        
+
         Returns:
             Dict[str, Any]: Search analytics data.
-        
+
         Tags:
             search_analytics, reporting
         """

universal_mcp/applications/google_sheet/README.md

@@ -9,28 +9,28 @@ This is automatically generated from OpenAPI schema for the GoogleSheetApp API.
 
 | Tool | Description |
 |------|-------------|
-| `create_spreadsheet` | Creates a new blank Google Spreadsheet with the specified title and returns the API response. |
-| `get_spreadsheet` | Retrieves detailed information about a specific Google Spreadsheet using its ID  excluding cell data. |
-| `batch_get_values` | Retrieves multiple ranges of values from a Google Spreadsheet in a single batch request. |
-| `insert_dimensions` | Inserts new rows or columns into a Google Sheet at a specific position within the sheet. |
-| `append_dimensions` | Appends empty rows or columns to the end of a Google Sheet. |
-| `delete_dimensions` | Tool to delete specified rows or columns from a sheet in a google spreadsheet. use when you need to remove a range of rows or columns. |
-| `add_sheet` | Adds a new sheet (worksheet) to a spreadsheet. use this tool to create a new tab within an existing google sheet, optionally specifying its title, index, size, and other properties. |
-| `delete_sheet` | Tool to delete a sheet (worksheet) from a spreadsheet. use when you need to remove a specific sheet from a google sheet document. |
-| `add_basic_chart` | Adds a basic chart to a Google Spreadsheet like a column chart, bar chart, line chart and  area chart. |
-| `add_pie_chart` | Adds a pie chart to a Google Spreadsheet. |
-| `add_table` | Adds a table to a Google Spreadsheet. |
-| `update_table` | Updates an existing table in a Google Spreadsheet. |
-| `clear_values` | Clears all values from a specified range in a Google Spreadsheet while preserving cell formatting and other properties |
-| `update_values` | Updates cell values in a specified range of a Google Spreadsheet using the Sheets API |
-| `batch_update` | Updates a specified range in a google sheet with given values, or appends them as new rows if `first cell location` is omitted; ensure the target sheet exists and the spreadsheet contains at least one worksheet. |
-| `clear_basic_filter` | Tool to clear the basic filter from a sheet. use when you need to remove an existing basic filter from a specific sheet within a google spreadsheet. |
-| `list_tables` | This action is used to list all tables in a google spreadsheet, call this action to get the list of tables in a spreadsheet. discover all tables in a google spreadsheet by analyzing sheet structure and detecting data patterns. uses heuristic analysis to find header rows, data boundaries, and table structures. |
-| `get_values` | Retrieves values from a specific range in a Google Spreadsheet. |
-| `get_table_schema` | Analyzes table structure and infers column names, types, and constraints. |
-| `set_basic_filter` | Tool to set a basic filter on a sheet in a google spreadsheet. use when you need to filter or sort data within a specific range on a sheet. |
-| `copy_to_sheet` | Tool to copy a single sheet from a spreadsheet to another spreadsheet. Use when you need to duplicate a sheet into a different spreadsheet. |
-| `append_values` | Tool to append values to a spreadsheet. use when you need to add new data to the end of an existing table in a google sheet. |
-| `batch_clear_values` | Tool to clear one or more ranges of values from a spreadsheet. use when you need to remove data from specific cells or ranges while keeping formatting and other properties intact. |
-| `batch_get_values_by_data_filter` | Tool to return one or more ranges of values from a spreadsheet that match the specified data filters. use when you need to retrieve specific data sets based on filtering criteria rather than entire sheets or fixed ranges. |
-| `format_cells` | Applies comprehensive cell formatting to a specified range in a Google Sheets worksheet. |
+| `create_spreadsheet` | Creates a new, blank Google Spreadsheet file with a specified title. This function generates a completely new document, unlike `add_sheet` which adds a worksheet (tab) to an existing spreadsheet. It returns the API response containing the new spreadsheet's metadata. |
+| `get_spreadsheet_metadata` | Retrieves a spreadsheet's metadata and structural properties, such as sheet names, IDs, and named ranges, using its unique ID. This function intentionally excludes cell data, distinguishing it from `get_values` which fetches the actual content within cells. |
+| `get_values` | Retrieves cell values from a single, specified A1 notation range. Unlike `batch_get_values_by_range` which fetches multiple ranges, this function is for a singular query and provides options to control the data's output format (e.g., rows vs. columns, formatted vs. raw values). |
+| `batch_get_values_by_range` | Efficiently retrieves values from multiple predefined A1 notation ranges in a single API request. Unlike `get_values`, which fetches a single range, or `batch_get_values_by_data_filter`, which uses dynamic filtering criteria, this function operates on a simple list of range strings for bulk data retrieval. |
+| `insert_dimensions` | Inserts a specified number of empty rows or columns at a given index, shifting existing content. Distinct from `append_dimensions`, which only adds to the end, this function creates space within the sheet's data grid, preserving surrounding data and formatting. |
+| `append_dimensions` | Adds a specified number of empty rows or columns to the end of a designated sheet. Unlike `insert_dimensions`, which adds space at a specific index, this function exclusively extends the sheet's boundaries at the bottom or to the right without affecting existing content. |
+| `delete_dimensions` | Deletes a specified range of rows or columns, permanently removing them and shifting subsequent cells. This alters the sheet's structure, unlike `clear_values` which only removes cell content. It is the direct counterpart to `insert_dimensions`, which adds space within the data grid. |
+| `add_sheet` | Adds a new worksheet (tab) to an existing Google Spreadsheet. It allows extensive customization of the new sheet's properties, such as its title, position, and dimensions. This is distinct from `create_spreadsheet`, which generates a completely new spreadsheet file instead of modifying an existing one. |
+| `add_basic_chart` | Adds various axis-based charts (e.g., column, bar, line, area) to a spreadsheet from specified data ranges. The chart can be placed on a new sheet or positioned on an existing one. This is distinct from `add_pie_chart`, which creates proportional visualizations instead of axis-based charts. |
+| `add_pie_chart` | Adds a pie or donut chart to a Google Spreadsheet from a specified data range. Unlike the more general `add_basic_chart`, this is specialized for visualizing data as proportions of a whole and supports pie-specific options like creating a donut chart via the `pie_hole` parameter. |
+| `add_table` | Creates a structured table within a specified range on a Google Sheet. Defines the table's name, ID, and dimensions, and can optionally configure column properties like data types and validation rules. This action creates a formal table object, distinct from functions that only write cell values. |
+| `update_table` | Modifies properties of an existing table within a Google Sheet, such as its name, data range, or column specifications. This function updates the table's structural metadata, distinguishing it from `update_values` which alters the cell data within the table's range. |
+| `clear_values` | Clears data from a single, specified cell range while preserving all formatting. Unlike `delete_dimensions`, it only removes content, not the cells themselves. For clearing multiple ranges simultaneously, use the `batch_clear_values` function. |
+| `update_values` | Overwrites cell values within a specific A1 notation range using a provided 2D list. This function replaces existing data in a predefined area, distinguishing it from `append_values`, which adds new rows after a table instead of overwriting a specific block of cells. |
+| `batch_clear_values` | Clears cell values from multiple specified ranges in a single batch operation, preserving existing formatting. Unlike `clear_values`, which handles a single range, this method efficiently processes a list of ranges at once, removing only the content and not the cells themselves. |
+| `batch_get_values_by_data_filter` | Retrieves values from spreadsheet ranges matching a list of data filters. This method provides dynamic, criteria-based selection using A1 notation or grid coordinates, unlike `batch_get_values_by_range` which uses a simple list of range strings. It is ideal for fetching multiple, specific datasets in one request. |
+| `copy_sheet_to_spreadsheet` | Copies a specific sheet, including all its data and formatting, from a source spreadsheet to a different destination spreadsheet. This action duplicates an entire worksheet into another workbook, returning properties of the newly created sheet. |
+| `write_values_to_sheet` | Writes a 2D list of values to a sheet, overwriting existing data. Data is written starting from a specified cell, or defaults to cell A1 if no location is provided. This differs from `append_values`, which adds new rows after existing data without replacing content. |
+| `append_values` | Appends rows of data after a specified table in a Google Sheet. Distinct from `update_values` which overwrites data, this function adds new rows at the end of the table. It can also insert rows, shifting existing cells down, offering finer control over data addition. |
+| `clear_basic_filter` | Removes the basic filter from a specified sheet, clearing active sorting and filtering criteria to restore the default data view. As the direct counterpart to `set_basic_filter`, this function removes the entire filter object, not just the cell content. |
+| `delete_sheet` | Permanently deletes a specific sheet (worksheet) from a Google Spreadsheet using its sheet ID. This operation removes the target sheet and all its contents, acting as the direct counterpart to the `add_sheet` function which creates new sheets within a spreadsheet. |
+| `discover_tables` | Heuristically analyzes a spreadsheet to discover and list all table-like data structures, identifying headers and data boundaries. It returns informal data blocks meeting specified size criteria, distinguishing it from functions like `add_table` that manage formally defined tables. |
+| `analyze_table_schema` | Infers a specified table's schema by analyzing a data sample. After locating the table by name (a value discovered via `discover_tables`), this function determines the most likely data type and properties for each column, providing a detailed structural breakdown of its content. |
+| `set_basic_filter` | Sets or updates a basic filter on a specified range within a sheet, enabling data sorting and filtering. The filter's target range and optional sort specifications are defined in a dictionary argument. It is the counterpart to `clear_basic_filter`, which removes an existing filter. |
+| `format_cells` | Applies comprehensive formatting to a specified cell range in a worksheet. It modifies visual properties like text style, color, alignment, borders, and can merge cells, without altering the underlying cell values, distinguishing it from data-modification functions like `update_values`. |