mcp-ticketer 0.1.30__py3-none-any.whl → 1.2.11__py3-none-any.whl

mcp_ticketer/mcp/server/tools/user_ticket_tools.py

@@ -0,0 +1,547 @@
+"""User-specific ticket management tools.
+
+This module provides tools for managing tickets from a user's perspective,
+including listing assigned tickets and transitioning tickets through workflow
+states with validation.
+
+Design Decision: Workflow State Validation
+------------------------------------------
+State transitions are validated using TicketState.can_transition_to() to ensure
+tickets follow the defined workflow. This prevents invalid state changes that
+could break integrations or confuse team members.
+
+Valid workflow transitions:
+- OPEN → IN_PROGRESS, WAITING, BLOCKED, CLOSED
+- IN_PROGRESS → READY, WAITING, BLOCKED, OPEN
+- READY → TESTED, IN_PROGRESS, BLOCKED
+- TESTED → DONE, IN_PROGRESS
+- DONE → CLOSED
+- WAITING/BLOCKED → OPEN, IN_PROGRESS, CLOSED
+- CLOSED → (no transitions, terminal state)
+
+Performance Considerations:
+- get_my_tickets uses adapter's native filtering when available
+- Falls back to client-side filtering for adapters without assignee filter
+- State transition validation is O(1) lookup in predefined state machine
+"""
+
+from pathlib import Path
+from typing import Any
+
+from ....core.adapter import BaseAdapter
+from ....core.models import TicketState
+from ....core.project_config import ConfigResolver, TicketerConfig
+from ....core.state_matcher import get_state_matcher
+from ..server_sdk import get_adapter, mcp
+
+
+def _build_adapter_metadata(
+    adapter: BaseAdapter,
+    ticket_id: str | None = None,
+) -> dict[str, Any]:
+    """Build adapter metadata for MCP responses."""
+    metadata = {
+        "adapter": adapter.adapter_type,
+        "adapter_name": adapter.adapter_display_name,
+    }
+    if ticket_id:
+        metadata["ticket_id"] = ticket_id
+    return metadata
+
+
+def get_config_resolver() -> ConfigResolver:
+    """Get configuration resolver for current project.
+
+    Returns:
+        ConfigResolver instance for current working directory
+
+    """
+    return ConfigResolver(project_path=Path.cwd())
+
+
+@mcp.tool()
+async def get_my_tickets(
+    state: str | None = None,
+    limit: int = 10,
+) -> dict[str, Any]:
+    """Get tickets assigned to the configured default user.
+
+    Retrieves tickets assigned to the user specified in default_user configuration.
+    Requires default_user to be set via config_set_default_user().
+
+    Args:
+        state: Optional state filter - must be one of: open, in_progress, ready,
+            tested, done, closed, waiting, blocked
+        limit: Maximum number of tickets to return (default: 10, max: 100)
+
+    Returns:
+        Dictionary containing:
+        - status: "completed" or "error"
+        - tickets: List of ticket objects assigned to user
+        - count: Number of tickets returned
+        - user: User ID that was queried
+        - state_filter: State filter applied (if any)
+        - error: Error details (if failed)
+
+    Example:
+        >>> result = await get_my_tickets(state="in_progress", limit=5)
+        >>> print(result)
+        {
+            "status": "completed",
+            "tickets": [
+                {"id": "TICKET-1", "title": "Fix bug", "state": "in_progress"},
+                {"id": "TICKET-2", "title": "Add feature", "state": "in_progress"}
+            ],
+            "count": 2,
+            "user": "user@example.com",
+            "state_filter": "in_progress"
+        }
+
+    Error Conditions:
+        - No default user configured: Returns error with setup instructions
+        - Invalid state: Returns error with valid state options
+        - Adapter query failure: Returns error with details
+
+    Usage Notes:
+        - Requires default_user to be set in configuration
+        - Use config_set_default_user() to configure the user first
+        - Limit is capped at 100 to prevent performance issues
+
+    """
+    try:
+        # Validate limit
+        if limit > 100:
+            limit = 100
+
+        # Load configuration to get default user
+        resolver = get_config_resolver()
+        config = resolver.load_project_config() or TicketerConfig()
+
+        if not config.default_user:
+            return {
+                "status": "error",
+                "error": "No default user configured. Use config_set_default_user() to set a default user first.",
+                "setup_command": "config_set_default_user",
+            }
+
+        # Validate state if provided
+        state_filter = None
+        if state is not None:
+            try:
+                state_filter = TicketState(state.lower())
+            except ValueError:
+                valid_states = [s.value for s in TicketState]
+                return {
+                    "status": "error",
+                    "error": f"Invalid state '{state}'. Must be one of: {', '.join(valid_states)}",
+                    "valid_states": valid_states,
+                }
+
+        # Build filters
+        filters: dict[str, Any] = {"assignee": config.default_user}
+        if state_filter:
+            filters["state"] = state_filter
+
+        # Query adapter
+        adapter = get_adapter()
+        tickets = await adapter.list(limit=limit, offset=0, filters=filters)
+
+        return {
+            "status": "completed",
+            **_build_adapter_metadata(adapter),
+            "tickets": [ticket.model_dump() for ticket in tickets],
+            "count": len(tickets),
+            "user": config.default_user,
+            "state_filter": state if state else "all",
+            "limit": limit,
+        }
+    except Exception as e:
+        return {
+            "status": "error",
+            "error": f"Failed to retrieve tickets: {str(e)}",
+        }
+
+
+@mcp.tool()
+async def get_available_transitions(ticket_id: str) -> dict[str, Any]:
+    """Get valid next states for a ticket based on workflow rules.
+
+    Retrieves the ticket's current state and returns all valid target states
+    according to the defined workflow state machine. This helps AI agents and
+    users understand which state transitions are allowed.
+
+    Args:
+        ticket_id: Unique identifier of the ticket
+
+    Returns:
+        Dictionary containing:
+        - status: "completed" or "error"
+        - ticket_id: ID of the queried ticket
+        - current_state: Current workflow state
+        - available_transitions: List of valid target states
+        - transition_descriptions: Human-readable descriptions of each transition
+        - error: Error details (if failed)
+
+    Example:
+        >>> result = await get_available_transitions("TICKET-123")
+        >>> print(result)
+        {
+            "status": "completed",
+            "ticket_id": "TICKET-123",
+            "current_state": "in_progress",
+            "available_transitions": ["ready", "waiting", "blocked", "open"],
+            "transition_descriptions": {
+                "ready": "Mark work as complete and ready for review",
+                "waiting": "Pause work while waiting for external dependency",
+                "blocked": "Work is blocked by an impediment",
+                "open": "Move back to backlog"
+            }
+        }
+
+    Error Conditions:
+        - Ticket not found: Returns error with ticket ID
+        - Adapter query failure: Returns error with details
+        - Terminal state (CLOSED): Returns empty transitions list
+
+    Usage Notes:
+        - CLOSED is a terminal state with no valid transitions
+        - Use this before ticket_transition() to validate intended state change
+        - Transition validation prevents workflow violations
+
+    """
+    try:
+        # Get ticket from adapter
+        adapter = get_adapter()
+        ticket = await adapter.read(ticket_id)
+
+        if ticket is None:
+            return {
+                "status": "error",
+                "error": f"Ticket {ticket_id} not found",
+            }
+
+        # Get current state
+        current_state = ticket.state
+
+        # Get valid transitions from state machine
+        valid_transitions = TicketState.valid_transitions()
+        # Handle both TicketState enum and string values
+        if isinstance(current_state, str):
+            current_state = TicketState(current_state)
+        available = valid_transitions.get(current_state, [])
+
+        # Create human-readable descriptions
+        descriptions = {
+            TicketState.OPEN: "Move to backlog (not yet started)",
+            TicketState.IN_PROGRESS: "Begin active work on ticket",
+            TicketState.READY: "Mark as complete and ready for review/testing",
+            TicketState.TESTED: "Mark as tested and verified",
+            TicketState.DONE: "Mark as complete and accepted",
+            TicketState.WAITING: "Pause work while waiting for external dependency",
+            TicketState.BLOCKED: "Work is blocked by an impediment",
+            TicketState.CLOSED: "Close and archive ticket (final state)",
+        }
+
+        transition_descriptions = {
+            state.value: descriptions.get(state, "") for state in available
+        }
+
+        return {
+            "status": "completed",
+            **_build_adapter_metadata(adapter, ticket_id),
+            "current_state": current_state.value,
+            "available_transitions": [state.value for state in available],
+            "transition_descriptions": transition_descriptions,
+            "is_terminal": len(available) == 0,
+        }
+    except Exception as e:
+        return {
+            "status": "error",
+            "error": f"Failed to get available transitions: {str(e)}",
+        }
+
+
+@mcp.tool()
+async def ticket_transition(
+    ticket_id: str,
+    to_state: str,
+    comment: str | None = None,
+    auto_confirm: bool = True,
+) -> dict[str, Any]:
+    """Move ticket through workflow with validation and optional comment.
+
+    Supports natural language state inputs with semantic matching.
+    Transitions a ticket to a new state, validating the transition against the
+    defined workflow rules. Optionally adds a comment explaining the transition.
+
+    Semantic State Matching:
+        - Accepts natural language: "working on it" → IN_PROGRESS
+        - Handles typos: "reviw" → READY
+        - Provides suggestions for ambiguous inputs
+        - Confidence-based handling (high/medium/low)
+
+    Workflow State Machine:
+        OPEN → IN_PROGRESS, WAITING, BLOCKED, CLOSED
+        IN_PROGRESS → READY, WAITING, BLOCKED, OPEN
+        READY → TESTED, IN_PROGRESS, BLOCKED
+        TESTED → DONE, IN_PROGRESS
+        DONE → CLOSED
+        WAITING → OPEN, IN_PROGRESS, CLOSED
+        BLOCKED → OPEN, IN_PROGRESS, CLOSED
+        CLOSED → (no transitions)
+
+    Args:
+        ticket_id: Unique identifier of the ticket to transition
+        to_state: Target state (supports natural language!)
+            Examples: "working on it", "needs review", "finished", "review"
+        comment: Optional comment explaining the transition reason
+        auto_confirm: Auto-apply high confidence matches (default: True)
+
+    Returns:
+        Dictionary containing:
+        - status: "completed", "needs_confirmation", or "error"
+        - ticket: Updated ticket object with new state (if completed)
+        - previous_state: State before transition
+        - new_state: State after transition
+        - matched_state: Matched state from input (if semantic match used)
+        - confidence: Confidence score (0.0-1.0) for semantic matches
+        - original_input: Original user input
+        - suggestions: Alternative matches (for ambiguous inputs)
+        - comment_added: Whether a comment was added (if applicable)
+        - error: Error details (if failed)
+
+    Example:
+        >>> # Natural language input
+        >>> result = await ticket_transition(
+        ...     "TICKET-123",
+        ...     "working on it",
+        ...     "Started implementation"
+        ... )
+        >>> print(result)
+        {
+            "status": "completed",
+            "ticket": {"id": "TICKET-123", "state": "in_progress", ...},
+            "previous_state": "open",
+            "new_state": "in_progress",
+            "matched_state": "in_progress",
+            "confidence": 0.95,
+            "original_input": "working on it",
+            "comment_added": True
+        }
+
+        >>> # Ambiguous input returns suggestions
+        >>> result = await ticket_transition("TICKET-123", "rev")
+        >>> print(result)
+        {
+            "status": "needs_confirmation",
+            "matched_state": "ready",
+            "confidence": 0.75,
+            "suggestions": [
+                {"state": "ready", "confidence": 0.75},
+                {"state": "reviewed", "confidence": 0.60}
+            ]
+        }
+
+    Error Conditions:
+        - Ticket not found: Returns error with ticket ID
+        - Invalid transition: Returns error with valid options
+        - Invalid state name: Returns error with valid states
+        - Adapter update failure: Returns error with details
+
+    Usage Notes:
+        - Use get_available_transitions() first to see valid options
+        - Comments are adapter-dependent (some may not support them)
+        - Validation prevents workflow violations
+        - Terminal state (CLOSED) has no valid transitions
+        - High confidence (≥0.90): Auto-applied
+        - Medium confidence (0.70-0.89): Needs confirmation (if auto_confirm=False)
+        - Low confidence (<0.70): Returns suggestions
+
+    """
+    try:
+        # Get ticket from adapter
+        adapter = get_adapter()
+        ticket = await adapter.read(ticket_id)
+
+        if ticket is None:
+            return {
+                "status": "error",
+                "error": f"Ticket {ticket_id} not found",
+            }
+
+        # Store current state for response
+        current_state = ticket.state
+        # Handle both TicketState enum and string values
+        if isinstance(current_state, str):
+            current_state = TicketState(current_state)
+
+        # Use semantic matcher to resolve target state
+        matcher = get_state_matcher()
+        match_result = matcher.match_state(to_state)
+
+        # Build response with semantic match info
+        response: dict[str, Any] = {
+            "ticket_id": ticket_id,
+            "original_input": to_state,
+            "matched_state": match_result.state.value,
+            "confidence": match_result.confidence,
+            "match_type": match_result.match_type,
+            "current_state": current_state.value,
+        }
+
+        # Handle low confidence - provide suggestions
+        if match_result.is_low_confidence():
+            suggestions = matcher.suggest_states(to_state, top_n=3)
+            return {
+                **response,
+                "status": "ambiguous",
+                "message": "Input is ambiguous. Please choose from suggestions.",
+                "suggestions": [
+                    {
+                        "state": s.state.value,
+                        "confidence": s.confidence,
+                        "description": _get_state_description(s.state),
+                    }
+                    for s in suggestions
+                ],
+            }
+
+        # Handle medium confidence - needs confirmation unless auto_confirm
+        if match_result.is_medium_confidence() and not auto_confirm:
+            return {
+                **response,
+                "status": "needs_confirmation",
+                "message": f"Matched '{to_state}' to '{match_result.state.value}' with {match_result.confidence:.0%} confidence. Please confirm.",
+                "confirm_required": True,
+            }
+
+        target_state = match_result.state
+
+        # Validate transition using adapter (includes parent/child state constraints)
+        is_valid = await adapter.validate_transition(ticket_id, target_state)
+        if not is_valid:
+            # Check if it's a workflow violation or parent constraint violation
+            workflow_valid = current_state.can_transition_to(target_state)
+            valid_transitions = TicketState.valid_transitions().get(current_state, [])
+            valid_values = [s.value for s in valid_transitions]
+
+            if workflow_valid:
+                # Workflow is valid, so this must be a parent constraint violation
+                # Get children to determine max child state
+                from ....core.models import Task
+
+                if isinstance(ticket, Task) and ticket.children:
+                    try:
+                        children = await adapter.list_tasks_by_issue(ticket_id)
+                        if children:
+                            max_child_state = None
+                            max_child_level = 0
+                            for child in children:
+                                child_state = child.state
+                                if isinstance(child_state, str):
+                                    try:
+                                        child_state = TicketState(child_state)
+                                    except ValueError:
+                                        continue
+                                child_level = child_state.completion_level()
+                                if child_level > max_child_level:
+                                    max_child_level = child_level
+                                    max_child_state = child_state
+
+                            return {
+                                **response,
+                                "status": "error",
+                                "error": f"Cannot transition to '{target_state.value}': parent issue has children in higher completion states",
+                                "reason": "parent_constraint_violation",
+                                "max_child_state": (
+                                    max_child_state.value if max_child_state else None
+                                ),
+                                "message": f"Cannot transition to {target_state.value}: "
+                                f"parent issue has children in higher completion states (max child state: {max_child_state.value if max_child_state else 'unknown'}). "
+                                f"Please update child states first.",
+                                "valid_transitions": valid_values,
+                            }
+                    except Exception:
+                        # Fallback to generic message if we can't determine child states
+                        pass
+
+                # Generic parent constraint violation message
+                return {
+                    **response,
+                    "status": "error",
+                    "error": f"Cannot transition to '{target_state.value}': parent/child state constraint violation",
+                    "reason": "parent_constraint_violation",
+                    "message": f"Cannot transition to {target_state.value}: "
+                    f"parent issue has children in higher completion states. Please update child states first.",
+                    "valid_transitions": valid_values,
+                }
+            else:
+                # Workflow violation
+                return {
+                    **response,
+                    "status": "error",
+                    "error": f"Invalid transition from '{current_state.value}' to '{target_state.value}'",
+                    "reason": "workflow_violation",
+                    "valid_transitions": valid_values,
+                    "message": f"Cannot transition from {current_state.value} to {target_state.value}. "
+                    f"Valid transitions: {', '.join(valid_values) if valid_values else 'none (terminal state)'}",
+                }
+
+        # Update ticket state
+        updated = await adapter.update(ticket_id, {"state": target_state})
+
+        if updated is None:
+            return {
+                **response,
+                "status": "error",
+                "error": f"Failed to update ticket {ticket_id}",
+            }
+
+        # Add comment if provided and adapter supports it
+        comment_added = False
+        if comment and hasattr(adapter, "add_comment"):
+            try:
+                await adapter.add_comment(ticket_id, comment)
+                comment_added = True
+            except Exception:
+                # Log but don't fail the transition
+                comment_added = False
+
+        return {
+            **response,
+            **_build_adapter_metadata(adapter, ticket_id),
+            "status": "completed",
+            "ticket": updated.model_dump(),
+            "previous_state": current_state.value,
+            "new_state": target_state.value,
+            "comment_added": comment_added,
+            "message": f"Ticket {ticket_id} transitioned from {current_state.value} to {target_state.value}",
+        }
+    except Exception as e:
+        return {
+            "status": "error",
+            "error": f"Failed to transition ticket: {str(e)}",
+        }
+
+
+def _get_state_description(state: TicketState) -> str:
+    """Get human-readable description of a state.
+
+    Args:
+        state: TicketState to describe
+
+    Returns:
+        Description string
+
+    """
+    descriptions = {
+        TicketState.OPEN: "Work not yet started, in backlog",
+        TicketState.IN_PROGRESS: "Work is actively being done",
+        TicketState.READY: "Work complete, ready for review or testing",
+        TicketState.TESTED: "Work has been tested and verified",
+        TicketState.DONE: "Work is complete and accepted",
+        TicketState.WAITING: "Work paused, waiting for external dependency",
+        TicketState.BLOCKED: "Work blocked by an impediment",
+        TicketState.CLOSED: "Ticket closed or archived (final state)",
+    }
+    return descriptions.get(state, "")

mcp_ticketer/queue/__init__.py

@@ -1,5 +1,6 @@
 """Async queue system for mcp-ticketer."""
 
+# Import manager last to avoid circular import
 from .manager import WorkerManager
 from .queue import Queue, QueueItem, QueueStatus
 from .worker import Worker