Cursor Workflow Installation
Complete guide for installing and setting up the cursor_workflow system in your Cursor project.
What is Cursor Workflow?
Cursor Workflow is a modular system that provides MCP tools, workflows, and automation for Cursor projects. It includes modules for:
- •AutoTask: Task management via MCP bridge
- •Git: Automated version control operations
- •AutoTask Plugin: Enhanced feature building workflows
Installation Methods
Option 1: As a Git Submodule (Recommended)
If cursor_workflow is a git repository:
# In your project root git submodule add <repo-url> .cursor/cursor_workflow cd .cursor/cursor_workflow ./setup.sh
Option 2: Manual Installation
If you have the cursor_workflow directory already:
# Navigate to cursor_workflow directory cd .cursor/cursor_workflow ./setup.sh
Option 3: Selective Module Installation
Install only specific modules:
cd .cursor/cursor_workflow ./install.sh autotask git autotask-plugin
Or install all modules:
cd .cursor/cursor_workflow ./install.sh --all
Prerequisites
Before installation, ensure you have:
- •Git: For submodule management (if using submodule method)
- •uv: Python package manager (required for Python-based modules)
- •jq: JSON processor (recommended for config merging, optional)
Check prerequisites:
git --version uv --version jq --version # Optional but recommended
Installation Steps
Step 1: Navigate to cursor_workflow
cd .cursor/cursor_workflow
Step 2: Run Setup Script
./setup.sh
This will:
- •Check prerequisites
- •Install all modules
- •Merge MCP configurations
- •Copy rules to
.cursor/rules/ - •Install module dependencies
- •Verify installation
Step 3: Verify Installation
Check that configuration files were created:
# Check MCP configuration cat ../mcp.json # Check rules were copied ls ../rules/
Step 4: Restart Cursor
Important: Restart Cursor completely to load:
- •New MCP servers
- •New rules
- •Updated configuration
Module-Specific Requirements
AutoTask Module
- •AutoTask API running (default:
http://localhost:8000) - •Bridge directory in project root at
bridge/ - •Bridge dependencies installed:
cd bridge && uv sync
Git Module
- •Git installed and configured
- •Python 3.11+ with
uvpackage manager
AutoTask Plugin Module
- •AutoTask module must be installed first
- •AutoTask MCP bridge configured in
.cursor/mcp.json - •AutoTask API running
Configuration
After installation, review and customize:
MCP Configuration
Edit .cursor/mcp.json to:
- •Update server paths if needed
- •Adjust environment variables
- •Configure auto-approval settings
Rules
Rules are copied to .cursor/rules/. You can:
- •Review module-specific rules
- •Customize rules for your project
- •Add project-specific rules
Verification
Check MCP Servers
# View configured servers cat .cursor/mcp.json | jq '.mcpServers | keys'
Test MCP Tools
In Cursor, try using MCP tools:
- •"List all open tasks" (if AutoTask module installed)
- •"Check git status" (if Git module installed)
Check Rules
# List installed rules ls .cursor/rules/*.mdc
Troubleshooting
MCP Servers Not Available
- •Check configuration: Verify
.cursor/mcp.jsonexists and is valid JSON - •Check paths: Ensure module paths in config are correct (relative to project root)
- •Check dependencies: Install module dependencies:
cd modules/[module] && uv sync - •Restart Cursor: Fully restart Cursor (not just reload window)
Rules Not Applied
- •Check rules directory: Verify
.cursor/rules/exists and contains.mdcfiles - •Check file format: Rules must be
.mdcfiles with proper frontmatter - •Restart Cursor: Rules are loaded on startup
Module Installation Fails
- •Check prerequisites: Ensure
uvis installed for Python modules - •Check paths: Verify module directories exist in
modules/ - •Check permissions: Ensure install scripts are executable:
chmod +x install.sh - •Manual installation: Try installing modules individually to identify issues
jq Not Found (Config Merging)
If jq is not installed, MCP config merging will be skipped. You can:
- •Install jq:
brew install jq(macOS) orapt-get install jq(Linux) - •Manually merge MCP configurations from
modules/*/mcp-config.jsoninto.cursor/mcp.json
Quick Installation Command
For a quick reference, the installation command is:
cd .cursor/cursor_workflow && ./setup.sh
Or for specific modules:
cd .cursor/cursor_workflow && ./install.sh [module1] [module2] ...
Post-Installation
After successful installation:
- •✅ Review
.cursor/mcp.jsonconfiguration - •✅ Check module requirements in
modules/*/README.md - •✅ Restart Cursor completely
- •✅ Test MCP tools in Cursor
- •✅ Use the "Start Building Features" command (if AutoTask plugin installed)
Available Commands
After installation, these commands are available in Cursor:
- •Start Building Features: Check connectivity and begin working on tasks (requires AutoTask plugin)
- •Complete Task: Complete a task and auto-commit (requires AutoTask and Git modules)
Next Steps
- •Read module documentation:
modules/*/README.md - •Review available MCP tools in the cursor-workflow-tools skill
- •Start using workflows in your development process