rasa-pro 3.13.6__py3-none-any.whl → 3.14.0.dev1__py3-none-any.whl

rasa/agents/protocol/mcp/mcp_task_agent.py

@@ -0,0 +1,447 @@
+import importlib
+import json
+import re
+from typing import Any, Dict, List, Optional, Tuple
+
+import structlog
+from jinja2 import Template
+from pypred import Predicate
+
+from rasa.agents.constants import (
+    KEY_CONTENT,
+    KEY_ROLE,
+    KEY_TOOL_CALL_ID,
+)
+from rasa.agents.core.types import AgentStatus, ProtocolType
+from rasa.agents.protocol.mcp.mcp_base_agent import MCPBaseAgent
+from rasa.agents.schemas import (
+    AgentInput,
+    AgentOutput,
+    AgentToolResult,
+)
+from rasa.core.available_agents import AgentMCPServerConfig, ProtocolConfig
+from rasa.shared.agents.utils import make_agent_identifier
+from rasa.shared.constants import (
+    ROLE_TOOL,
+)
+from rasa.shared.core.events import SlotSet
+from rasa.shared.providers.llm.llm_response import LLMResponse
+
+DEFAULT_TASK_AGENT_PROMPT_TEMPLATE = importlib.resources.read_text(
+    "rasa.agents.templates", "mcp_task_agent_prompt_template.jinja2"
+)
+
+structlogger = structlog.get_logger()
+
+
+class MCPTaskAgent(MCPBaseAgent):
+    """MCPTaskAgent client implementation"""
+
+    def __init__(
+        self,
+        name: str,
+        description: str,
+        protocol_type: ProtocolConfig,
+        server_configs: List[AgentMCPServerConfig],
+        llm_config: Optional[Dict[str, Any]] = None,
+        prompt_template: Optional[str] = None,
+        timeout: Optional[int] = None,
+        max_retries: Optional[int] = None,
+    ):
+        super().__init__(
+            name,
+            description,
+            protocol_type,
+            server_configs,
+            llm_config,
+            prompt_template,
+            timeout,
+            max_retries,
+        )
+
+    @property
+    def protocol_type(self) -> ProtocolType:
+        return ProtocolType.MCP_TASK
+
+    @staticmethod
+    def get_default_prompt_template() -> str:
+        return DEFAULT_TASK_AGENT_PROMPT_TEMPLATE
+
+    @classmethod
+    def get_agent_specific_built_in_tools(
+        cls, agent_input: AgentInput
+    ) -> List[Dict[str, Any]]:
+        """Get agentic specific built-in tools."""
+        return [
+            cls.get_slot_specific_set_slot_tool(slot_name)
+            for slot_name in cls._get_slot_names_from_exit_conditions(agent_input)
+        ]
+
+    @classmethod
+    def _get_slot_names_from_exit_conditions(cls, agent_input: AgentInput) -> List[str]:
+        """Extract valid slot names from exit conditions."""
+        exit_conditions = agent_input.metadata.get("exit_if", [])
+
+        # Find all unique names matching "slots.<name>"
+        extracted_slot_names = {
+            name
+            for condition in exit_conditions
+            for name in re.findall(r"\bslots\.(\w+)", condition)
+        }
+
+        # Keep only slots that actually exist in agent_input.slots
+        valid_slot_names = [
+            slot_name
+            for slot_name in extracted_slot_names
+            if slot_name in agent_input.slots
+        ]
+
+        structlogger.debug(
+            "mcp_task_agent.get_agent_specific_built_in_tools.slot_names",
+            exit_conditions=exit_conditions,
+            slot_names=valid_slot_names,
+        )
+
+        return valid_slot_names
+
+    @classmethod
+    def get_slot_specific_set_slot_tool(cls, slot_name: str) -> Dict[str, Any]:
+        """Get the set slot tool."""
+        return {
+            "type": "function",
+            "function": {
+                "name": f"set_slot_{slot_name}",
+                # We need to add the description, slot type, and allowed values
+                # (if present) to the description as well.
+                "description": f"Set the slot {slot_name} to a specific value.",
+                "parameters": {
+                    "type": "object",
+                    "properties": {
+                        "slot_value": {
+                            "type": "string",
+                            "description": "The value to assign to the slot.",
+                        },
+                    },
+                    "required": ["slot_value"],
+                    "additionalProperties": False,
+                },
+                "strict": True,
+            },
+        }
+
+    @classmethod
+    def _is_exit_conditions_met(
+        cls, agent_input: AgentInput, slots: Dict[str, Any]
+    ) -> Tuple[bool, Optional[str]]:
+        """Check if the exit conditions are met.
+
+        Args:
+            agent_input: The agent input.
+            slots: The slots to check the exit conditions against.
+
+        Returns:
+            A tuple containing a boolean indicating if the exit conditions are met
+            and a string indicating if an internal error occurred.
+        """
+        if not slots:
+            return False, None
+
+        exit_conditions = agent_input.metadata.get("exit_if", [])
+        current_context = {"slots": slots}
+
+        internal_error = None
+        all_conditions_met = True
+
+        for condition in exit_conditions:
+            try:
+                rendered_template = Template(condition).render(current_context)
+                predicate = Predicate(rendered_template)
+                condition_result = predicate.evaluate(current_context)
+                structlogger.debug(
+                    "mcp_task_agent.is_exit_conditions_met.predicate.result",
+                    predicate=predicate.description(),
+                    condition_result=condition_result,
+                    slots=slots,
+                    rendered_template=rendered_template,
+                )
+
+                # All conditions must be met (AND logic)
+                if not condition_result:
+                    all_conditions_met = False
+                    break
+
+            except (TypeError, Exception) as e:
+                structlogger.error(
+                    "mcp_task_agent.is_exit_conditions_met.predicate.error",
+                    predicate=condition,
+                    error=str(e),
+                )
+                all_conditions_met = False
+                internal_error = str(e)
+                break
+
+        structlogger.debug(
+            "mcp_task_agent.is_exit_conditions_met.result",
+            all_conditions_met=all_conditions_met,
+            internal_error=internal_error,
+        )
+
+        return all_conditions_met, internal_error
+
+    def _get_slot_name_from_tool_name(self, tool_name: str) -> Optional[str]:
+        """Get the slot name from the tool name."""
+        match = re.match(r"^set_slot_(\w+)$", tool_name)
+        if match:
+            return match.group(1)
+        return None
+
+    def _run_set_slot_tool(
+        self, slot_name: str, arguments: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """Run the set slot tool."""
+        slot_value = arguments.get("slot_value")
+
+        # Handle type conversion for common cases
+        if isinstance(slot_value, str):
+            # Convert common boolean strings to actual booleans
+            if slot_value.lower() == "true":
+                slot_value = True
+            elif slot_value.lower() == "false":
+                slot_value = False
+
+        return {slot_name: slot_value}
+
+    def _generate_agent_task_completed_output(
+        self,
+        agent_input: AgentInput,
+        slots: Dict[str, Any],
+        tool_results: Dict[str, AgentToolResult],
+    ) -> AgentOutput:
+        """Generate an agent task completed output."""
+        _slot_names_to_be_filled = self._get_slot_names_from_exit_conditions(
+            agent_input
+        )
+        return AgentOutput(
+            id=agent_input.id,
+            status=AgentStatus.COMPLETED,
+            events=[
+                SlotSet(slot_name, slot_value)
+                for slot_name, slot_value in slots.items()
+                if slot_name in _slot_names_to_be_filled
+            ],
+            tool_results=self._get_tool_results_for_agent_output(
+                agent_input, tool_results
+            ),
+        )
+
+    async def send_message(self, agent_input: AgentInput) -> AgentOutput:
+        """Send a message to the LLM and return the response."""
+        messages = self.build_messages_for_llm_request(agent_input)
+        tool_results: Dict[str, AgentToolResult] = {}
+
+        _slots = agent_input.slots.copy()
+        _available_tools = self.get_available_tools(agent_input)
+        _available_tools_names = [tool.name for tool in _available_tools]
+
+        # Convert available tools to OpenAI JSON format
+        tools_in_openai_format = [
+            tool.to_openai_json_format() for tool in _available_tools
+        ]
+
+        for iteration in range(self.MAX_ITERATIONS):
+            try:
+                # Make the LLM call using the llm_client
+                structlogger.info(
+                    "mcp_task_agent.send_message.sending_message_to_llm",
+                    messages=messages,
+                    event_info=f"Sending message to LLM (iteration {iteration + 1})",
+                    agent_name=self._name,
+                    agent_id=str(make_agent_identifier(self._name, self.protocol_type)),
+                )
+                llm_response = LLMResponse.ensure_llm_response(
+                    await self.llm_client.acompletion(
+                        messages, tools=tools_in_openai_format
+                    )
+                )
+
+                # If no response from LLM, return an error output.
+                if llm_response is None or not (
+                    llm_response.choices or llm_response.tool_calls
+                ):
+                    event_info = "No response from LLM."
+                    structlogger.warning(
+                        "mcp_task_agent.send_message.no_llm_response",
+                        event_info=event_info,
+                        agent_name=self._name,
+                        agent_id=str(
+                            make_agent_identifier(self._name, self.protocol_type)
+                        ),
+                    )
+                    return AgentOutput(
+                        id=agent_input.id,
+                        status=AgentStatus.RECOVERABLE_ERROR,
+                        error_message=event_info,
+                        tool_results=self._get_tool_results_for_agent_output(
+                            agent_input, tool_results
+                        ),
+                    )
+
+                # If no tool calls, return the response directly with input required.
+                if not llm_response.tool_calls and len(llm_response.choices) == 1:
+                    return AgentOutput(
+                        id=agent_input.id,
+                        status=AgentStatus.INPUT_REQUIRED,
+                        response_message=llm_response.choices[0],
+                        tool_results=self._get_tool_results_for_agent_output(
+                            agent_input, tool_results
+                        ),
+                    )
+
+                # If there are tool calls, process them.
+                if llm_response.tool_calls:
+                    # Add the assistant message with tool calls to the messages.
+                    messages.append(
+                        self._get_assistant_message_with_tool_calls(llm_response)
+                    )
+                    for tool_call in llm_response.tool_calls:
+                        structlogger.info(
+                            "mcp_task_agent.send_message.tool_call",
+                            event_info=(
+                                f"Processing tool call `{tool_call.tool_name}` with "
+                                f"args: {tool_call.tool_args}"
+                            ),
+                            tool_name=tool_call.tool_name,
+                            tool_args=json.dumps(tool_call.tool_args),
+                            agent_name=self._name,
+                            agent_id=str(
+                                make_agent_identifier(self._name, self.protocol_type)
+                            ),
+                        )
+
+                        # If the tool is not available, return a fatal error output.
+                        if tool_call.tool_name not in _available_tools_names:
+                            event_info = f"Tool {tool_call.tool_name} is not available."
+                            structlogger.error(
+                                "mcp_task_agent.send_message.tool_not_available",
+                                tool_name=tool_call.tool_name,
+                                event_info=event_info,
+                                user_message=agent_input.user_message,
+                            )
+                            return AgentOutput(
+                                id=agent_input.id,
+                                status=AgentStatus.FATAL_ERROR,
+                                error_message=event_info,
+                            )
+
+                        if slot_name := self._get_slot_name_from_tool_name(
+                            tool_call.tool_name
+                        ):
+                            if (
+                                slot_name in agent_input.slots
+                                and "slot_value" in tool_call.tool_args
+                            ):
+                                _slots.update(
+                                    self._run_set_slot_tool(
+                                        slot_name, tool_call.tool_args
+                                    )
+                                )
+
+                                # Add the tool call message to the messages for
+                                # slot-setting tools
+                                messages.append(
+                                    {
+                                        KEY_ROLE: ROLE_TOOL,
+                                        KEY_TOOL_CALL_ID: tool_call.id,
+                                        KEY_CONTENT: f"Slot {slot_name} set to "
+                                        f"{tool_call.tool_args.get('slot_value')}",
+                                    }
+                                )
+                            else:
+                                return AgentOutput(
+                                    id=agent_input.id,
+                                    status=AgentStatus.FATAL_ERROR,
+                                    error_message=(
+                                        f"The slot `{slot_name}` that the tool "
+                                        f"`{tool_call.tool_name}` is trying to set "
+                                        f"is not found in agent input."
+                                    ),
+                                )
+                        else:
+                            # Execute the tool call.
+                            tool_output = await self._execute_tool_call(
+                                tool_call.tool_name,
+                                tool_call.tool_args,
+                            )
+
+                            # If the tool call failed, generate an agent error output.
+                            if tool_output.is_error or tool_output.result is None:
+                                return self._generate_agent_error_output(
+                                    tool_output, agent_input, tool_call
+                                )
+
+                            # Store the tool output in the tool_results.
+                            tool_results[tool_call.id] = tool_output
+
+                            # Add the tool call message to the messages.
+                            messages.append(
+                                {
+                                    KEY_ROLE: ROLE_TOOL,
+                                    KEY_TOOL_CALL_ID: tool_call.id,
+                                    KEY_CONTENT: tool_output.result,
+                                }
+                            )
+
+                        exit_met, internal_error = self._is_exit_conditions_met(
+                            agent_input, _slots
+                        )
+
+                        # Agent signals task completion if exit conditions are met.
+                        if exit_met:
+                            return self._generate_agent_task_completed_output(
+                                agent_input, _slots, tool_results
+                            )
+
+                        # If an internal error occurred while checking the exit
+                        # conditions, return a fatal error output.
+                        if internal_error:
+                            return AgentOutput(
+                                id=agent_input.id,
+                                status=AgentStatus.FATAL_ERROR,
+                                response_message=(
+                                    "An internal error occurred while checking the "
+                                    "exit conditions."
+                                ),
+                                tool_results=self._get_tool_results_for_agent_output(
+                                    agent_input, tool_results
+                                ),
+                                error_message=internal_error,
+                            )
+
+            except Exception as e:
+                structlogger.error(
+                    "mcp_task_agent.send_message.error_in_agent_loop",
+                    event_info=f"Failed to send message: {e}",
+                    user_message=agent_input.user_message,
+                    agent_name=self._name,
+                    agent_id=str(make_agent_identifier(self._name, self.protocol_type)),
+                )
+                return AgentOutput(
+                    id=agent_input.id,
+                    status=AgentStatus.FATAL_ERROR,
+                    response_message=f"I encountered an error: {e!s}",
+                    tool_results=self._get_tool_results_for_agent_output(
+                        agent_input, tool_results
+                    ),
+                    error_message=str(e),
+                )
+        return AgentOutput(
+            id=agent_input.id,
+            status=AgentStatus.COMPLETED,
+            response_message=(
+                "I've completed my research but couldn't provide a final answer within"
+                "the allowed steps."
+            ),
+            tool_results=self._get_tool_results_for_agent_output(
+                agent_input, tool_results
+            ),
+        )

rasa/agents/schemas/__init__.py

@@ -0,0 +1,6 @@
+from rasa.agents.schemas.agent_input import AgentInput
+from rasa.agents.schemas.agent_output import AgentOutput
+from rasa.agents.schemas.agent_tool_result import AgentToolResult
+from rasa.agents.schemas.agent_tool_schema import AgentToolSchema
+
+__all__ = ["AgentInput", "AgentOutput", "AgentToolSchema", "AgentToolResult"]

rasa/agents/schemas/agent_input.py

@@ -0,0 +1,24 @@
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel
+
+from rasa.shared.core.events import Event
+
+
+class AgentInput(BaseModel):
+    """A class that represents the schema of the input to the agent."""
+
+    id: str
+    user_message: str
+    slots: Dict[str, Any]
+    conversation_history: str
+    events: List[Event]
+    metadata: Dict[str, Any]
+    timestamp: Optional[str] = None
+
+    class Config:
+        """Skip validation for Event class as pydantic does not know how to
+        serialize or handle instances of the class.
+        """
+
+        arbitrary_types_allowed = True

rasa/agents/schemas/agent_output.py

@@ -0,0 +1,26 @@
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel
+
+from rasa.agents.core.types import AgentStatus
+from rasa.shared.core.events import SlotSet
+
+
+class AgentOutput(BaseModel):
+    """A class that represents the schema of the output from the agent."""
+
+    id: str
+    status: AgentStatus
+    response_message: Optional[str] = None
+    events: Optional[List[SlotSet]] = None
+    tool_results: Optional[List[List[Dict[str, Any]]]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    timestamp: Optional[str] = None
+    error_message: Optional[str] = None
+
+    class Config:
+        """Skip validation for SlotSet class as pydantic does not know how to
+        serialize or handle instances of the class.
+        """
+
+        arbitrary_types_allowed = True

rasa/agents/schemas/agent_tool_result.py

@@ -0,0 +1,51 @@
+import json
+from typing import Optional
+
+from mcp.types import CallToolResult
+from pydantic import BaseModel
+
+
+class AgentToolResult(BaseModel):
+    tool_name: str
+    result: Optional[str] = None
+    is_error: bool = False
+    error_message: Optional[str] = None
+
+    @classmethod
+    def from_mcp_tool_result(
+        cls, tool_name: str, tool_result: CallToolResult
+    ) -> "AgentToolResult":
+        if tool_result.isError:
+            return cls(
+                tool_name=tool_name,
+                result=None,
+                is_error=tool_result.isError,
+                error_message=str(tool_result.content),
+            )
+
+        # try to use structured content if available
+        if tool_result.structuredContent:
+            return cls(
+                tool_name=tool_name,
+                result=json.dumps(tool_result.structuredContent),
+                is_error=tool_result.isError,
+            )
+        # fallback to content if structured content is not available
+        elif tool_result.content:
+            # TODO try to parse the content using the output schema defined
+            #   in the tool schema (if present)
+            return cls(
+                tool_name=tool_name,
+                result=json.dumps(
+                    [content.model_dump() for content in tool_result.content]
+                ),
+                is_error=tool_result.isError,
+            )
+        # if no content is available, return None
+        else:
+            return cls(
+                tool_name=tool_name,
+                result=None,
+                is_error=tool_result.isError,
+                error_message="No content returned from tool `{tool_name}`",
+            )

rasa/agents/schemas/agent_tool_schema.py

@@ -0,0 +1,112 @@
+from typing import Any, Dict, Optional
+
+from mcp import Tool
+from pydantic import BaseModel
+
+from rasa.agents.constants import (
+    TOOL_ADDITIONAL_PROPERTIES_KEY,
+    TOOL_DESCRIPTION_KEY,
+    TOOL_NAME_KEY,
+    TOOL_PARAMETERS_KEY,
+    TOOL_PROPERTIES_KEY,
+    TOOL_PROPERTY_TYPE_KEY,
+    TOOL_REQUIRED_KEY,
+    TOOL_STRICT_KEY,
+    TOOL_TYPE_FUNCTION_KEY,
+    TOOL_TYPE_KEY,
+)
+
+
+class AgentToolSchema(BaseModel):
+    name: str
+    parameters: dict[str, Any]
+    strict: bool
+    description: Optional[str] = None
+    type: str = "function"
+
+    @classmethod
+    def from_mcp_tool(cls, tool: Tool) -> "AgentToolSchema":
+        """Convert MCP Tool to AgentToolSchema."""
+        parameters = tool.inputSchema.copy() if tool.inputSchema else {}
+
+        if parameters:
+            cls._validate_and_fix_parameters(parameters)
+
+        return cls(
+            name=tool.name,
+            description=tool.description,
+            parameters=parameters,
+            strict=False,
+            type=TOOL_TYPE_FUNCTION_KEY,
+        )
+
+    @classmethod
+    def from_openai_json_format(cls, tool: Dict[str, Any]) -> "AgentToolSchema":
+        """Convert OpenAI dict format to AgentToolSchema."""
+        function_data = tool[TOOL_TYPE_FUNCTION_KEY]
+        parameters = function_data.get(TOOL_PARAMETERS_KEY, {})
+
+        if parameters:
+            cls._validate_and_fix_parameters(parameters)
+
+        return cls(
+            name=function_data[TOOL_NAME_KEY],
+            description=function_data[TOOL_DESCRIPTION_KEY],
+            parameters=parameters,
+            strict=function_data.get(TOOL_STRICT_KEY, False),
+            type=tool[TOOL_TYPE_KEY],
+        )
+
+    @staticmethod
+    def _validate_and_fix_parameters(parameters: Dict[str, Any]) -> None:
+        """Validate and fix parameters to ensure they meet OpenAI function calling
+        requirements."""
+        if not parameters:
+            return
+
+        # Ensure additionalProperties is set at the top level
+        if TOOL_ADDITIONAL_PROPERTIES_KEY not in parameters:
+            parameters[TOOL_ADDITIONAL_PROPERTIES_KEY] = False
+
+        # Ensure required is set at the top level
+        if TOOL_REQUIRED_KEY not in parameters:
+            parameters[TOOL_REQUIRED_KEY] = []
+
+        # Ensure all properties have types, required field and additionalProperties
+        if TOOL_PROPERTIES_KEY in parameters:
+            AgentToolSchema._ensure_property_types(parameters)
+
+    @staticmethod
+    def _ensure_property_types(parameters: Dict[str, Any]) -> None:
+        """Ensure all properties in parameters have a type defined and
+        additionalProperties is set."""
+        properties = parameters[TOOL_PROPERTIES_KEY]
+
+        if not properties:
+            return
+
+        for _, prop_schema in properties.items():
+            if not isinstance(prop_schema, dict):
+                continue
+
+            # Ensure the property has a type
+            if TOOL_PROPERTY_TYPE_KEY not in prop_schema:
+                prop_schema[TOOL_PROPERTY_TYPE_KEY] = "string"
+
+            # If it's an object type, ensure additionalProperties and required
+            # fields are set
+            if prop_schema[TOOL_PROPERTY_TYPE_KEY] == "object":
+                if TOOL_ADDITIONAL_PROPERTIES_KEY not in prop_schema:
+                    prop_schema[TOOL_ADDITIONAL_PROPERTIES_KEY] = False
+
+                # Ensure required key exists for object properties
+                if TOOL_REQUIRED_KEY not in prop_schema:
+                    prop_schema[TOOL_REQUIRED_KEY] = []
+
+    def to_openai_json_format(self) -> Dict[str, Any]:
+        """Convert AgentToolSchema to OpenAI format."""
+        # Ensure the schema is valid before conversion
+        return {
+            TOOL_TYPE_KEY: TOOL_TYPE_FUNCTION_KEY,
+            TOOL_TYPE_FUNCTION_KEY: self.model_dump(exclude={TOOL_TYPE_KEY}),
+        }

rasa/agents/templates/mcp_open_agent_prompt_template.jinja2

@@ -0,0 +1,15 @@
+You are a helpful assistant that should assist the user in the best possible way.
+
+### Primary Task
+{{ description }}
+
+### Instructions
+* Always make sure to output responses to the user in a clear, helpful format.
+* Always avoid asking multiple questions at once. Ask questions sequentially one at a time and wait for the user's response before proceeding to next question.
+* Always avoid making assumptions about what values to pass into tools. Ask for clarification if a user's request is ambiguous.
+* Once your primary task, described above, is completed, you must call the `task_completed` tool to signal that you have finished assisting the user. Do not end the conversation or indicate completion without the `task_completed` tool call.
+* Do NOT call the `task_completed` tool unless you're absolutely certain that your primary task (NOT the slot corrections, updates, etc), described above, is fully completed. Focus on the task given in the task description above.
+* Strictly avoid making up information or ability to take some action which is not available in `tool` provided.
+
+### Conversation history
+{{ conversation_history }}