|
| 1 | +# MCP TaskManager |
| 2 | + |
| 3 | +Model Context Protocol server for Task Management. This allows Claude Desktop (or any MCP client) to manage and execute tasks in a queue-based system. |
| 4 | + |
| 5 | +## Quick Start (For Users) |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | +- Node.js 18+ (install via `brew install node`) |
| 9 | +- Claude Desktop (install from https://claude.ai/desktop) |
| 10 | + |
| 11 | +### Configuration |
| 12 | + |
| 13 | +1. Open your Claude Desktop configuration file at: |
| 14 | +`~/Library/Application Support/Claude/claude_desktop_config.json` |
| 15 | + |
| 16 | +You can find this through the Claude Desktop menu: |
| 17 | +1. Open Claude Desktop |
| 18 | +2. Click Claude on the Mac menu bar |
| 19 | +3. Click "Settings" |
| 20 | +4. Click "Developer" |
| 21 | + |
| 22 | +2. Add the following to your configuration: |
| 23 | + |
| 24 | +```json |
| 25 | +{ |
| 26 | + "tools": { |
| 27 | + "taskmanager": { |
| 28 | + "command": "npx", |
| 29 | + "args": ["-y", "@kazuph/mcp-taskmanager"] |
| 30 | + } |
| 31 | + } |
| 32 | +} |
| 33 | +``` |
| 34 | + |
| 35 | +## For Developers |
| 36 | + |
| 37 | +### Prerequisites |
| 38 | +- Node.js 18+ (install via `brew install node`) |
| 39 | +- Claude Desktop (install from https://claude.ai/desktop) |
| 40 | +- tsx (install via `npm install -g tsx`) |
| 41 | + |
| 42 | +### Installation |
| 43 | + |
| 44 | +```bash |
| 45 | +git clone https://github.com/kazuph/mcp-taskmanager.git |
| 46 | +cd mcp-taskmanager |
| 47 | +npm install |
| 48 | +npm run build |
| 49 | +``` |
| 50 | + |
| 51 | +### Development Configuration |
| 52 | + |
| 53 | +1. Make sure Claude Desktop is installed and running. |
| 54 | + |
| 55 | +2. Install tsx globally if you haven't: |
| 56 | +```bash |
| 57 | +npm install -g tsx |
| 58 | +# or |
| 59 | +pnpm add -g tsx |
| 60 | +``` |
| 61 | + |
| 62 | +3. Modify your Claude Desktop config located at: |
| 63 | +`~/Library/Application Support/Claude/claude_desktop_config.json` |
| 64 | + |
| 65 | +Add the following to your MCP client's configuration: |
| 66 | + |
| 67 | +```json |
| 68 | +{ |
| 69 | + "tools": { |
| 70 | + "taskmanager": { |
| 71 | + "args": ["tsx", "/path/to/mcp-taskmanager/index.ts"] |
| 72 | + } |
| 73 | + } |
| 74 | +} |
| 75 | +``` |
| 76 | + |
| 77 | +## Available Operations |
| 78 | + |
| 79 | +The TaskManager supports two main phases of operation: |
| 80 | + |
| 81 | +### Planning Phase |
| 82 | +- Accepts a task list (array of strings) from the user |
| 83 | +- Stores tasks internally as a queue |
| 84 | +- Returns an execution plan (task overview, task ID, current queue status) |
| 85 | + |
| 86 | +### Execution Phase |
| 87 | +- Returns the next task from the queue when requested |
| 88 | +- Provides feedback mechanism for task completion |
| 89 | +- Removes completed tasks from the queue |
| 90 | +- Prepares the next task for execution |
| 91 | + |
| 92 | +### Parameters |
| 93 | + |
| 94 | +- `action`: "plan" | "execute" | "complete" |
| 95 | +- `tasks`: Array of task strings (required for "plan" action) |
| 96 | +- `taskId`: Task identifier (required for "complete" action) |
| 97 | +- `getNext`: Boolean flag to request next task (for "execute" action) |
| 98 | + |
| 99 | +## Example Usage |
| 100 | + |
| 101 | +```typescript |
| 102 | +// Planning phase |
| 103 | +{ |
| 104 | + action: "plan", |
| 105 | + tasks: ["Task 1", "Task 2", "Task 3"] |
| 106 | +} |
| 107 | + |
| 108 | +// Execution phase |
| 109 | +{ |
| 110 | + action: "execute", |
| 111 | + getNext: true |
| 112 | +} |
| 113 | + |
| 114 | +// Complete task |
| 115 | +{ |
| 116 | + action: "complete", |
| 117 | + taskId: "task-123" |
| 118 | +} |
| 119 | +``` |
0 commit comments