Skip to content

ptnghia/TaskFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

33 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

TaskFlow MCP Server

License: MIT Node.js Version TypeScript

Universal Task Management for Any Project

A Model Context Protocol (MCP) server that provides automated task management with GitHub Copilot integration. Control your entire workflow using natural language - no CLI commands needed.

Works with: Laravel, Node.js, Python, React, Vue, Angular, .NET, Go, Rust, and any project type!

โœจ Features

  • ๐Ÿค– GitHub Copilot Integration - Control everything via natural language chat
  • ๐ŸŒ Multilingual Support - English and Vietnamese (Tiแบฟng Viแป‡t)
  • ๐ŸŽฏ Auto-generated Copilot Instructions - Zero configuration, ready immediately after setup
  • ๐Ÿ“‹ Smart Task Management - Create, track, and complete tasks with AI assistance
  • ๐Ÿ”„ Workflow Automation - Automatic status updates, git commits, and progress tracking
  • ๐ŸŽฏ Task Dependencies - Track relationships and validate circular dependencies
  • ๐Ÿ“Š Real-time Dashboard - Statistics, progress metrics, and task overview
  • โšก High Performance - 99% faster with caching and indexing (tested with 100+ tasks)
  • ๐Ÿ”— Git Integration - Auto-commit and push when completing tasks
  • ๐Ÿ“š Documentation Generation - Auto-generate changelogs, API docs, and architecture overviews
  • ๐Ÿ›๏ธ Architecture Decisions - Record and track ADRs with full-text search
  • ๐ŸŒ Universal Support - Works with any programming language or framework

๐Ÿš€ Quick Start

Installation

npm install -g @ptnghia/taskflow-mcp

Note: The old package taskflow-mcp (v1.0.32) is outdated. Use @ptnghia/taskflow-mcp for latest v1.10.0 with 54 tools.

Verify your version:

npm list -g @ptnghia/taskflow-mcp
# Should show: @ptnghia/taskflow-mcp@1.10.0

Windows Users: If you get "command not found" after installation, you may need to:

  1. Close and reopen PowerShell/Terminal
  2. Or restart VS Code
  3. Or add npm global bin to PATH (see troubleshooting below)

Initialize in Your Project

cd /path/to/your/project
taskflow init

Troubleshooting "taskflow command not found": See Common Issues section below.

The wizard will:

  • Auto-detect your project type (Laravel, Node.js, React, etc.)
  • Select your preferred language (English or Vietnamese)
  • Create .plans/ directory structure
  • Generate taskflow.config.json
  • Set up task templates
  • Auto-create .github/copilot-instructions.md - GitHub Copilot ready immediately!

Configure VS Code

Add to your project's .vscode/mcp.json:

{
  "servers": {
    "taskflow": {
      "command": "node",
      "args": [
        "/usr/local/lib/node_modules/taskflow-mcp/dist/index.js"
      ],
      "env": {
        "WORKSPACE_ROOT": "${workspaceFolder}"
      }
    }
  }
}

Important: Update the path in args based on your installation:

  • Linux/macOS global: /usr/local/lib/node_modules/taskflow-mcp/dist/index.js
  • Windows global: C:\\Users\\YourUsername\\AppData\\Roaming\\npm\\node_modules\\taskflow-mcp\\dist\\index.js
  • Local install: ${workspaceFolder}/node_modules/taskflow-mcp/dist/index.js

See .vscode-example/mcp.json.example for detailed examples and configuration options.

Finding Your Installation Path

# Find npm global modules location
npm root -g
# Append: /taskflow-mcp/dist/index.js to the output

Enabling Advanced Tools (Optional)

To enable all 54 tools (default is 40 core tools), add to env:

"env": {
  "WORKSPACE_ROOT": "${workspaceFolder}",
  "TASKFLOW_ENABLE_ADVANCED_TOOLS": "true"
}

This enables 14 additional tools: batch operations, rebuilds, template CRUD, detailed views, and utilities. See TOOLS_ORGANIZATION.md for complete list.

Reload VS Code

Press Ctrl+Shift+P โ†’ "Developer: Reload Window"

Verify Installation

Open GitHub Copilot Chat and try:

๐Ÿ’ฌ "List all active tasks"
๐Ÿ’ฌ "Show task statistics"

If you see TaskFlow responding, you're all set! ๐ŸŽ‰

๐Ÿ’ฌ Usage Examples

Control TaskFlow using natural language with GitHub Copilot Chat:

Create Tasks

๐Ÿ’ฌ "Create a feature task for User Authentication with high priority"
๐Ÿ’ฌ "Add a bug fix task for login validation issue"

Manage Workflow

๐Ÿ’ฌ "List all active tasks"
๐Ÿ’ฌ "Show me task #001"
๐Ÿ’ฌ "Start task #002"
๐Ÿ’ฌ "Complete task #002"  โ†’ Auto commits & pushes!

Track Dependencies & Relationships ๐Ÿ†•

๐Ÿ’ฌ "Task #005 depends on task #003"
๐Ÿ’ฌ "Link task #017 as parent of task #015"
๐Ÿ’ฌ "Task #012 is related to task #010"
๐Ÿ’ฌ "Show relationships for task #017 with transitive data"
๐Ÿ’ฌ "Find all tasks related to task #015"
๐Ÿ’ฌ "Validate dependencies for all tasks"

Get Insights

๐Ÿ’ฌ "Show task statistics"
๐Ÿ’ฌ "Generate a changelog for this month"
๐Ÿ’ฌ "Analyze codebase structure"

Learn from Mistakes (v1.6.0)

๐Ÿ’ฌ "Record lesson: TypeScript shebang breaks vitest"
๐Ÿ’ฌ "List all lessons about testing"
๐Ÿ’ฌ "Search lessons for 'circular dependency'"
๐Ÿ’ฌ "Get lessons context for typescript errors"

AI-Powered Features (v1.7.0-v1.9.0) ๐Ÿค–

๐Ÿ’ฌ "Recommend next task to work on"
๐Ÿ’ฌ "Break down task #015 into subtasks"
๐Ÿ’ฌ "Generate insights from all testing lessons"
๐Ÿ’ฌ "Find reusable code snippets in the project"
๐Ÿ’ฌ "Suggest refactoring opportunities"
๐Ÿ’ฌ "Generate test cases for UserController"
๐Ÿ’ฌ "Predict project bottlenecks"
๐Ÿ’ฌ "Estimate completion time for task #020"
๐Ÿ’ฌ "Build knowledge graph of tasks and decisions"

Tool Organization (v1.10.0) ๐ŸŽฏ

By default, TaskFlow shows 40 core tools for a clean experience. Enable all 54 tools by adding to .vscode/mcp.json:

"env": {
  "WORKSPACE_ROOT": "${workspaceFolder}",
  "TASKFLOW_ENABLE_ADVANCED_TOOLS": "true"
}

Advanced Tools (14):

  • batch-update-tasks - Update multiple tasks at once
  • rebuild-index - Rebuild task index
  • check-git-status - Check git repository status
  • create-project-vision - Create project vision document
  • sync-todo-list - Sync todo list with tasks
  • generate-documentation - Generate project documentation
  • get-decision - Get detailed ADR content
  • get-lesson - Get detailed lesson content
  • get-lessons-context - Get context from lessons
  • find-related-tasks - Find related tasks
  • create-custom-template - Create custom task template
  • delete-custom-template - Delete custom template
  • validate-step - Alias for mark-step
  • taskflow-mark - Alias for mark-step

๐Ÿ“š See TOOLS_ORGANIZATION.md for complete documentation.

๐ŸŽฏ Key Benefits

  • โฑ๏ธ Save Time - Automate repetitive task operations
  • ๐Ÿง  Stay Focused - Natural language interface, no context switching
  • ๐Ÿ“ˆ Track Progress - Real-time statistics and visualization
  • ๐Ÿค Collaborate - Clear task structure for team coordination
  • ๐Ÿ”’ Never Lose Work - Automatic git integration and backups

๐Ÿ“š Documentation

Core Features

  • 54 MCP Tools - Complete task lifecycle management with smart organization
    • 40 Core Tools (always enabled) - Essential features for daily workflow
      • 13 Task Management tools (create, list, get, search, start, complete, etc.)
      • 5 Context & Vision tools (dashboard, stats, project vision, analyze codebase)
      • 3 Architecture Decision tools (record, list, search)
      • 3 Lessons Learned tools (record, list, search)
      • 3 Task Relationship tools (link, unlink, get relationships)
      • 2 Template tools (list, get content)
      • 3 AI Smart Recommendations ๐Ÿค– (recommend next task, suggest breakdown, lesson insights)
      • 3 Code Intelligence ๐Ÿง  (code snippets, refactoring suggestions, test generation)
      • 3 Predictive Analytics ๐Ÿ”ฎ (bottleneck prediction, time estimation, knowledge graph)
    • 14 Advanced Tools (optional) - Enable with TASKFLOW_ENABLE_ADVANCED_TOOLS=true
      • Batch operations, rebuilds, template CRUD, detailed views, aliases
      • See TOOLS_ORGANIZATION.md for complete list

Project Types Supported

Type Language Auto-Detected From
Laravel PHP composer.json + artisan
Node.js JavaScript/TypeScript package.json
Python Python requirements.txt, pyproject.toml
React JavaScript/TypeScript package.json with React
Vue JavaScript/TypeScript package.json with Vue
Angular TypeScript angular.json
.NET C# *.csproj, *.sln
Go Go go.mod
Rust Rust Cargo.toml
Generic Any Fallback for other projects

Configuration

TaskFlow uses taskflow.config.json for project-specific settings. See taskflow.config.json.example for a complete template.

Example configuration:

{
  "project": {
    "name": "my-app",
    "type": "nodejs",
    "language": "TypeScript"
  },
  "workflow": {
    "statuses": ["Not Started", "In Progress", "Completed"],
    "priorities": ["High", "Medium", "Low"]
  },
  "git": {
    "enabled": true,
    "autoCommit": true,
    "autoPush": true
  }
}

๐Ÿ”ง Requirements

  • Node.js 18+
  • VS Code with GitHub Copilot extension
  • Git (optional, for auto-commit feature)

๐Ÿ“– Examples

See .plans-example/ directory for:

  • Task structure examples
  • Template files (feature, bugfix, refactor)
  • Directory organization guide

๐Ÿ› Troubleshooting

MCP Server Not Working

  1. Check MCP is enabled:

    • Settings โ†’ search "mcp"
    • Ensure github.copilot.chat.mcp.enabled is true
  2. Verify correct path:

    • Check .vscode/mcp.json points to correct index.js location
    • Use npm root -g to find global modules path
    • Windows: Use double backslashes \\ in paths
  3. Rebuild if needed:

    cd /path/to/TaskFlow
    npm run build
  4. Check output panel:

    • Ctrl+Shift+U โ†’ "GitHub Copilot Chat - MCP"
    • Look for error messages
  5. Reload VS Code:

    • Ctrl+Shift+P โ†’ "Developer: Reload Window"
    • MCP changes require reload

Common Issues

"taskflow command not found" or "taskflow is not recognized"

After installing globally, the command might not be available immediately. Try these solutions:

  1. Close and reopen your terminal/PowerShell

    # Close terminal and open new one, then try:
    taskflow init
  2. Check if npm global bin is in PATH

    # Check npm global bin path:
    npm bin -g
    # Windows: C:\Users\YourUsername\AppData\Roaming\npm
    # Linux/macOS: /usr/local/bin
  3. Add npm global bin to PATH (Windows)

    • Press Win + X โ†’ System โ†’ Advanced system settings
    • Environment Variables โ†’ Edit PATH
    • Add: C:\Users\YourUsername\AppData\Roaming\npm
    • Restart terminal
  4. Use npx instead (no PATH configuration needed)

    npx taskflow-mcp init
  5. Manual setup without taskflow command

    # Create directory structure manually:
    mkdir .plans .plans/active .plans/backlog .plans/completed
    mkdir .plans/decisions .plans/lessons
    mkdir .github
    
    # Copy config from repository:
    # Download taskflow.config.json.example and .github/copilot-instructions.md
    # from: https://github.com/ptnghia/TaskFlow

"Tool does not have a description" warnings

You installed the old package (taskflow-mcp@1.0.32). Install the new package:

# Uninstall old version
npm uninstall -g taskflow-mcp
npm cache clean --force

# Install latest version
npm install -g @ptnghia/taskflow-mcp

# Verify version
npm list -g @ptnghia/taskflow-mcp  # Should show 1.10.0

Then update .vscode/mcp.json path (run npm root -g to find it) and reload VS Code.

"Cannot find module"

  • Path in .vscode/mcp.json is incorrect
  • Run npm root -g and verify path
  • On Windows, use absolute path with \\

"No tools available"

  • MCP not enabled in settings
  • Check github.copilot.chat.mcp.enabled is true
  • Restart VS Code after enabling

"WORKSPACE_ROOT not set"

  • Add "WORKSPACE_ROOT": "${workspaceFolder}" to env
  • Reload VS Code after adding

Advanced tools not showing

  • Add "TASKFLOW_ENABLE_ADVANCED_TOOLS": "true" to env
  • Reload VS Code
  • Verify with: ๐Ÿ’ฌ "What tools are available?"

Need Help?

  • ๐Ÿ“– Setup Issues? See SETUP_GUIDE.md for detailed troubleshooting
  • ๐Ÿ› Check GitHub Issues
  • ๐Ÿ“ See VERSION.md for detailed changelog
  • ๐Ÿ“‚ Review example files in .plans-example/ and .vscode-example/

๐Ÿค Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

๐Ÿ“„ License

MIT License - see LICENSE file for details.

๐ŸŒŸ Support

If you find TaskFlow useful, please give it a star on GitHub! โญ


TaskFlow MCP - Making development workflow smarter, one task at a time.

Version: 1.10.0 | Author: Pham Thanh Nghia | License: MIT

About

Universal Task Management for Any Project

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

โšก