Skip to content

Commit fa73245

Browse files
1.0.1 release with documentation update
1 parent 48d5b36 commit fa73245

File tree

3 files changed

+80
-161
lines changed

3 files changed

+80
-161
lines changed

README.md

Lines changed: 75 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -12,190 +12,44 @@ A Model Context Protocol (MCP) server for AI task management. This tool helps AI
1212
- Task status state management
1313
- Enhanced CLI for task inspection and management
1414

15-
## Structure
16-
17-
The codebase has been refactored into a modular structure:
18-
19-
```
20-
src/
21-
├── index.ts # Main entry point
22-
├── cli.ts # CLI for task approval and listing
23-
├── server/
24-
│ └── TaskManagerServer.ts # Core server functionality
25-
└── types/
26-
├── index.ts # Type definitions and schemas
27-
└── tools.ts # MCP tool definitions
28-
```
29-
30-
## Data Schema and Storage
31-
32-
The task manager stores data in a JSON file with platform-specific default locations:
33-
34-
- **Default locations**:
35-
- **Linux**: `~/.local/share/mcp-taskmanager/tasks.json` (following XDG Base Directory specification)
36-
- **macOS**: `~/Library/Application Support/mcp-taskmanager/tasks.json`
37-
- **Windows**: `%APPDATA%\mcp-taskmanager\tasks.json` (typically `C:\Users\<username>\AppData\Roaming\mcp-taskmanager\tasks.json`)
38-
- **Custom location**: Set via `TASK_MANAGER_FILE_PATH` environment variable
39-
40-
```bash
41-
# Example of setting custom storage location
42-
TASK_MANAGER_FILE_PATH=/path/to/custom/tasks.json npm start
43-
```
44-
45-
The data schema is organized as follows:
46-
47-
```
48-
TaskManagerFile
49-
├── projects: Project[]
50-
├── projectId: string # Format: "proj-{number}"
51-
├── initialPrompt: string # Original user request text
52-
├── projectPlan: string # Additional project details
53-
├── completed: boolean # Project completion status
54-
└── tasks: Task[] # Array of tasks
55-
├── id: string # Format: "task-{number}"
56-
├── title: string # Short task title
57-
├── description: string # Detailed task description
58-
├── status: string # Task status: "not started", "in progress", or "done"
59-
├── approved: boolean # Task approval status
60-
├── completedDetails: string # Completion information (required when status is "done")
61-
├── toolRecommendations: string # Suggested tools that might be helpful for this task
62-
└── ruleRecommendations: string # Suggested rules/guidelines to follow for this task
63-
```
64-
65-
The system persists this structure to the JSON file after each operation.
66-
67-
**Explanation of Task Properties:**
68-
69-
- `id`: A unique identifier for the task
70-
- `title`: A short, descriptive title for the task
71-
- `description`: A more detailed explanation of the task
72-
- `status`: The current status of the task (`not started`, `in progress`, or `done`)
73-
- `approved`: Indicates whether the task has been approved by the user
74-
- `completedDetails`: Provides details about the task completion (required when `status` is `done`)
75-
- `toolRecommendations`: A string containing suggested tools (by name or identifier) that might be helpful for completing this task. The LLM can use this to prioritize which tools to consider.
76-
- `ruleRecommendations`: A string containing suggested rules or guidelines that should be followed while working on this task. This can include things like "ensure all code is commented," "follow accessibility guidelines," or "use the company style guide". The LLM uses these to improve the quality of its work.
77-
78-
## Installation
79-
80-
```bash
81-
npm install @chriscarrollsmith/mcp-taskmanager
82-
```
83-
84-
You can also install globally:
85-
86-
```bash
87-
npm install -g @chriscarrollsmith/mcp-taskmanager
88-
```
89-
9015
## Usage
9116

92-
This command will start the MCP server:
93-
94-
```bash
95-
npx -y @chriscarrollsmith/mcp-taskmanager
96-
97-
# Or, with a custom tasks.json path:
98-
TASK_MANAGER_FILE_PATH=/path/to/tasks.json npx -y @chriscarrollsmith/mcp-taskmanager
99-
```
100-
101-
However, usually you will set the tool configuration in Claude Desktop, Cursor, or another MCP client as follows:
17+
Usually you will set the tool configuration in Claude Desktop, Cursor, or another MCP client as follows:
10218

10319
```json
10420
{
10521
"tools": {
10622
"taskmanager": {
10723
"command": "npx",
108-
"args": ["-y", "@chriscarrollsmith/mcp-taskmanager"]
24+
"args": ["-y", "taskqueue-mcp"]
10925
}
11026
}
11127
}
11228
```
11329

114-
To use the CLI utility, you can use the following command:
115-
116-
```bash
117-
npx task-manager-cli --help
118-
```
119-
120-
This will show the available commands and options.
121-
122-
## License
123-
124-
MIT
125-
126-
<a href="https://glama.ai/mcp/servers/bdjh7kx05h"><img width="380" height="200" src="https://glama.ai/mcp/servers/bdjh7kx05h/badge" alt="@kazuph/mcp-taskmanager MCP server" /></a>
127-
128-
## Quick Start (For Users)
129-
130-
### Prerequisites
131-
- Node.js 18+ (install via `brew install node`)
132-
- Claude Desktop (install from https://claude.ai/desktop)
133-
134-
### Configuration
135-
136-
1. Open your Claude Desktop configuration file at:
137-
`~/Library/Application Support/Claude/claude_desktop_config.json`
138-
139-
You can find this through the Claude Desktop menu:
140-
1. Open Claude Desktop
141-
2. Click Claude on the Mac menu bar
142-
3. Click "Settings"
143-
4. Click "Developer"
144-
145-
2. Add the following to your configuration:
30+
Or, with a custom tasks.json path:
14631

14732
```json
14833
{
14934
"tools": {
15035
"taskmanager": {
15136
"command": "npx",
152-
"args": ["-y", "@chriscarrollsmith/mcp-taskmanager"]
37+
"args": ["-y", "taskqueue-mcp"],
38+
"env": {
39+
"TASK_MANAGER_FILE_PATH": "/path/to/tasks.json"
40+
}
15341
}
15442
}
15543
}
15644
```
15745

158-
## For Developers
159-
160-
### Prerequisites
161-
- Node.js 18+ (install via `brew install node`)
162-
- Claude Desktop (install from https://claude.ai/desktop)
163-
- tsx (install via `npm install -g tsx`)
164-
165-
### Installation
166-
167-
```bash
168-
git clone https://github.com/chriscarrollsmith/mcp-taskmanager.git
169-
cd mcp-taskmanager
170-
npm install
171-
npm run build
172-
```
173-
174-
### Development Configuration
175-
176-
1. Make sure Claude Desktop is installed and running.
46+
To use the CLI utility, you can use the following command:
17747

178-
2. Install tsx globally if you haven't:
17948
```bash
180-
npm install -g tsx
181-
# or
182-
pnpm add -g tsx
49+
npx task-manager-cli --help
18350
```
18451

185-
3. Modify your Claude Desktop config located at:
186-
`~/Library/Application Support/Claude/claude_desktop_config.json`
187-
188-
Add the following to your MCP client's configuration:
189-
190-
```json
191-
{
192-
"tools": {
193-
"taskmanager": {
194-
"args": ["tsx", "/path/to/mcp-taskmanager/index.ts"]
195-
}
196-
}
197-
}
198-
```
52+
This will show the available commands and options.
19953

20054
## Available Operations
20155

@@ -433,3 +287,68 @@ All operations return a status code and message in their response:
433287
- `task_deleted`: Successfully deleted a task
434288
- `task_not_found`: Task not found
435289
- `error`: An error occurred (with error message)
290+
291+
## Structure of the Codebase
292+
293+
```
294+
src/
295+
├── index.ts # Main entry point
296+
├── cli.ts # CLI for task approval and listing
297+
├── server/
298+
│ └── TaskManagerServer.ts # Core server functionality
299+
└── types/
300+
├── index.ts # Type definitions and schemas
301+
└── tools.ts # MCP tool definitions
302+
```
303+
304+
## Data Schema and Storage
305+
306+
The task manager stores data in a JSON file with platform-specific default locations:
307+
308+
- **Default locations**:
309+
- **Linux**: `~/.local/share/mcp-taskmanager/tasks.json` (following XDG Base Directory specification)
310+
- **macOS**: `~/Library/Application Support/mcp-taskmanager/tasks.json`
311+
- **Windows**: `%APPDATA%\mcp-taskmanager\tasks.json` (typically `C:\Users\<username>\AppData\Roaming\mcp-taskmanager\tasks.json`)
312+
- **Custom location**: Set via `TASK_MANAGER_FILE_PATH` environment variable
313+
314+
```bash
315+
# Example of setting custom storage location
316+
TASK_MANAGER_FILE_PATH=/path/to/custom/tasks.json npm start
317+
```
318+
319+
The data schema is organized as follows:
320+
321+
```
322+
TaskManagerFile
323+
├── projects: Project[]
324+
├── projectId: string # Format: "proj-{number}"
325+
├── initialPrompt: string # Original user request text
326+
├── projectPlan: string # Additional project details
327+
├── completed: boolean # Project completion status
328+
└── tasks: Task[] # Array of tasks
329+
├── id: string # Format: "task-{number}"
330+
├── title: string # Short task title
331+
├── description: string # Detailed task description
332+
├── status: string # Task status: "not started", "in progress", or "done"
333+
├── approved: boolean # Task approval status
334+
├── completedDetails: string # Completion information (required when status is "done")
335+
├── toolRecommendations: string # Suggested tools that might be helpful for this task
336+
└── ruleRecommendations: string # Suggested rules/guidelines to follow for this task
337+
```
338+
339+
The system persists this structure to the JSON file after each operation.
340+
341+
**Explanation of Task Properties:**
342+
343+
- `id`: A unique identifier for the task
344+
- `title`: A short, descriptive title for the task
345+
- `description`: A more detailed explanation of the task
346+
- `status`: The current status of the task (`not started`, `in progress`, or `done`)
347+
- `approved`: Indicates whether the task has been approved by the user
348+
- `completedDetails`: Provides details about the task completion (required when `status` is `done`)
349+
- `toolRecommendations`: A string containing suggested tools (by name or identifier) that might be helpful for completing this task. The LLM can use this to prioritize which tools to consider.
350+
- `ruleRecommendations`: A string containing suggested rules or guidelines that should be followed while working on this task. This can include things like "ensure all code is commented," "follow accessibility guidelines," or "use the company style guide". The LLM uses these to improve the quality of its work.
351+
352+
## License
353+
354+
MIT

index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const TASK_FILE_PATH = process.env.TASK_MANAGER_FILE_PATH || DEFAULT_PATH;
1515
// Initialize the server
1616
const server = new McpServer({
1717
name: "task-manager-server",
18-
version: "1.0.6"
18+
version: "1.0.0"
1919
});
2020

2121
const taskManager = new TaskManagerServer();

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@chriscarrollsmith/mcp-taskmanager",
3-
"version": "1.0.7",
4-
"description": "Task Manager MCP Server",
2+
"name": "taskqueue-mcp",
3+
"version": "1.0.1",
4+
"description": "Task Queue MCP Server",
55
"author": "Christopher C. Smith ([email protected])",
66
"main": "dist/index.js",
77
"type": "module",
@@ -25,7 +25,7 @@
2525
},
2626
"repository": {
2727
"type": "git",
28-
"url": "git+https://github.com/chriscarrollsmith/mcp-taskmanager.git"
28+
"url": "git+https://github.com/chriscarrollsmith/taskqueue-mcp.git"
2929
},
3030
"keywords": [
3131
"taskmanager",

0 commit comments

Comments
 (0)