handler_helpers.py•1.47 kB
"""
Handler helper functions for MCP tool handlers (QUA-004).
Provides utility functions for common handler operations like response formatting.
These helpers ensure consistency across all tool handlers.
Usage:
from handler_helpers import format_success_response
result = format_success_response(
data={'files': files_list, 'count': len(files_list)},
message="✅ Operation completed successfully"
)
"""
from mcp.types import TextContent
import json
# QUA-004: Success Response Helper
def format_success_response(data: dict, message: str = None) -> list[TextContent]:
"""
Helper function for formatting consistent success responses (QUA-004).
Formats handler success responses as JSON-formatted TextContent.
Provides consistent structure across all tool handlers.
Args:
data: Dictionary containing response data
message: Optional success message to prepend
Returns:
List containing single TextContent with JSON-formatted response
Example:
return format_success_response(
data={'files': files_list, 'count': len(files_list)},
message="✅ Operation completed successfully"
)
"""
if message:
# Prepend message to JSON data
result = f"{message}\n\n{json.dumps(data, indent=2)}"
else:
# Just format as JSON
result = json.dumps(data, indent=2)
return [TextContent(type="text", text=result)]