Skip to content

shiquda/roadmap-skill

Repository files navigation

Roadmap Skill

Roadmap Skill Kanban Board

Shared roadmap for humans and AI Agents
Visual kanban for you. MCP server for Agents. Local-first.

简体中文 | English

npm version License npm downloads

Install in VS Code Install in VS Code Insiders


What Makes It Different

Shared context — Chat with your Agent to plan tasks, or edit directly in the Kanban — both stay in sync. Your Agent always sees the latest state.

Agent-native — Built as an MCP server. Your AI can create, update, and query tasks directly in conversation.

Lightweight Kanban — Open localhost:7860 when you feel like it, or ask your Agent to open it with open_web_interface. Or just stay in chat. All three work.

Local-first — Your data lives on your machine. No accounts, no cloud sync, no vendor lock-in.


Quick Start (Zero Config)

# Integrate with your AI assistant (MCP config below)
View platform configurations
Claude Code
claude mcp add roadmap "npx -y roadmap-skill"
Claude Desktop
{
  "mcpServers": {
    "roadmap": {
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
Copilot
/mcp add

Or edit ~/.copilot/mcp-config.json:

{
  "mcpServers": {
    "roadmap": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
Cursor
{
  "mcpServers": {
    "roadmap": {
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
JetBrains (via Cline)

Install Cline plugin, then add to cline_mcp_settings.json:

{
  "mcpServers": {
    "roadmap": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
Roo Code
{
  "mcpServers": {
    "roadmap": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
Opencode

Edit ~/.config/opencode/opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "roadmap": {
      "type": "local",
      "command": [
        "npx",
        "-y",
        "roadmap-skill"
      ],
      "enabled": true
    }
  }
}
Trae

Go to Settings -> MCP -> Add new MCP Server:

{
  "mcpServers": {
    "roadmap": {
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
VS Code
{
  "mcp": {
    "servers": {
      "roadmap": {
        "command": "npx",
        "args": ["-y", "roadmap-skill"]
      }
    }
  }
}
Windsurf

Follow Windsurf MCP documentation and use:

{
  "mcpServers": {
    "roadmap": {
      "command": "npx",
      "args": ["-y", "roadmap-skill"]
    }
  }
}
Zed
{
  "context_servers": {
    "roadmap": {
      "command": {
        "path": "npx",
        "args": ["-y", "roadmap-skill"]
      }
    }
  }
}
Codex CLI / Codex IDE

One-liner (recommended):

codex mcp add roadmap -- npx -y roadmap-skill

Manual config — edit ~/.codex/config.toml:

[mcp_servers.roadmap]
command = "npx"
args = ["-y", "roadmap-skill"]

Windows: No cmd /c wrapper needed — Codex handles the subprocess directly.

Server name: Must match ^[a-zA-Z0-9_-]+$. Names with spaces or parentheses are rejected.

Note: Both Codex CLI and the Codex VSCode extension share the same ~/.codex/config.toml. A syntax error breaks both.


After setup, simply tell your AI:

"Create a website redesign project with tasks for homepage, about page, and contact form"

The AI will immediately create the project and tasks, saving them to local storage. You can open http://localhost:7860 anytime to view the visual Kanban board.


Who Is This For?

Solo developers, AI power users, and vibe coders who want their Agent to be a real collaborator — not just a code generator.


Typical Use Cases

1. Capture Ideas Without Breaking Flow

Mid-session, something pops into your head:

"Note this down: switch the auth module to JWT + refresh token rotation"

Use /quick-capture or just say "help me note this down" — your Agent turns it into a task, saves it locally, and you keep going. No context switch, no forgotten ideas.

2. Let Agent Help You Prioritize

"This month's OKR is finishing the user system refactor — can you list the related tasks and figure out which ones should come first?"

Use /auto-prioritize to let your Agent analyze the current project state and reorder task priorities accordingly.

3. Let Agent Recommend What to Do Next

"What's left on the current project? Any high-priority tasks I haven't touched yet?"

Or use /suggest-tasks — your Agent recommends the next actions based on current progress and priorities.

No tab switching. No copy-pasting. Just ask.

Core Features

Feature Description
Kanban View Four columns: Todo, In Progress, Review, Done
Drag and Drop Drag tasks to update status, WYSIWYG
Quick Create Click "+" button on any column to instantly add tasks
Dual View Compact mode for overview, detailed mode for full info
Smart Search Quick task search across all projects, keyword filtering

Supported Platforms

  • Claude Code, Codex, OpenCode — Command-line AI assistants
  • Cursor, VS Code — AI-powered IDEs
  • Any MCP Client — Standard MCP protocol support

Data Storage

Roadmap Skill uses pure local JSON file storage. All data is saved in your user directory:

Platform Storage Path
Windows %USERPROFILE%\.roadmap-skill
macOS ~/.roadmap-skill/
Linux ~/.roadmap-skill/

You can export or import backup files from the web interface.


License

MIT © shiquda


If this project helps you, please consider giving it a star!

About

Shared roadmap for humans and AI Agents. Visual kanban for you, MCP server for Agents. Support Claude Code, Codex, Cursor, OpenCode and more!

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages