Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Auto-update documentation after merge

camel-docs-bot04cb50763cbd
diff --git a/docs/mintlify/reference/camel.toolkits.message_agent_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.message_agent_toolkit.mdx
index c475c1eb8..2102b488e 100644
--- a/docs/mintlify/reference/camel.toolkits.message_agent_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.message_agent_toolkit.mdx
@@ -1,41 +1,75 @@
<a id="camel.toolkits.message_agent_toolkit"></a>
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentMessage"></a>
-## MessageAgentTool
+## AgentMessage
```python
-class MessageAgentTool(BaseToolkit):
+class AgentMessage(BaseMessage):
```
-A toolkit for agent-to-agent communication.
+Represents a message between agents, extending BaseMessage.
-This toolkit allows agents to send messages to other agents by their IDs
-and receive responses, enabling multi-agent collaboration.
+This class extends the standard CAMEL BaseMessage with additional
+attributes needed for inter-agent communication.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentMessage.__init__"></a>
+
+### __init__
+
+```python
+def __init__(
+ self,
+ message_id: str,
+ sender_id: str,
+ receiver_id: str,
+ content: str,
+ timestamp: float,
+ reply_to: Optional[str] = None,
+ metadata: Optional[Dict[str, Any]] = None
+):
+```
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit"></a>
+
+## AgentCommunicationToolkit
+
+```python
+class AgentCommunicationToolkit(BaseToolkit):
+```
+
+A toolkit for agent-to-agent communication in multi-agent systems.
+
+Enables agents to send messages to each other with message history tracking
+and integration with the CAMEL workforce system.
**Parameters:**
-- **agents** (Optional[Dict[str, ChatAgent]], optional): Dictionary mapping agent IDs to ChatAgent instances. (default: :obj:`None`)
-- **timeout** (Optional[float], optional): Maximum execution time allowed for toolkit operations in seconds. If None, no timeout is applied. (default: :obj:`None`)
+- **agents** (Optional[Dict[str, ChatAgent]]): Dictionary mapping agent IDs to ChatAgent instances. (default: :obj:`None`)
+- **timeout** (Optional[float]): Maximum execution time for operations in seconds. (default: :obj:`None`)
+- **max_message_history** (int): Maximum messages to keep per agent. (default: :obj:`100`)
+- **get_response** (bool): Whether to get responses from receiving agents by default. (default: :obj:`False`)
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.__init__"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.__init__"></a>
### __init__
```python
def __init__(
self,
- agents: Optional[Dict[str, ChatAgent]] = None,
- timeout: Optional[float] = None
+ agents: Optional[Dict[str, 'ChatAgent']] = None,
+ timeout: Optional[float] = None,
+ max_message_history: int = 100,
+ get_response: bool = False
):
```
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.register_agent"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.register_agent"></a>
### register_agent
```python
-def register_agent(self, agent_id: str, agent: ChatAgent):
+def register_agent(self, agent_id: str, agent: 'ChatAgent'):
```
Register a new agent for communication.
@@ -47,29 +81,150 @@ Register a new agent for communication.
**Returns:**
- str: Confirmation message.
+ str: Confirmation message with registration details.
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.message_agent"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit._find_agent_id"></a>
-### message_agent
+### _find_agent_id
```python
-def message_agent(self, message: str, receiver_agent_id: str):
+def _find_agent_id(self, agent_id: str):
```
-Send a message to another agent and get the response.
+Find agent ID with flexible matching (case-insensitive, partial
+matches).
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.send_message"></a>
+
+### send_message
+
+```python
+def send_message(
+ self,
+ message: str,
+ receiver_id: str,
+ sender_id: str = 'system',
+ reply_to: Optional[str] = None,
+ metadata_json: Optional[str] = None
+):
+```
+
+Sends a message to a specific agent.
+
+This function allows one agent to communicate directly with another by
+sending a message. The toolkit's get_response setting determines
+whether to get an immediate response or just send a notification. To
+get the `receiver_id` of the agent you want to communicate with, you
+can use the `list_available_agents` tool.
**Parameters:**
-- **message** (str): The message to send to the target agent.
-- **receiver_agent_id** (str): Unique identifier of the target agent.
+- **message** (str): The content of the message to send.
+- **receiver_id** (str): The unique identifier of the agent to receive the message. Use `list_available_agents()` to find the ID of the agent you want to talk to.
+- **sender_id** (str): The unique identifier of the agent sending the message. This is typically your agent's ID. (default: :obj:`"system"`)
+- **reply_to** (Optional[str]): The ID of a previous message this new message is a reply to. This helps create conversation threads. (default: :obj:`None`)
+- **metadata_json** (Optional[str]): A JSON string containing extra information about the message. (default: :obj:`None`)
**Returns:**
- str: Response from the target agent or error message if the
-operation fails.
+ str: A confirmation that the message was sent. If the toolkit's
+get_response setting is True, includes the response from the
+receiving agent.
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.list_available_agents"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit._deliver_message"></a>
+
+### _deliver_message
+
+```python
+def _deliver_message(self, message: AgentMessage, get_response: bool):
+```
+
+Deliver a message to the target agent, optionally getting a
+response.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.broadcast_message"></a>
+
+### broadcast_message
+
+```python
+def broadcast_message(
+ self,
+ message: str,
+ sender_id: str = 'system',
+ exclude_agents: Optional[List[str]] = None
+):
+```
+
+Sends a message to all other agents in the system.
+
+This function is useful for making announcements or sending information
+that every agent needs. The message will be sent to all registered
+agents except for the sender and any agents specified in the
+`exclude_agents` list.
+
+**Parameters:**
+
+- **message** (str): The content of the message to broadcast.
+- **sender_id** (str): The unique identifier of the agent sending the message. This is typically your agent's ID. (default: :obj:`"system"`)
+- **exclude_agents** (Optional[List[str]]): A list of agent IDs to exclude from the broadcast. The sender is automatically excluded. (default: :obj:`None`)
+
+**Returns:**
+
+ str: A summary of the broadcast, showing which agents received the
+message and their responses.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.get_message_history"></a>
+
+### get_message_history
+
+```python
+def get_message_history(self, agent_id: str, limit: Optional[int] = None):
+```
+
+Retrieves the message history for a specific agent.
+
+This function allows you to see the messages sent and received by a
+particular agent, which can be useful for understanding past
+conversations. To get the `agent_id` for another agent, use the
+`list_available_agents` tool. You can also use this tool to get
+your own message history by providing your agent ID.
+
+**Parameters:**
+
+- **agent_id** (str): The unique identifier of the agent whose message history you want to retrieve. Use `list_available_agents()` to find available agent IDs.
+- **limit** (Optional[int]): The maximum number of recent messages to return. If not specified, it will return all messages up to the system's limit. (default: :obj:`None`)
+
+**Returns:**
+
+ str: A formatted string containing the message history for the
+specified agent, or an error if the agent is not found.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.get_conversation_thread"></a>
+
+### get_conversation_thread
+
+```python
+def get_conversation_thread(self, message_id: str):
+```
+
+Retrieves a full conversation thread based on a message ID.
+
+When you send a message that is a reply to another, it creates a
+conversation thread. This function lets you retrieve all messages
+that are part of that thread. You can find message IDs in the
+message history or from the output of the `send_message` tool.
+
+**Parameters:**
+
+- **message_id** (str): The unique identifier of any message within the conversation thread you want to retrieve.
+
+**Returns:**
+
+ str: A formatted string containing all messages in the
+conversation, sorted by time, or an error if the thread is
+not found.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.list_available_agents"></a>
### list_available_agents
@@ -79,10 +234,10 @@ def list_available_agents(self):
**Returns:**
- str: Formatted list of registered agent IDs or message if no
-agents are registered.
+ str: A formatted string listing the IDs and status of all
+available agents.
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.remove_agent"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.remove_agent"></a>
### remove_agent
@@ -98,21 +253,41 @@ Remove an agent from the communication registry.
**Returns:**
- str: Confirmation message or error message if agent not found.
+ str: Confirmation message with cleanup details.
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.get_agent_count"></a>
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.get_toolkit_status"></a>
-### get_agent_count
+### get_toolkit_status
```python
-def get_agent_count(self):
+def get_toolkit_status(self):
```
**Returns:**
- str: Number of currently registered agents.
+ str: Detailed status information including metrics and queue state.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit._add_to_history"></a>
-<a id="camel.toolkits.message_agent_toolkit.MessageAgentTool.get_tools"></a>
+### _add_to_history
+
+```python
+def _add_to_history(self, message: AgentMessage):
+```
+
+Add a message to the history with size management.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit._update_conversation_thread"></a>
+
+### _update_conversation_thread
+
+```python
+def _update_conversation_thread(self, parent_id: str, new_id: str):
+```
+
+Update conversation threading.
+
+<a id="camel.toolkits.message_agent_toolkit.AgentCommunicationToolkit.get_tools"></a>
### get_tools
@@ -120,6 +295,9 @@ def get_agent_count(self):
def get_tools(self):
```
+Returns a list of FunctionTool objects representing the
+communication functions in the toolkit.
+
**Returns:**
List[FunctionTool]: A list of FunctionTool objects for agent