arcade-mcp/toolkits/google_maps/arcade_google_maps/tools/google_maps.py
Eric Gustin 07c52100f3
Split and rename multiple toolkits (#438)
# PR Description
## Split toolkits

This PR splits the `Microsoft`, `Google`, and `Search` toolkits into
multiple toolkits each.
 * `Microsoft` --> `OutlookCalendar`, `OutlookMail`.
* `Google` -----> `GoogleCalendar`, `GoogleContacts`, `GoogleDocs`,
`GoogleDrive`, `Gmail`, `GoogleSheets`
* `Search` -----> `GoogleFinance`, `GoogleFlights`, `GoogleHotels`,
`GoogleJobs`, `GoogleMaps`, `GoogleNews`, `GoogleSearch`,
`GoogleShopping`, `Walmart`, `Youtube`

> The original monolithic toolkits (`Microsoft`, `Google`, `Search`) are
not removed in this PR. The plan is to keep those toolkits around while
we
> 1. Stop documenting the toolkits, 
> 2. Stop displaying the toolkits in the dashboard, and 
> 3. Help customers migrate over to the new split toolkits.

## Rename toolkits
This PR renames the following toolkits 
* `Web` ------------> `Firecrawl`
* `CodeSandbox` ---> `E2B`

> The `Web` and `CodeSandbox` toolkits are not removed in this PR. The
plan is to keep them around while we
> 1. Stop documenting the toolkits, 
> 2. Stop displaying the toolkits in the dashboard, and 
> 3. Help customers migrate over to the new renamed toolkits.

## Rename tools
Since toolkit names were changed, this called for some tools to be
renamed as well.
* `GoogleSearch.SearchGoogle` ----------------> `GoogleSearch.Search`
* `GoogleShopping.SearchShoppingProducts` --->
`GoogleShopping.SearchProducts`
* `Walmart.SearchWalmartProducts` ------------> `Walmart.SearchProducts`
* `Walmart.GetWalmartProductDetails` --------->
`Walmart.GetProductDetails`
* `Youtube.SearchYoutubeVideos` -------------->
`Youtube.SearchForVideos`

## Google File Picker
Improvements to the Google File Picker experience were also added in
this PR.

The following tools will ALWAYS provide llm_instructions in their
response to "let the end-user know that they have the option to select
more files via the file picker url if they want to":
* `GoogleDocs.SearchDocuments`
* `GoogleDocs.SearchAndRetrieveDocuments`
* `GoogleDrive.GetFileTreeStructure`

The following tools will only provide the file picker URL if a 404 or
403 from the Google API:
* `GoogleDocs.InsertTextAtEndOfDocument`
* `GoogleDocs.GetDocumentById`
* `GoogleSheets.GetSpreadsheet`
* `GoogleSheets.WriteToCell`

Also, a standalone `GoogleDrive.GenerateGoogleFilePickerUrl` tool
exists.

## Other
* The `SearchDocuments` and `SearchAndRetrieveDocuments` tools used to
be organized within the Drive portion of the Google toolkit, but I moved
these into the new GoogleDocs toolkit because they are specific to Docs.

# Progress

- [x] `OutlookCalendar`
- [x] `OutlookMail`
- [x] `GoogleFinance`
- [x] `GoogleFlights`
- [x] `GoogleHotels`
- [x] `GoogleJobs`
- [x] `GoogleMaps`
- [x] `GoogleNews`
- [x] `GoogleSearch`
- [x] `GoogleShopping`
- [x] `Walmart`
- [x] `Youtube`
- [x] `GoogleCalendar`
- [x] `GoogleContacts`
- [x] `GoogleDocs`
- [x] `GoogleDrive`
- [x] `Gmail`
- [x] `GoogleSheets`
- [x] `Firecrawl`
- [x] `E2B`
- [x] File picker

# Discussion
* Repeated code is a consequence of splitting toolkits that use the same
provider. I am open to any ideas that would allow multiple toolkits to
reference common code. Comment your ideas in this PR.
2025-07-09 16:00:09 -07:00

100 lines
3.8 KiB
Python

from typing import Annotated
from arcade_tdk import ToolContext, tool
from arcade_google_maps.constants import (
DEFAULT_GOOGLE_MAPS_COUNTRY,
DEFAULT_GOOGLE_MAPS_DISTANCE_UNIT,
DEFAULT_GOOGLE_MAPS_LANGUAGE,
DEFAULT_GOOGLE_MAPS_TRAVEL_MODE,
)
from arcade_google_maps.enums import GoogleMapsDistanceUnit, GoogleMapsTravelMode
from arcade_google_maps.utils import get_google_maps_directions
@tool(requires_secrets=["SERP_API_KEY"])
async def get_directions_between_addresses(
context: ToolContext,
origin_address: Annotated[
str, "The origin address. Example: '123 Main St, New York, NY 10001'"
],
destination_address: Annotated[
str, "The destination address. Example: '456 Main St, New York, NY 10001'"
],
language: Annotated[
str,
"2-character language code to use in the Google Maps search. "
f"Defaults to '{DEFAULT_GOOGLE_MAPS_LANGUAGE}'.",
] = DEFAULT_GOOGLE_MAPS_LANGUAGE,
country: Annotated[
str | None,
"2-character country code to use in the Google Maps search. "
f"Defaults to '{DEFAULT_GOOGLE_MAPS_COUNTRY}'.",
] = DEFAULT_GOOGLE_MAPS_COUNTRY,
distance_unit: Annotated[
GoogleMapsDistanceUnit,
f"Distance unit to use in the Google Maps search. Defaults to "
f"'{DEFAULT_GOOGLE_MAPS_DISTANCE_UNIT}'.",
] = DEFAULT_GOOGLE_MAPS_DISTANCE_UNIT,
travel_mode: Annotated[
GoogleMapsTravelMode,
f"Travel mode to use in the Google Maps search. Defaults to "
f"'{DEFAULT_GOOGLE_MAPS_TRAVEL_MODE}'.",
] = DEFAULT_GOOGLE_MAPS_TRAVEL_MODE,
) -> Annotated[dict, "The directions from Google Maps"]:
"""Get directions from Google Maps."""
return {
"directions": get_google_maps_directions(
context=context,
origin_address=origin_address,
destination_address=destination_address,
language=language,
country=country,
distance_unit=distance_unit,
travel_mode=travel_mode,
),
}
@tool(requires_secrets=["SERP_API_KEY"])
async def get_directions_between_coordinates(
context: ToolContext,
origin_latitude: Annotated[str, "The origin latitude. E.g. '40.7128'"],
origin_longitude: Annotated[str, "The origin longitude. E.g. '-74.0060'"],
destination_latitude: Annotated[str, "The destination latitude. E.g. '40.7128'"],
destination_longitude: Annotated[str, "The destination longitude. E.g. '-74.0060'"],
language: Annotated[
str,
"2-letter language code to use in the Google Maps search. "
f"Defaults to '{DEFAULT_GOOGLE_MAPS_LANGUAGE}'.",
] = DEFAULT_GOOGLE_MAPS_LANGUAGE,
country: Annotated[
str | None,
f"2-letter country code to use in the Google Maps search. Defaults to "
f"'{DEFAULT_GOOGLE_MAPS_COUNTRY}'.",
] = DEFAULT_GOOGLE_MAPS_COUNTRY,
distance_unit: Annotated[
GoogleMapsDistanceUnit,
f"Distance unit to use in the Google Maps search. Defaults to "
f"'{DEFAULT_GOOGLE_MAPS_DISTANCE_UNIT}'.",
] = DEFAULT_GOOGLE_MAPS_DISTANCE_UNIT,
travel_mode: Annotated[
GoogleMapsTravelMode,
f"Travel mode to use in the Google Maps search. Defaults to "
f"'{DEFAULT_GOOGLE_MAPS_TRAVEL_MODE}'.",
] = DEFAULT_GOOGLE_MAPS_TRAVEL_MODE,
) -> Annotated[dict, "The directions from Google Maps"]:
"""Get directions from Google Maps."""
return {
"directions": get_google_maps_directions(
context=context,
origin_latitude=origin_latitude,
origin_longitude=origin_longitude,
destination_latitude=destination_latitude,
destination_longitude=destination_longitude,
language=language,
country=country,
distance_unit=distance_unit,
travel_mode=travel_mode,
),
}