Skip to main content
Glama
README.md
# KanbanFlow MCP Server

A Model Context Protocol (MCP) server for KanbanFlow - manage your boards, tasks, and workflows directly from Cursor/Claude.

## šŸš€ Quick Start (One Command!)

### šŸŽÆ Recommended: Auto-Setup
```bash
# Install globally
npm install -g kanbanflow-mcp-server

# Auto-magic setup in ANY project
cd your-project-folder
kanbanflow-mcp-server --setup
```

**That's it!** ✨ The setup wizard will:
- šŸ” **Detect** your installation automatically
- šŸ›”ļø **Preserve** any existing MCP servers you have
- šŸ’¾ **Create backups** of your configuration
- āš™ļø **Generate** the perfect config with full paths
- šŸŽÆ **Add** KanbanFlow to your Cursor setup

### šŸ› ļø Alternative: Developer Setup
```bash
# Clone and build from source
git clone https://github.com/williamavholmberg/kanbanflow-mcp-server
cd kanbanflow-mcp-server
npm install && npm run build

# Same magic setup wizard works here too!
kanbanflow-mcp-server --setup
```

## šŸ”‘ Get Your API Token
1. Go to [kanbanflow.com/api](https://kanbanflow.com/api)
2. Create your API token
3. Enter it when prompted by the setup wizard

## šŸ›”ļø Safe & Smart Configuration

The setup wizard is **bulletproof**:

- āœ… **Never overwrites** your existing MCP servers
- āœ… **Creates automatic backups** before any changes
- āœ… **Merges intelligently** with your current setup
- āœ… **Uses reliable paths** (no binary issues)
- āœ… **Works everywhere** (macOS, Windows, Linux)

### Example Scenarios:

**New project?**
```bash
šŸ“ Creating new MCP configuration file...
āœ… Setup complete!
```

**Already have MCP servers?**
```bash
šŸ“‹ Found existing MCP configuration with 2 server(s)
āž• Adding kanban-flow to existing configuration...
šŸ’¾ Created backup: mcp.json.backup.1692123456789
āœ… Setup complete!
šŸ’” Your existing MCP servers are preserved!
```

**Updating KanbanFlow config?**
```bash
šŸ“‹ Found existing MCP configuration with 3 server(s)
šŸ”„ Updating existing kanban-flow configuration...
šŸ’¾ Created backup: mcp.json.backup.1692123456789
āœ… Setup complete!
```

## šŸ› ļø Available Tools

### Board Management
- **`get-board`** - Get your board structure and column IDs
- **`get-all-tasks`** - See all tasks across all columns

### Task Operations  
- **`create-task`** - Create new tasks
- **`get-tasks`** - Get tasks from a specific column
- **`get-task-details`** - Get detailed task information
- **`update-task`** - Update task properties (name, column, color, etc.)

### Subtasks
- **`add-subtask`** - Add a subtask to any task
- **`update-subtask-by-position`** - Update subtasks by position
- **`add-subtasks`** - Add multiple subtasks at once
- **`create-task-with-subtasks`** - Create task + subtasks in one go

### Labels & Organization
- **`add-label`** - Add labels to tasks
- **`update-label`** - Update existing labels
- **`set-task-due-date`** - Set due dates
- **`update-custom-field`** - Update custom field values

### Comments
- **`add-comment`** - Add comments to tasks
- **`update-comment`** - Update existing comments

## šŸ“ Usage Examples

Ask Claude things like:
- *"Show me my board structure"*
- *"Create a task called 'Fix bug' in the To-Do column"*
- *"Add subtasks to task T123: Write tests, Review code, Deploy"*
- *"Move task T456 to Done column"*
- *"What tasks are in my In Progress column?"*
- *"Create a task with 3 subtasks for implementing user authentication"*

## šŸ”§ Manual Configuration (Advanced)

If you prefer manual setup, the wizard generates this format:

```json
{
  "mcpServers": {
    "kanban-flow": {
      "command": "node",
      "args": ["/path/to/kanbanflow-mcp-server/build/index.js"],
      "env": {
        "KANBAN_API_TOKEN": "your_api_token_here"
      }
    }
  }
}
```

## šŸš€ Development

```bash
# Build
npm run build

# Help
kanbanflow-mcp-server --help

# Test (requires KANBAN_API_TOKEN env var)
npm run dev
```

## šŸŽÆ Why This MCP Server Rocks

- šŸŖ„ **One-command setup** - No manual config editing
- šŸ›”ļø **Bulletproof safety** - Never breaks your existing setup
- šŸŽÆ **Smart detection** - Works with any installation method
- šŸ”„ **Re-runnable** - Update your config anytime safely
- šŸ“± **Cross-platform** - macOS, Windows, Linux
- šŸš€ **Industry-leading UX** - The way MCP setup should work

## šŸ“„ License

MIT License - see [LICENSE](LICENSE) file.

## šŸ¤ Contributing

1. Fork the repo
2. Create your feature branch
3. Make your changes
4. Test with your KanbanFlow board
5. Submit a pull request

---

**Need help?** Open an issue!

> šŸ’” **Pro tip:** Run `kanbanflow-mcp-server --setup` anytime to update your configuration safely!

TDQS

A3.5/5.0

Scored across 16 tools

Disambiguation5/5

Each tool targets a specific action on a distinct resource (tasks, comments, labels, subtasks, board). Potential overlaps like add-subtask/add-subtasks and create-task/create-task-with-subtasks are clearly distinguished by complexity. The generic update-task is distinct from specific updates due to scope.

Naming Consistency5/5

All tool names follow a consistent verb-noun pattern with hyphens (e.g., add-comment, get-task-details). Verbs are chosen appropriately and the structure is uniform across all 16 tools.

Tool Count5/5

With 16 tools, the server covers a broad range of Kanban operations without being overwhelming. Each tool serves a clear purpose, and the count is well-suited for a board management domain.

Completeness2/5

The tool set lacks essential operations: no delete for tasks, comments, labels, or subtasks, and no ability to move tasks between columns. This creates significant gaps in completing typical Kanban workflows.

Maintenance

ActivityInactive
ResponsivenessNo issues