tuckertucker_taskboardai

by TuckerTucker

License

You signed in with another tab or window. Reload
to refresh your session. You signed out in another tab or window. Reload
to refresh your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert

TuckerTucker / TaskBoardAI Public

Notifications
You must be signed in to change notification settings
Fork 0
Star 1

A lightweight, file-based kanban board designed for AI Agents. Includes web interface for HIL collaboration.

License

View license

1 star
0 forks
Branches
Tags
Activity

Star

Notifications
You must be signed in to change notification settings

TuckerTucker/TaskBoardAI

main

1 Branch
2 Tags

Go to file

Code

Folders and files

Repository files navigation

TaskBoardAI

A lightweight, file-based kanban board designed for AI Agents. Includes web interface for HIL collaboration.

AIX Features:

JSON board files to allow for full project context
MCP Server for access to create/delete/update/read boards

HIL Features:

Drag-and-drop sorting of cards and columns
Add/Delete cards and columns
Drop down selection of available boards

Note
TaskBoardAI doesn't have it's own llm integration.
You'll want to use context of your project to update the board.

Features

Markdown Support: Rich card content with full markdown syntax
Subtasks: Track and mark completion within cards
Tags & Dependencies: Organize and link related cards
Drag and Drop: Intuitive interface for card management
Next Steps: Track upcoming priorities at the board level
Webhooks: Integrate with other services via webhooks
AI Integration: Connect with Claude for Desktop using MCP

Installation

Option 1: Install via npm (Recommended)

Install globally for command-line access from anywhere:

npm install -g taskboardai

Or install locally in your project:

npm install taskboardai

Option 2: Clone the Repository (Development)

Clone the repository:

git clone https://github.com/TuckerTucker/TaskBoardAI.git
cd TaskBoardAI

Install dependencies:

npm install

Usage

Using npm-installed Version

When installed globally via npm, you can use the following commands:

List available boards:

taskboard --list

Create a new board:

taskboard --new my-project

Open an existing board:

taskboard my-project

Start the MCP server:

taskboard-mcp

Start both the board server and MCP server:

taskboard-all

Using Repository Version

If you've cloned the repository, use the included scripts:

List available boards:

./_start_kanban --list

Create a new board:

./_start_kanban --new my-project

Open an existing board:

./_start_kanban my-project

Access your board at http://localhost:3001 (default port)

Using an External Board Location

*not yet supported via MCP

Create a new board directory in your project's repo
Copy the example board:

If installed via npm:

```shell

First, create an example board in your home directory

taskboard --new example

Then copy it to your desired location

cp ~/.taskboardai/boards/example.json /your/board/location/board_name.json
```

If using the repository:

shell cp /path/to/TaskBoardAI/boards/_kanban_example.json /your/board/location/board_name.json
Start the server with your external board location:

If installed via npm:

shell taskboard --external /your/board/location/board_name.json

If using the repository:

shell ./_start_kanban --external /your/board/location/board_name.json

Board Structure

The kanban board is defined in a JSON file with the following structure: This allows the Agent to have full context of the project

{
  "projectName": "Project Name",
  "id": "unique-board-id",
  "columns": [\
    {\
      "id": "column-id",\
      "name": "Column Name"\
    }\
  ],
  "cards": [\
    {\
      "id": "card-id",\
      "title": "Card Title",\
      "content": "Markdown supported content",\
      "columnId": "column-id",\
      "position": 0,\
      "collapsed": false,\
      "subtasks": [\
        "✓ Completed task",\
        "Pending task"\
      ],\
      "tags": ["feature", "frontend"],\
      "dependencies": ["other-card-id"],\
      "created_at": "2025-01-18T10:00:00.000Z",\
      "updated_at": "2025-01-19T12:30:00.000Z",\
      "completed_at": "2025-01-19T18:12:35.604Z"\
    }\
  ],
  "next-steps": [\
    "Next priority task",\
    "Future focus area"\
  ],
  "last_updated": "2025-01-19T19:20:14.802Z"
}

Note: The board structure has been updated to a card-first architecture, where cards are stored in a top-level array rather than nested within columns.

MCP Server for AI Integration

What Is Model Context Protocol (MCP)?

TaskBoardAI includes an MCP (Model Context Protocol) server that allows you to create and manage boards using any tools supporting MCP (i.e. Claude Code, Cursor, Windsurf ... ).

Starting the MCP Server

If installed via npm:

# Start only the MCP server
taskboard-mcp

# Or start both the board server and MCP server
taskboard-all

If using the repository:

# Start only the MCP server
./_start_mcp

# Or start both servers
./_start_all

The MCP server runs on port 3002 by default.

See the documentation for your IDE or CLI tool on how to add MCP servers.

Using with Agents

Once configured, you can ask the agent to:

List all boards: "Show me all my kanban boards"
Create a new board: "Create a new kanban board called 'Project X'"
Get a specific board by Name: "Show me the details of Project X"
Update a board: "Update the Project X board with our progress"
Delete a board: "Delete the Project X board"

Webhook Integration

TaskBoardAI supports webhooks for integrating with other services:

Create webhook configurations to trigger on events like board updates
Test webhook connections through the API
Receive real-time updates when changes occur on your boards

Running Tests

Run all tests:

npm test

Generate coverage report:

npm run test:coverage

Run tests in watch mode (for development):

npm run test:watch

Run specific test categories:

# Run MCP server tests
npm test -- --testPathPattern 'tests/.*mcp'

# Run only unit tests
npm test -- tests/unit

# Run only integration tests
npm test -- tests/integration

Generating Docs

To generate documentation:

# Install dependencies (if not already installed)
npm install

# Generate docs (docs/api directory)
npm run docs

Data Directory

When installed via npm, TaskBoardAI stores user data in the following location:

Linux/macOS: ~/.taskboardai/
Windows: C:\Users\<username>\.taskboardai\

The data directory contains:

boards/: Your kanban board JSON files
config/: Configuration files
webhooks/: Webhook configurations

You can access or back up these files directly if needed.

Contributing

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

License

Apache License 2.0 - See LICENSE
for details.

About

A lightweight, file-based kanban board designed for AI Agents. Includes web interface for HIL collaboration.

No packages published

Contributors 2

Languages

You can’t perform that action at this time.

Features & Capabilities

Implementation Details

View on GitHub

Stats

0 Views

0 Favorites

1 GitHub Stars

Repository Info

TuckerTucker Organization

Similar Servers

continuedev_continue by continuedev

cherryhq_cherry_studio by CherryHQ

bytedance_ui_tars_desktop by bytedance

No result found

Advanced Search

Search Preferences

tuckertucker_taskboardai

License

License

TuckerTucker/TaskBoardAI

Folders and files

Repository files navigation

TaskBoardAI

Features

Installation

Option 1: Install via npm (Recommended)

Option 2: Clone the Repository (Development)

Usage

Using npm-installed Version

Using Repository Version

Using an External Board Location

First, create an example board in your home directory

Then copy it to your desired location

Board Structure

MCP Server for AI Integration

Starting the MCP Server

Using with Agents

Webhook Integration

Running Tests

Generating Docs

Data Directory

Contributing

License

About

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages

Features & Capabilities

Implementation Details

Stats

Repository Info

Similar Servers

Drop files here or click to upload.

Drop files here or click to upload.