forked from HomeLab/unraid-mcp
1751bc2984
Addresses issues found by 4 parallel review agents (code-reviewer,
silent-failure-hunter, type-design-analyzer, pr-test-analyzer).
Source fixes:
- core/utils.py: add public safe_display_url() (moved from tools/health.py)
- core/client.py: rename _redact_sensitive → redact_sensitive (public API)
- core/types.py: add SubscriptionData.__post_init__ for tz-aware datetime
enforcement; remove 6 unused type aliases (SystemHealth, APIResponse, etc.)
- subscriptions/manager.py: add exc_info=True to both except-Exception blocks;
add except ValueError break-on-config-error before retry loop; import
redact_sensitive by new public name
- subscriptions/resources.py: re-raise in autostart_subscriptions() so
ensure_subscriptions_started() doesn't permanently set _subscriptions_started
- subscriptions/diagnostics.py: except ToolError: raise before broad except;
use safe_display_url() instead of raw URL slice
- tools/health.py: move _safe_display_url to core/utils; add exc_info=True;
raise ToolError (not return dict) on ImportError
- tools/info.py: use get_args(INFO_ACTIONS) instead of INFO_ACTIONS.__args__
- tools/{array,docker,keys,notifications,rclone,storage,virtualization}.py:
add Literal-vs-ALL_ACTIONS sync check at import time
Test fixes:
- test_health.py: import safe_display_url from core.utils; update
test_diagnose_import_error_internal to expect ToolError (not error dict)
- test_storage.py: add 3 safe_get tests for zero/False/empty-string values
- test_subscription_manager.py: add TestCapLogContentSingleMassiveLine (2 tests)
- test_client.py: rename _redact_sensitive → redact_sensitive; add tests for
new sensitive keys and is_cacheable explicit-keyword form
57 lines
1.8 KiB
Python
57 lines
1.8 KiB
Python
"""Custom exceptions for Unraid MCP Server.
|
|
|
|
This module defines custom exception classes for consistent error handling
|
|
throughout the application, with proper integration to FastMCP's error system.
|
|
"""
|
|
|
|
import contextlib
|
|
import logging
|
|
from collections.abc import Iterator
|
|
|
|
from fastmcp.exceptions import ToolError as FastMCPToolError
|
|
|
|
|
|
class ToolError(FastMCPToolError):
|
|
"""User-facing error that MCP clients can handle.
|
|
|
|
This is the main exception type used throughout the application for
|
|
errors that should be presented to the user/LLM in a friendly way.
|
|
|
|
Inherits from FastMCP's ToolError to ensure proper MCP protocol handling.
|
|
"""
|
|
|
|
pass
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def tool_error_handler(
|
|
tool_name: str,
|
|
action: str,
|
|
logger: logging.Logger,
|
|
) -> Iterator[None]:
|
|
"""Context manager that standardizes tool error handling.
|
|
|
|
Re-raises ToolError as-is. Gives TimeoutError a descriptive message.
|
|
Catches all other exceptions, logs them with full traceback, and wraps them
|
|
in ToolError with a descriptive message.
|
|
|
|
Args:
|
|
tool_name: The tool name for error messages (e.g., "docker", "vm").
|
|
action: The current action being executed.
|
|
logger: The logger instance to use for error logging.
|
|
"""
|
|
try:
|
|
yield
|
|
except ToolError:
|
|
raise
|
|
except TimeoutError as e:
|
|
logger.exception(f"Timeout in unraid_{tool_name} action={action}: request exceeded time limit")
|
|
raise ToolError(
|
|
f"Request timed out executing {tool_name}/{action}. The Unraid API did not respond in time."
|
|
) from e
|
|
except Exception as e:
|
|
logger.exception(f"Error in unraid_{tool_name} action={action}")
|
|
raise ToolError(
|
|
f"Failed to execute {tool_name}/{action}. Check server logs for details."
|
|
) from e
|