@qzoft/check-list 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -37
  2. package/package.json +5 -2
package/README.md CHANGED
@@ -1,7 +1,9 @@
1
- # check-list
1
+ # @qzoft/check-list
2
2
 
3
3
  A general-purpose MCP App that discovers and displays checklists from **all markdown files** in your project, rendered as an interactive checkbox UI inside VS Code Copilot Chat. Changes are saved automatically — no confirmation needed.
4
4
 
5
+ Available on npm: [`@qzoft/check-list`](https://www.npmjs.com/package/@qzoft/check-list)
6
+
5
7
  ## Prerequisites
6
8
 
7
9
  - Node.js 18+
@@ -9,25 +11,25 @@ A general-purpose MCP App that discovers and displays checklists from **all mark
9
11
 
10
12
  ## Setup
11
13
 
12
- 1. Clone this repo:
13
- ```sh
14
- git clone https://github.com/qzoft/check-list.git
15
- cd check-list
16
- ```
17
-
18
- 2. Install dependencies:
19
- ```sh
20
- npm install
21
- ```
14
+ Add the following to your project's `.vscode/mcp.json`:
22
15
 
23
- 3. Build the project:
24
- ```sh
25
- npm run build
26
- ```
16
+ ```json
17
+ {
18
+ "servers": {
19
+ "check-list": {
20
+ "command": "npx",
21
+ "args": ["-y", "@qzoft/check-list"],
22
+ "env": {
23
+ "PROJECT_DIR": "${workspaceFolder}"
24
+ }
25
+ }
26
+ }
27
+ }
28
+ ```
27
29
 
28
- 4. Open VS Code the `.vscode/mcp.json` config auto-registers the server. VS Code will pick it up automatically when you open the workspace.
30
+ That's it VS Code will download and run the server automatically. No cloning or building required.
29
31
 
30
- 5. In Copilot Chat, ask **"show my tasks"** → the `list_tasks` tool scans the project and renders the interactive checkbox UI.
32
+ In Copilot Chat, ask **"show my tasks"** → the `list_tasks` tool scans the project and renders the interactive checkbox UI.
31
33
 
32
34
  ## Usage
33
35
 
@@ -69,26 +71,9 @@ Once the server is running, you can use two tools in Copilot Chat:
69
71
  | Variable | Description | Example |
70
72
  |---------------|-----------------------------------------------------|----------------------------------|
71
73
  | `PROJECT_DIR` | Root directory to scan for markdown files | `~/repos/my-project` |
72
- | `TASK_FILE` | *(backward-compat)* Falls back to parent directory | `~/repos/my-project/task.md` |
73
74
 
74
75
  If neither is set, the server uses the current working directory.
75
76
 
76
- The project directory is configured in `.vscode/mcp.json`:
77
-
78
- ```json
79
- {
80
- "servers": {
81
- "check-list": {
82
- "command": "node",
83
- "args": ["dist/server.js"],
84
- "env": {
85
- "PROJECT_DIR": "${workspaceFolder}"
86
- }
87
- }
88
- }
89
- }
90
- ```
91
-
92
77
  ## Task file format
93
78
 
94
79
  The parser recognizes `## Section` headers and checkbox list items in any `.md` file:
@@ -110,12 +95,10 @@ The server skips common non-project directories (`node_modules`, `.git`, `dist`,
110
95
  ## Project structure
111
96
 
112
97
  ```
113
- check-list/
98
+ @qzoft/check-list
114
99
  ├── package.json
115
100
  ├── tsconfig.json
116
101
  ├── README.md
117
- ├── .vscode/
118
- │ └── mcp.json # VS Code MCP server config
119
102
  ├── src/
120
103
  │ ├── server.ts # MCP server entry point
121
104
  │ ├── parser.ts # Markdown checkbox parser
package/package.json CHANGED
@@ -1,11 +1,14 @@
1
1
  {
2
2
  "name": "@qzoft/check-list",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "MCP App for interactive task management from markdown files",
5
5
  "type": "module",
6
6
  "main": "dist/server.js",
7
7
  "bin": "dist/server.js",
8
- "files": ["dist", "ui"],
8
+ "files": [
9
+ "dist",
10
+ "ui"
11
+ ],
9
12
  "scripts": {
10
13
  "build": "tsc",
11
14
  "start": "node dist/server.js",