Skip to content

docs: Add workflow MCP functions design document#69

Merged
xerial merged 2 commits intomainfrom
add-workflow-mcp-design
Jun 30, 2025
Merged

docs: Add workflow MCP functions design document#69
xerial merged 2 commits intomainfrom
add-workflow-mcp-design

Conversation

@xerial
Copy link
Member

@xerial xerial commented Jun 30, 2025

Summary

Add design specification for new MCP tools to monitor Digdag workflow execution states and retrieve failure data.

Changes

  • Added doc/design/2025-06-30-workflow-mcp-functions.md containing the design for workflow monitoring MCP functions

Design Overview

The design document specifies 9 new MCP tools:

Workflow Monitoring

  • list_workflows - List all workflows with status
  • list_sessions - List workflow execution sessions
  • get_session_attempts - Get attempt details
  • get_attempt_tasks - List tasks with execution status

Failure Analysis

  • get_task_logs - Retrieve task-specific logs
  • get_attempt_logs - Get aggregated attempt logs

Workflow Control

  • kill_attempt - Cancel running attempts
  • retry_session - Retry failed sessions
  • retry_attempt - Retry specific attempts with resume

Key Features

  • Comprehensive API endpoint pattern support for all TD regions and environments
  • Authentication using existing TD API key mechanism (TD1 prefix)
  • Read-only by default following existing security patterns
  • Detailed error handling and audit logging
  • Support for retry and recovery operations

Related Issue

Addresses #68

🤖 Generated with Claude Code

Add design specification for new MCP tools to monitor Digdag workflow
execution states and retrieve failure data. The design includes:

- 9 MCP tools for workflow monitoring, failure analysis, and retry operations
- Comprehensive API endpoint resolution supporting all TD regions and environments
- Authentication using existing TD API key mechanism
- Error handling and security considerations
- Testing plan for implementation

Addresses #68

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Mask sensitive information in error responses

### Configuration
- Workflow API endpoints follow the pattern based on the base API URL:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use TD_SITE env as in the other functions

Add link to the official Digdag REST API documentation as requested
in PR review.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@xerial xerial merged commit 678492c into main Jun 30, 2025
5 checks passed
@xerial xerial deleted the add-workflow-mcp-design branch June 30, 2025 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant