camel-ai 0.2.61__py3-none-any.whl → 0.2.64__py3-none-any.whl

camel/{runtime → runtimes}/ubuntu_docker_runtime.py

@@ -18,7 +18,7 @@ import time
 from pathlib import Path
 from typing import Callable, List, Optional, Union
 
-from camel.runtime.docker_runtime import DockerRuntime
+from camel.runtimes.docker_runtime import DockerRuntime
 from camel.toolkits import FunctionTool
 
 logger = logging.getLogger(__name__)

camel/societies/workforce/base.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from abc import ABC, abstractmethod
-from typing import Any
+from typing import Any, Optional
 
 from camel.societies.workforce.task_channel import TaskChannel
 from camel.societies.workforce.utils import check_if_running
@@ -23,10 +23,14 @@ class BaseNode(ABC):
 
     Args:
         description (str): Description of the node.
+        node_id (Optional[str]): ID of the node. If not provided, it will
+            be generated automatically. (default: :obj:`None`)
     """
 
-    def __init__(self, description: str) -> None:
-        self.node_id = str(id(self))
+    def __init__(
+        self, description: str, node_id: Optional[str] = None
+    ) -> None:
+        self.node_id = node_id if node_id is not None else str(id(self))
         self.description = description
         self._channel: TaskChannel = TaskChannel()
         self._running = False

camel/societies/workforce/role_playing_worker.py

@@ -48,7 +48,7 @@ class RolePlayingWorker(Worker):
             initialize the summarize agent, like the model name, etc.
             (default: :obj:`None`)
         chat_turn_limit (int): The maximum number of chat turns in the role
-            playing. (default: :obj:`3`)
+            playing. (default: :obj:`20`)
     """
 
     def __init__(
@@ -59,7 +59,7 @@ class RolePlayingWorker(Worker):
         assistant_agent_kwargs: Optional[Dict] = None,
         user_agent_kwargs: Optional[Dict] = None,
         summarize_agent_kwargs: Optional[Dict] = None,
-        chat_turn_limit: int = 3,
+        chat_turn_limit: int = 20,
     ) -> None:
         super().__init__(description)
         self.summarize_agent_kwargs = summarize_agent_kwargs

camel/societies/workforce/single_agent_worker.py

@@ -13,6 +13,7 @@
 # ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
 from __future__ import annotations
 
+import datetime
 import json
 from typing import Any, List
 
@@ -39,7 +40,8 @@ class SingleAgentWorker(Worker):
         description: str,
         worker: ChatAgent,
     ) -> None:
-        super().__init__(description)
+        node_id = worker.agent_id
+        super().__init__(description, node_id=node_id)
         self.worker = worker
 
     def reset(self) -> Any:
@@ -82,6 +84,28 @@ class SingleAgentWorker(Worker):
             )
             return TaskState.FAILED
 
+        # Populate additional_info with worker attempt details
+        if task.additional_info is None:
+            task.additional_info = {}
+
+        # Create worker attempt details with descriptive keys
+        worker_attempt_details = {
+            "agent_id": getattr(
+                self.worker, "agent_id", self.worker.role_name
+            ),
+            "timestamp": str(datetime.datetime.now()),
+            "description": f"Attempt by "
+            f"{getattr(self.worker, 'agent_id', self.worker.role_name)} "
+            f"to process task {task.content}",
+            "response_content": response.msg.content,
+            "tool_calls": response.info["tool_calls"],
+        }
+
+        # Store the worker attempt in additional_info
+        if "worker_attempts" not in task.additional_info:
+            task.additional_info["worker_attempts"] = []
+        task.additional_info["worker_attempts"].append(worker_attempt_details)
+
         print(f"======\n{Fore.GREEN}Reply from {self}:{Fore.RESET}")
 
         result_dict = json.loads(response.msg.content)

camel/societies/workforce/worker.py

@@ -15,7 +15,7 @@ from __future__ import annotations
 
 import logging
 from abc import ABC, abstractmethod
-from typing import List
+from typing import List, Optional
 
 from colorama import Fore
 
@@ -33,14 +33,16 @@ class Worker(BaseNode, ABC):
 
     Args:
         description (str): Description of the node.
-
+        node_id (Optional[str]): ID of the node. If not provided, it will
+            be generated automatically. (default: :obj:`None`)
     """
 
     def __init__(
         self,
         description: str,
+        node_id: Optional[str] = None,
     ) -> None:
-        super().__init__(description)
+        super().__init__(description, node_id=node_id)
 
     def __repr__(self):
         return f"Worker node {self.node_id} ({self.description})"

camel/societies/workforce/workforce.py

@@ -15,13 +15,13 @@ from __future__ import annotations
 
 import asyncio
 import json
+import uuid
 from collections import deque
 from typing import Deque, Dict, List, Optional
 
 from colorama import Fore
 
 from camel.agents import ChatAgent
-from camel.configs import ChatGPTConfig
 from camel.logger import get_logger
 from camel.messages.base import BaseMessage
 from camel.models import ModelFactory
@@ -43,6 +43,7 @@ from camel.societies.workforce.worker import Worker
 from camel.tasks.task import Task, TaskState
 from camel.toolkits import CodeExecutionToolkit, SearchToolkit, ThinkingToolkit
 from camel.types import ModelPlatformType, ModelType
+from camel.utils import dependencies_required
 
 logger = get_logger(__name__)
 
@@ -85,6 +86,10 @@ class Workforce(BaseNode):
             available parameters.
             (default: :obj:`None` - creates workers with SearchToolkit,
             CodeExecutionToolkit, and ThinkingToolkit)
+        graceful_shutdown_timeout (float, optional): The timeout in seconds
+            for graceful shutdown when a task fails 3 times. During this
+            period, the workforce remains active for debugging.
+            Set to 0 for immediate shutdown. (default: :obj:`15.0`)
 
     Example:
         >>> # Configure with custom model
@@ -109,11 +114,13 @@ class Workforce(BaseNode):
         coordinator_agent_kwargs: Optional[Dict] = None,
         task_agent_kwargs: Optional[Dict] = None,
         new_worker_agent_kwargs: Optional[Dict] = None,
+        graceful_shutdown_timeout: float = 15.0,
     ) -> None:
         super().__init__(description)
         self._child_listening_tasks: Deque[asyncio.Task] = deque()
         self._children = children or []
         self.new_worker_agent_kwargs = new_worker_agent_kwargs
+        self.graceful_shutdown_timeout = graceful_shutdown_timeout
 
         # Warning messages for default model usage
         if coordinator_agent_kwargs is None:
@@ -421,15 +428,10 @@ class Workforce(BaseNode):
             *ThinkingToolkit().get_tools(),
         ]
 
-        model_config_dict = ChatGPTConfig(
-            tools=function_list,
-            temperature=0.0,
-        ).as_dict()
-
         model = ModelFactory.create(
             model_platform=ModelPlatformType.DEFAULT,
             model_type=ModelType.DEFAULT,
-            model_config_dict=model_config_dict,
+            model_config_dict={"temperature": 0},
         )
 
         return ChatAgent(worker_sys_msg, model=model, tools=function_list)  # type: ignore[arg-type]
@@ -494,6 +496,26 @@ class Workforce(BaseNode):
         await self._channel.archive_task(task.id)
         await self._post_ready_tasks()
 
+    async def _graceful_shutdown(self, failed_task: Task) -> None:
+        r"""Handle graceful shutdown with configurable timeout. This is used to
+        keep the workforce running for a while to debug the failed task.
+
+        Args:
+            failed_task (Task): The task that failed and triggered shutdown.
+        """
+        if self.graceful_shutdown_timeout <= 0:
+            # Immediate shutdown if timeout is 0 or negative
+            return
+
+        logger.warning(
+            f"Workforce will shutdown in {self.graceful_shutdown_timeout} "
+            f"seconds due to failure. You can use this time to inspect the "
+            f"current state of the workforce."
+        )
+
+        # Wait for the full timeout period
+        await asyncio.sleep(self.graceful_shutdown_timeout)
+
     @check_if_running(False)
     async def _listen_to_channel(self) -> None:
         r"""Continuously listen to the channel, post task to the channel and
@@ -517,6 +539,8 @@ class Workforce(BaseNode):
                     f"{Fore.RED}Task {returned_task.id} has failed "
                     f"for 3 times, halting the workforce.{Fore.RESET}"
                 )
+                # Graceful shutdown instead of immediate break
+                await self._graceful_shutdown(returned_task)
                 break
             elif returned_task.state == TaskState.OPEN:
                 # TODO: multi-layer workforce
@@ -568,6 +592,7 @@ class Workforce(BaseNode):
             coordinator_agent_kwargs={},
             task_agent_kwargs={},
             new_worker_agent_kwargs=self.new_worker_agent_kwargs,
+            graceful_shutdown_timeout=self.graceful_shutdown_timeout,
         )
 
         new_instance.task_agent = self.task_agent.clone(with_memory)
@@ -598,3 +623,380 @@ class Workforce(BaseNode):
                 continue
 
         return new_instance
+
+    @dependencies_required("mcp")
+    def to_mcp(
+        self,
+        name: str = "CAMEL-Workforce",
+        description: str = (
+            "A workforce system using the CAMEL AI framework for "
+            "multi-agent collaboration."
+        ),
+        dependencies: Optional[List[str]] = None,
+        host: str = "localhost",
+        port: int = 8001,
+    ):
+        r"""Expose this Workforce as an MCP server.
+
+        Args:
+            name (str): Name of the MCP server.
+                (default: :obj:`CAMEL-Workforce`)
+            description (str): Description of the workforce. If
+                None, a generic description is used. (default: :obj:`A
+                workforce system using the CAMEL AI framework for
+                multi-agent collaboration.`)
+            dependencies (Optional[List[str]]): Additional
+                dependencies for the MCP server. (default: :obj:`None`)
+            host (str): Host to bind to for HTTP transport.
+                (default: :obj:`localhost`)
+            port (int): Port to bind to for HTTP transport.
+                (default: :obj:`8001`)
+
+        Returns:
+            FastMCP: An MCP server instance that can be run.
+        """
+        from mcp.server.fastmcp import FastMCP
+
+        # Combine dependencies
+        all_dependencies = ["camel-ai[all]"]
+        if dependencies:
+            all_dependencies.extend(dependencies)
+
+        mcp_server = FastMCP(
+            name,
+            dependencies=all_dependencies,
+            host=host,
+            port=port,
+        )
+
+        # Store workforce reference
+        workforce_instance = self
+
+        # Define functions first
+        def process_task(task_content, task_id=None, additional_info=None):
+            r"""Process a task using the workforce.
+
+            Args:
+                task_content (str): The content of the task to be processed.
+                task_id (str, optional): Unique identifier for the task. If
+                    None, a UUID will be automatically generated.
+                    (default: :obj:`None`)
+                additional_info (str, optional): Additional information or
+                    context for the task. (default: :obj:`None`)
+
+            Returns:
+                Dict[str, Any]: A dictionary containing the processing result
+                    with the following keys:
+                    - status (str): "success" or "error"
+                    - task_id (str): The ID of the processed task
+                    - state (str): Final state of the task
+                    - result (str): Task result content
+                    - subtasks (List[Dict]): List of subtask information
+                    - message (str): Error message if status is "error"
+
+            Example:
+                >>> result = process_task("Analyze market trends", "task_001")
+                >>> print(result["status"])  # "success" or "error"
+            """
+            task = Task(
+                content=task_content,
+                id=task_id or str(uuid.uuid4()),
+                additional_info=additional_info or "",
+            )
+
+            try:
+                result_task = workforce_instance.process_task(task)
+                return {
+                    "status": "success",
+                    "task_id": result_task.id,
+                    "state": str(result_task.state),
+                    "result": result_task.result or "",
+                    "subtasks": [
+                        {
+                            "id": subtask.id,
+                            "content": subtask.content,
+                            "state": str(subtask.state),
+                            "result": subtask.result or "",
+                        }
+                        for subtask in (result_task.subtasks or [])
+                    ],
+                }
+            except Exception as e:
+                return {
+                    "status": "error",
+                    "message": str(e),
+                    "task_id": task.id,
+                }
+
+        # Reset tool
+        def reset():
+            r"""Reset the workforce to its initial state.
+
+            Clears all pending tasks, resets all child nodes, and returns
+            the workforce to a clean state ready for new task processing.
+
+            Returns:
+                Dict[str, str]: A dictionary containing the reset result with:
+                    - status (str): "success" or "error"
+                    - message (str): Descriptive message about the operation
+
+            Example:
+                >>> result = reset()
+                >>> print(result["message"])  # "Workforce reset successfully"
+            """
+            try:
+                workforce_instance.reset()
+                return {
+                    "status": "success",
+                    "message": "Workforce reset successfully",
+                }
+            except Exception as e:
+                return {"status": "error", "message": str(e)}
+
+        # Workforce info resource and tool
+        def get_workforce_info():
+            r"""Get comprehensive information about the workforce.
+
+            Retrieves the current state and configuration of the workforce
+            including its ID, description, running status, and task queue
+            information.
+
+            Returns:
+                Dict[str, Any]: A dictionary containing workforce information:
+                    - node_id (str): Unique identifier of the workforce
+                    - description (str): Workforce description
+                    - mcp_description (str): MCP server description
+                    - children_count (int): Number of child workers
+                    - is_running (bool): Whether the workforce is active
+                    - pending_tasks_count (int): Number of queued tasks
+                    - current_task_id (str or None): ID of the active task
+
+            Example:
+                >>> info = get_workforce_info()
+                >>> print(f"Running: {info['is_running']}")
+                >>> print(f"Children: {info['children_count']}")
+            """
+            info = {
+                "node_id": workforce_instance.node_id,
+                "description": workforce_instance.description,
+                "mcp_description": description,
+                "children_count": len(workforce_instance._children),
+                "is_running": workforce_instance._running,
+                "pending_tasks_count": len(workforce_instance._pending_tasks),
+                "current_task_id": (
+                    workforce_instance._task.id
+                    if workforce_instance._task
+                    else None
+                ),
+            }
+            return info
+
+        # Children info resource and tool
+        def get_children_info():
+            r"""Get information about all child nodes in the workforce.
+
+            Retrieves comprehensive information about each child worker
+            including their type, capabilities, and configuration details.
+
+            Returns:
+                List[Dict[str, Any]]: A list of dictionaries, each containing
+                    child node information with common keys:
+                    - node_id (str): Unique identifier of the child
+                    - description (str): Child node description
+                    - type (str): Type of worker (e.g., "SingleAgentWorker")
+
+                    Additional keys depend on worker type:
+
+                    For SingleAgentWorker:
+                    - tools (List[str]): Available tool names
+                    - role_name (str): Agent's role name
+
+                    For RolePlayingWorker:
+                    - assistant_role (str): Assistant agent role
+                    - user_role (str): User agent role
+                    - chat_turn_limit (int): Maximum conversation turns
+
+                    For Workforce:
+                    - children_count (int): Number of nested children
+                    - is_running (bool): Whether the nested workforce is active
+
+            Example:
+                >>> children = get_children_info()
+                >>> for child in children:
+                ...     print(f"{child['type']}: {child['description']}")
+            """
+            children_info = []
+            for child in workforce_instance._children:
+                child_info = {
+                    "node_id": child.node_id,
+                    "description": child.description,
+                    "type": type(child).__name__,
+                }
+
+                if isinstance(child, SingleAgentWorker):
+                    child_info["tools"] = list(child.worker.tool_dict.keys())
+                    child_info["role_name"] = child.worker.role_name
+                elif isinstance(child, RolePlayingWorker):
+                    child_info["assistant_role"] = child.assistant_role_name
+                    child_info["user_role"] = child.user_role_name
+                    child_info["chat_turn_limit"] = child.chat_turn_limit
+                elif isinstance(child, Workforce):
+                    child_info["children_count"] = len(child._children)
+                    child_info["is_running"] = child._running
+
+                children_info.append(child_info)
+
+            return children_info
+
+        # Add single agent worker
+        def add_single_agent_worker(
+            description,
+            system_message=None,
+            role_name="Assistant",
+            agent_kwargs=None,
+        ):
+            r"""Add a single agent worker to the workforce.
+
+            Creates and adds a new SingleAgentWorker to the workforce with
+            the specified configuration. The worker cannot be added while
+            the workforce is currently running.
+
+            Args:
+                description (str): Description of the worker's role and
+                    capabilities.
+                system_message (str, optional): Custom system message for the
+                    agent. If None, a default message based on role_name is
+                    used. (default: :obj:`None`)
+                role_name (str, optional): Name of the agent's role.
+                    (default: :obj:`"Assistant"`)
+                agent_kwargs (Dict, optional): Additional keyword arguments
+                    to pass to the ChatAgent constructor, such as model
+                    configuration, tools, etc. (default: :obj:`None`)
+
+            Returns:
+                Dict[str, str]: A dictionary containing the operation result:
+                    - status (str): "success" or "error"
+                    - message (str): Descriptive message about the operation
+                    - worker_id (str): ID of the created worker (on success)
+
+            Example:
+                >>> result = add_single_agent_worker(
+                ...     "Data Analyst",
+                ...     "You are a data analysis expert.",
+                ...     "Analyst"
+                ... )
+                >>> print(result["status"])  # "success" or "error"
+            """
+            try:
+                if workforce_instance._running:
+                    return {
+                        "status": "error",
+                        "message": "Cannot add workers while workforce is running",  # noqa: E501
+                    }
+
+                # Create agent with provided configuration
+                sys_msg = BaseMessage.make_assistant_message(
+                    role_name=role_name,
+                    content=system_message or f"You are a {role_name}.",
+                )
+
+                agent = ChatAgent(sys_msg, **(agent_kwargs or {}))
+                workforce_instance.add_single_agent_worker(description, agent)
+
+                return {
+                    "status": "success",
+                    "message": f"Single agent worker '{description}' added",
+                    "worker_id": workforce_instance._children[-1].node_id,
+                }
+            except Exception as e:
+                return {"status": "error", "message": str(e)}
+
+        # Add role playing worker
+        def add_role_playing_worker(
+            description,
+            assistant_role_name,
+            user_role_name,
+            chat_turn_limit=20,
+            assistant_agent_kwargs=None,
+            user_agent_kwargs=None,
+            summarize_agent_kwargs=None,
+        ):
+            r"""Add a role playing worker to the workforce.
+
+            Creates and adds a new RolePlayingWorker to the workforce that
+            uses two agents in a conversational role-playing setup. The
+            worker cannot be added while the workforce is currently running.
+
+            Args:
+                description (str): Description of the role playing worker's
+                    purpose and capabilities.
+                assistant_role_name (str): Name/role of the assistant agent
+                    in the role playing scenario.
+                user_role_name (str): Name/role of the user agent in the
+                    role playing scenario.
+                chat_turn_limit (int, optional): Maximum number of
+                    conversation turns between the two agents.
+                    (default: :obj:`20`)
+                assistant_agent_kwargs (Dict, optional): Keyword arguments
+                    for configuring the assistant ChatAgent, such as model
+                    type, tools, etc. (default: :obj:`None`)
+                user_agent_kwargs (Dict, optional): Keyword arguments for
+                    configuring the user ChatAgent, such as model type,
+                    tools, etc. (default: :obj:`None`)
+                summarize_agent_kwargs (Dict, optional): Keyword arguments
+                    for configuring the summarization agent used to process
+                    the conversation results. (default: :obj:`None`)
+
+            Returns:
+                Dict[str, str]: A dictionary containing the operation result:
+                    - status (str): "success" or "error"
+                    - message (str): Descriptive message about the operation
+                    - worker_id (str): ID of the created worker (on success)
+
+            Example:
+                >>> result = add_role_playing_worker(
+                ...     "Design Review Team",
+                ...     "Design Critic",
+                ...     "Design Presenter",
+                ...     chat_turn_limit=5
+                ... )
+                >>> print(result["status"])  # "success" or "error"
+            """
+            try:
+                if workforce_instance._running:
+                    return {
+                        "status": "error",
+                        "message": "Cannot add workers while workforce is running",  # noqa: E501
+                    }
+
+                workforce_instance.add_role_playing_worker(
+                    description=description,
+                    assistant_role_name=assistant_role_name,
+                    user_role_name=user_role_name,
+                    chat_turn_limit=chat_turn_limit,
+                    assistant_agent_kwargs=assistant_agent_kwargs,
+                    user_agent_kwargs=user_agent_kwargs,
+                    summarize_agent_kwargs=summarize_agent_kwargs,
+                )
+
+                return {
+                    "status": "success",
+                    "message": f"Role playing worker '{description}' added",
+                    "worker_id": workforce_instance._children[-1].node_id,
+                }
+            except Exception as e:
+                return {"status": "error", "message": str(e)}
+
+        # Now register everything using decorators
+        mcp_server.tool()(process_task)
+        mcp_server.tool()(reset)
+        mcp_server.tool()(add_single_agent_worker)
+        mcp_server.tool()(add_role_playing_worker)
+
+        mcp_server.resource("workforce://")(get_workforce_info)
+        mcp_server.tool()(get_workforce_info)
+
+        mcp_server.resource("children://")(get_children_info)
+        mcp_server.tool()(get_children_info)
+
+        return mcp_server

camel/storages/__init__.py

@@ -31,6 +31,7 @@ from .vectordb_storages.milvus import MilvusStorage
 from .vectordb_storages.oceanbase import OceanBaseStorage
 from .vectordb_storages.qdrant import QdrantStorage
 from .vectordb_storages.tidb import TiDBStorage
+from .vectordb_storages.weaviate import WeaviateStorage
 
 __all__ = [
     'BaseKeyValueStorage',
@@ -50,4 +51,5 @@ __all__ = [
     'NebulaGraph',
     'Mem0Storage',
     'OceanBaseStorage',
+    'WeaviateStorage',
 ]

camel/storages/vectordb_storages/__init__.py

@@ -24,6 +24,7 @@ from .milvus import MilvusStorage
 from .oceanbase import OceanBaseStorage
 from .qdrant import QdrantStorage
 from .tidb import TiDBStorage
+from .weaviate import WeaviateStorage
 
 __all__ = [
     'BaseVectorStorage',
@@ -34,6 +35,7 @@ __all__ = [
     "TiDBStorage",
     'FaissStorage',
     'OceanBaseStorage',
+    'WeaviateStorage',
     'VectorRecord',
     'VectorDBStatus',
 ]