o
�?%i� � @ s\ d Z ddlmZ ddlmZmZ ddlmZ ddlm Z ddl
m Z m Z G dd� de�Z
d S )
zHAbstract base class for tool handlers following the ToolHandler pattern.� )� annotations)�ABC�abstractmethod)�Sequence)�Any)� TextContent�Toolc @ sn e Zd ZU dZdZded< dZded< ed dd ��Zed!d
d��Z d"dd�Z
d#dd�Z d$dd�Z d%d d �Z
d S )&� ToolHandlera�
Abstract base class for MCP tool handlers.
This pattern allows for modular organization of tools where each handler
is responsible for defining its schema and executing its logic.
Subclasses must implement:
- name: The unique tool name
- description: Human-readable description
- get_tool_definition(): Returns the Tool schema
- run_tool(): Executes the tool logic
Example:
class MyToolHandler(ToolHandler):
name = "my_tool"
description = "Does something useful"
def get_tool_definition(self) -> Tool:
return Tool(
name=self.name,
description=self.description,
inputSchema={
"type": "object",
"properties": {
"param": {"type": "string", "description": "A parameter"}
},
"required": ["param"]
}
)
async def run_tool(self, arguments: dict[str, Any]) -> Sequence[TextContent]:
result = do_something(arguments["param"])
return [TextContent(type="text", text=result)]
� �str�name� description�returnr c C s dS )z�
Return the MCP Tool definition including input schema.
Returns:
Tool: The tool definition with name, description, and inputSchema
N� )�selfr r �R/home/azureuser/mcp_pg_tuning_expert/src/mcp_pg_tuning_expert/tools/toolhandler.py�get_tool_definition3 s z ToolHandler.get_tool_definition� arguments�dict[str, Any]�Sequence[TextContent]c � s �dS )aw
Execute the tool logic with the provided arguments.
Args:
arguments: Dictionary of arguments matching the input schema
Returns:
Sequence[TextContent]: The tool output as text content
Raises:
ValueError: If required arguments are missing or invalid
Exception: If tool execution fails
Nr )r r r r r �run_tool= s �zToolHandler.run_tool�required� list[str]�Nonec s. � fdd�|D �}|rt dd�|�� ���dS )a
Validate that required arguments are present.
Args:
arguments: The arguments dictionary to validate
required: List of required argument names
Raises:
ValueError: If any required argument is missing
c s$ g | ]}|� vs� | d u r|�qS )Nr )�.0�arg�r r r �
<listcomp>] s $ z6ToolHandler.validate_required_args.<locals>.<listcomp>z Missing required arguments: z, N)�
ValueError�join)r r r �missingr r r �validate_required_argsN s �z"ToolHandler.validate_required_args�error� Exceptionc C s t ddt|�� �d�gS )z�
Format an error as TextContent for tool response.
Args:
error: The exception to format
Returns:
Sequence[TextContent]: Error message as text content
�textzError: ��typer$ )r r )r r" r r r � format_errora s
zToolHandler.format_error�resultc C s t d|d�gS )z�
Format a string result as TextContent.
Args:
result: The result string to format
Returns:
Sequence[TextContent]: Result as text content
r$ r% )r )r r( r r r �
format_resultm s
zToolHandler.format_result�datar c C s" ddl }td|j|dtd�d�gS )z�
Format data as JSON TextContent.
Args:
data: The data to serialize as JSON
Returns:
Sequence[TextContent]: JSON-formatted text content
r Nr$ � )�indent�defaultr% )�jsonr �dumpsr )r r* r. r r r �format_json_resulty s
z ToolHandler.format_json_resultN)r r )r r r r )r r r r r r )r" r# r r )r( r r r )r* r r r )�__name__�
__module__� __qualname__�__doc__r �__annotations__r
r r r r! r' r) r0 r r r r r s
#
r N)r4 �
__future__r �abcr r �collections.abcr �typingr � mcp.typesr r r r r r r �<module> s
