CrewAI Integration
- -
-
-
- 
-
-
+ - Docs • - Servers • - Python Client • - JavaScript Client + Thank you for using crewai-arcade. We hope to see you using Arcade's new integrations!
- -## Overview - -`crewai-arcade` allows you to use Arcade tools in your CrewAI applications. - -## Installation - -```bash -pip install crewai-arcade -``` - -## Usage - -See the [examples](https://github.com/ArcadeAI/arcade-mcp/tree/main/examples/crewai) for usage examples diff --git a/contrib/crewai/crewai_arcade/__init__.py b/contrib/crewai/crewai_arcade/__init__.py index a46115ee..d864bc8f 100644 --- a/contrib/crewai/crewai_arcade/__init__.py +++ b/contrib/crewai/crewai_arcade/__init__.py @@ -1,3 +1,17 @@ -from .manager import ArcadeToolManager +import warnings -__all__ = ["ArcadeToolManager"] +warnings.warn( + "\n" + "=" * 70 + "\n" + "DEPRECATION NOTICE: crewai-arcade is no longer maintained.\n" + "\n" + "This package has been deprecated. Please visit https://docs.arcade.dev\n" + "for the latest documentation on integrating Arcade tools into your\n" + "applications.\n" + "\n" + "Arcade now supports MCP (Model Context Protocol) and direct API\n" + "integration via the Arcade Python SDK.\n" + "=" * 70, + DeprecationWarning, + stacklevel=2, +) + +__all__: list[str] = [] diff --git a/contrib/crewai/crewai_arcade/_utilities.py b/contrib/crewai/crewai_arcade/_utilities.py deleted file mode 100644 index f2e9702b..00000000 --- a/contrib/crewai/crewai_arcade/_utilities.py +++ /dev/null @@ -1,56 +0,0 @@ -from typing import Any - -from arcadepy.types import ToolDefinition -from pydantic import BaseModel, Field, create_model - -# Mapping of Arcade value types to Python types -TYPE_MAPPING = { - "string": str, - "number": float, - "integer": int, - "boolean": bool, - "array": list, - "json": dict, -} - - -def get_python_type(val_type: str) -> Any: - """Map Arcade value types to Python types. - - Args: - val_type: The value type as a string. - - Returns: - Corresponding Python type. - """ - _type = TYPE_MAPPING.get(val_type) - if _type is None: - raise ValueError(f"Invalid value type: {val_type}") - return _type - - -def tool_definition_to_pydantic_model(tool_def: ToolDefinition) -> type[BaseModel]: - """Convert a ToolDefinition's inputs into a Pydantic BaseModel. - - Args: - tool_def: The ToolDefinition object to convert. - - Returns: - A Pydantic BaseModel class representing the tool's input schema. - """ - try: - fields: dict[str, Any] = {} - for param in tool_def.input.parameters or []: - param_type = get_python_type(param.value_schema.val_type) - if param_type == list and param.value_schema.inner_val_type: # noqa: E721 - inner_type: type[Any] = get_python_type(param.value_schema.inner_val_type) - param_type = list[inner_type] # type: ignore[valid-type] - param_description = param.description or "No description provided." - default = ... if param.required else None - fields[param.name] = ( - param_type, - Field(default=default, description=param_description), - ) - return create_model(f"{tool_def.name}Args", **fields) - except ValueError as e: - raise ValueError(f"Error converting {tool_def.name} parameters into pydantic model: {e}") diff --git a/contrib/crewai/crewai_arcade/manager.py b/contrib/crewai/crewai_arcade/manager.py deleted file mode 100644 index f49965ee..00000000 --- a/contrib/crewai/crewai_arcade/manager.py +++ /dev/null @@ -1,363 +0,0 @@ -from collections.abc import Iterator -from typing import Any, Callable, Optional, Protocol - -from arcadepy import Arcade -from arcadepy.types import ToolDefinition -from arcadepy.types.shared import AuthorizationResponse - -from crewai_arcade._utilities import tool_definition_to_pydantic_model -from crewai_arcade.structured import StructuredTool - -TOOL_NAME_SEPARATOR = "_" - - -class ArcadeToolExecutorProtocol(Protocol): - """Protocol for Arcade tool executor callback.""" - - def __call__( - self, - manager: "ArcadeToolManager", - name: str, - **input: dict[str, Any], # noqa: A002 - ) -> Any: ... - - -class ArcadeToolManager: - """Arcade tool manager for CrewAI - - Wraps Arcade tools as CrewAI StructuredTools - """ - - def __init__( - self, - client: Optional[Arcade] = None, - executor: Optional[ArcadeToolExecutorProtocol] = None, - *, - default_user_id: Optional[str] = None, - **kwargs: dict[str, Any], - ) -> None: - """Initialize the ArcadeToolManager. - - Example: - >>> manager = ArcadeToolManager(default_user_id="me@example.com", api_key="...") - >>> - >>> # retrieve a specific Arcade tool as a CrewAI tool and add it to the manager - >>> manager.get_tools(tools=["Search.SearchGoogle"]) - >>> - >>> # retrieve all Arcade tools in a toolkit as CrewAI tools and add them to the manager - >>> manager.get_tools(toolkits=["Search"]) - >>> - >>> # retrieve all tools in the manager as CrewAI tools - >>> manager.get_tools() - >>> - >>> # clear and initialize new tools in the manager - >>> manager.init_tools(tools=["Search.SearchGoogle"], toolkits=["Search"]) - - Args: - client: Arcade client instance. - executor: Optional custom executor callback. Useful for customizing the authorization and execution flow. - default_user_id: The default user id used for tool authorization and execution - when no custom executor is provided. - **kwargs: Additional keyword arguments for the Arcade client if the client is not provided. - - Note: - If no executor is provided, `default_user_id` must be specified so that the default - executor can call authorize and execute with that id. - """ - if not client: - api_key = kwargs.get("api_key") - base_url = kwargs.get("base_url") - arcade_kwargs = {"api_key": api_key, "base_url": base_url, **kwargs} - client = Arcade(**arcade_kwargs) # type: ignore[arg-type] - - self._client = client - self._tools: dict[str, ToolDefinition] = {} - self.default_user_id = default_user_id - - # Use the default executor if none is provided. - if executor is None and default_user_id is None: - raise ValueError("A default_user_id must be provided if no executor is specified.") - - self.executor = executor or self._default_executor - - if not callable(self.executor): - raise TypeError( - "executor must be callable and adhere to the ArcadeToolExecutorProtocol signature" - ) - - @property - def tools(self) -> list[str]: - return list(self._tools.keys()) - - def __iter__(self) -> Iterator[tuple[str, ToolDefinition]]: - yield from self._tools.items() - - def __len__(self) -> int: - return len(self._tools) - - def __getitem__(self, tool_name: str) -> ToolDefinition: - return self._tools[tool_name] - - def init_tools( - self, - tools: Optional[list[str]] = None, - toolkits: Optional[list[str]] = None, - ) -> None: - """Initialize the tools in the manager. - - This method clears any existing tools in the manager and replaces them - with tools and toolkits that are provided. If no tools or toolkits are - provided, then all tools in the Arcade client will be added. - - Example: - >>> manager = ArcadeToolManager(default_user_id="me@example.com", api_key="...") - >>> manager.init_tools(tools=["Search.SearchGoogle"]) - >>> manager.get_tools() - - Args: - tools: Optional list of tool names to include. - toolkits: Optional list of toolkits to include. - """ - self._tools = self._retrieve_tool_definitions(tools, toolkits) - - def add_tools( - self, tools: Optional[list[str]] = None, toolkits: Optional[list[str]] = None - ) -> None: - """Add tools to the manager. - - This method adds tools to the manager's internal tool list. If no tools or - toolkits are provided, all tools in the Arcade client will be added. - - Example: - >>> manager = ArcadeToolManager(default_user_id="me@example.com", api_key="...") - >>> manager.init_tools(tools=["Search.SearchGoogle"]) - >>> manager.add_tools(tools=["Google.ListEmails"], toolkits=["Slack"]) - >>> manager.get_tools() - - Args: - tools: List of tool names to add. - toolkits: List of toolkits to add tools from. - """ - new_tool_definitions = self._retrieve_tool_definitions(tools, toolkits) - self._tools.update(new_tool_definitions) - - def get_tools( - self, tools: Optional[list[str]] = None, toolkits: Optional[list[str]] = None - ) -> list[StructuredTool]: - """Retrieves the requested tools or toolkits from the manager. - - This method retrieves the provided tools or toolkits as CrewAI StructuredTools. - - If any provided tools or toolkits are not already present in the - internal tool list, then they are added to the manager. - If no tools or toolkits are provided, then all tools in the manager's - internal tool list are returned as CrewAI StructuredTools. - - Example: - >>> manager = ArcadeToolManager(default_user_id="me@example.com", api_key="...") - >>> - >>> # Retrieve a specific tool as a CrewAI tool - >>> manager.get_tools(tools=["Search.SearchGoogle"]) - >>> - >>> # Retrieve all tools in a toolkit as CrewAI tools - >>> manager.get_tools(toolkits=["Search"]) - >>> - >>> # Retrieve all tools in the manager as CrewAI tools - >>> manager.get_tools() - - Args: - tools: An optional list of tool names to retrieve and wrap. If any of these - tools are missing from the internal list, they will be added. - toolkits: An optional list of toolkits from which to retrieve and wrap tools. - Tools from these toolkits will be added if they are not already present. - - Returns: - A list of StructuredTool instances adapted from the specified tools. - """ - if tools or toolkits: - if len(self) == 0: - self.init_tools(tools, toolkits) - else: - new_tools = self._retrieve_tool_definitions(tools, toolkits) - self._tools.update(new_tools) - - # Wrap the requested tools as CrewAI StructuredTools - crewai_tools: list[StructuredTool] = [] - for tool_name, tool_def in self: - crewai_tools.append(self._wrap_arcade_tool(tool_name, tool_def)) - - return crewai_tools - - def authorize_tool(self, user_id: str, name: str) -> None: - """Handle the authorization flow. - - Args: - user_id: The user ID to authorize the tool for. - name: The name of the tool to authorize. - """ - - if self.requires_auth(name): - # Get authorization status - auth_response = self.authorize(name, user_id) - - if not self.is_authorized(auth_response.id): # type: ignore[arg-type] - # Handle authorization - print(f"Please use the following link to authorize: {auth_response.url}") - auth_response = self.wait_for_auth(auth_response) - - # Ensure authorization completed successfully - if not self.is_authorized(auth_response.id): # type: ignore[arg-type] - raise ValueError(f"Authorization failed for {name}. URL: {auth_response.url}") - - def execute_tool(self, user_id: str, name: str, **input: Any) -> Any: # noqa: A002 - """Handle the tool execution flow. - - Args: - user_id: The user ID to execute the tool for. - name: The name of the tool to execute. - **input: Dictionary of input arguments for the tool. - - Returns: - The output of the tool. - """ - response = self._client.tools.execute( - tool_name=name, - input=input, - user_id=user_id, - ) - - tool_error = response.output.error if response.output else None - if tool_error: - return str(tool_error) - if response.success: - return response.output.value # type: ignore[union-attr] - - return "Failed to call " + name - - def requires_auth(self, tool_name: str) -> bool: - """Check if a tool requires authorization.""" - cleaned_tool_name = tool_name.replace(".", TOOL_NAME_SEPARATOR) - tool_def = self._tools.get(cleaned_tool_name) - - if tool_def is None: - raise ValueError(f"Tool '{tool_name}' not found in this ArcadeToolManager instance") - - if tool_def.requirements is None: - return False - - return tool_def.requirements.authorization is not None - - def authorize(self, tool_name: str, user_id: str) -> AuthorizationResponse: - """Authorize a user for a tool. - - Args: - tool_name: The name of the tool to authorize. - user_id: The user ID to authorize. - - Returns: - AuthorizationResponse - """ - return self._client.tools.authorize(tool_name=tool_name, user_id=user_id) - - def is_authorized(self, authorization_id: str) -> bool: - """Check if a tool authorization is complete.""" - return self._client.auth.status(id=authorization_id).status == "completed" - - def wait_for_auth(self, auth_response: AuthorizationResponse) -> AuthorizationResponse: - """Wait for an authorization process to complete. - - Args: - auth_response: The authorization response from the initial authorize call. - - Returns: - AuthorizationResponse with completed status - """ - return self._client.auth.wait_for_completion(auth_response) - - def _wrap_arcade_tool(self, name: str, tool_def: ToolDefinition) -> StructuredTool: - """Wrap an Arcade tool as a CrewAI StructuredTool. - - Args: - name: The name of the tool to wrap. - tool_def: The definition of the tool to wrap. - - Returns: - A StructuredTool instance. - """ - description = tool_def.description or "No description provided." - args_schema = tool_definition_to_pydantic_model(tool_def) - tool_function = self._create_tool_function(name) - - return StructuredTool.from_function( - func=tool_function, - name=name, - description=description, - args_schema=args_schema, - ) - - def _retrieve_tool_definitions( - self, tools: Optional[list[str]] = None, toolkits: Optional[list[str]] = None - ) -> dict[str, ToolDefinition]: - """Retrieve tool definitions from the Arcade client. - - This method fetches tool definitions based on the provided tool names or toolkits. - If no specific tools or toolkits are provided, the method will fetch and return - all tools available in the Arcade client. - - Args: - tools: Optional list of tool names to retrieve. - toolkits: Optional list of toolkits to retrieve tools from. - - Returns: - A dictionary mapping full tool names to their corresponding ToolDefinition objects - """ - all_tools: list[ToolDefinition] = [] - - if tools: - single_tools = [self._client.tools.get(name=tool_id) for tool_id in tools] - all_tools.extend(single_tools) - - if toolkits: - for tk in toolkits: - all_tools.extend(self._client.tools.list(toolkit=tk)) - - if not tools and not toolkits: - # Retrieve all Arcade tools. - page_iterator = self._client.tools.list() - all_tools.extend(page_iterator) - - tool_definitions: dict[str, ToolDefinition] = {} - for tool in all_tools: - full_tool_name = f"{tool.toolkit.name}{TOOL_NAME_SEPARATOR}{tool.name}" - tool_definitions[full_tool_name] = tool - - return tool_definitions - - def _create_tool_function(self, tool_name: str) -> Callable[..., Any]: - """Creates a function wrapper for an Arcade tool. - - Args: - tool_name: The name of the tool to create a function for. - - Returns: - A callable function that executes the tool. - """ - - def tool_function(**kwargs: Any) -> Any: - return self.executor(self, tool_name, **kwargs) - - return tool_function - - @staticmethod - def _default_executor( - manager: "ArcadeToolManager", name: str, **tool_input: dict[str, Any] - ) -> Any: - """ - Default executor that performs authorization followed - by tool execution using the manager's default_user_id. - """ - if manager.default_user_id is None: - raise ValueError("default_user_id is not set in ArcadeToolManager.") - user_id = manager.default_user_id - manager.authorize_tool(user_id, name) - return manager.execute_tool(user_id, name, **tool_input) diff --git a/contrib/crewai/crewai_arcade/structured.py b/contrib/crewai/crewai_arcade/structured.py deleted file mode 100644 index 9e84b33d..00000000 --- a/contrib/crewai/crewai_arcade/structured.py +++ /dev/null @@ -1,54 +0,0 @@ -from textwrap import dedent -from typing import Any, Callable, Optional - -from crewai.tools.base_tool import BaseTool -from pydantic import BaseModel as PydanticBaseModel - - -class StructuredTool(BaseTool): # type: ignore[no-any-unimported] - """A tool that executes functions with structured inputs using a schema.""" - - func: Callable[..., Any] - """The callable function that implements the tool's functionality.""" - - def _run(self, *args: Any, **kwargs: Any) -> Any: - """Execute the tool's function with the provided arguments.""" - return self.func(*args, **kwargs) - - @classmethod - def from_function( - cls, - func: Callable, - args_schema: type[PydanticBaseModel], - name: Optional[str] = None, - description: Optional[str] = None, - **kwargs: Any, - ) -> "StructuredTool": - """Create a new StructuredTool instance from a function. - - Args: - func: Function to wrap as a CrewAI tool - name: Custom name for the tool - description: Custom description of the tool's functionality - args_schema: Pydantic model defining the expected argument structure - **kwargs: Additional tool configuration parameters, like cache_function - - Returns: - StructuredTool: A new tool instance wrapping the provided function - """ - name = name or func.__name__ - - if description is None: - description = func.__doc__ - if description is None: - raise ValueError("Function must have a docstring if description not provided.") - # Clean up docstring - description = dedent(description).strip() - - return cls( - func=func, - args_schema=args_schema, - name=name, - description=description, - **kwargs, - ) diff --git a/contrib/crewai/pyproject.toml b/contrib/crewai/pyproject.toml index bfe8367b..7c9d8644 100644 --- a/contrib/crewai/pyproject.toml +++ b/contrib/crewai/pyproject.toml @@ -1,45 +1,30 @@ -[tool.poetry] +[build-system] +requires = [ "hatchling",] +build-backend = "hatchling.build" + +[project] name = "crewai-arcade" -version = "0.1.1" -description = "An integration package connecting Arcade and CrewAI" -authors = ["Arcade