debug-ledger-mcp 0.1.7 → 0.1.9

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.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  ---
8
8
 
9
9
  ## Example: AI Debug With Memory
10
- ![Example: AI Debug With Memory](./example-ai-debug-with-memory.gif)
10
+ ![Example: AI Debug With Memory](https://github.com/hi0001234d/debug-ledger/blob/main/example-ai-debug-with-memory.gif)
11
11
 
12
12
  **Note:** Do not forget to add this line **"Before starting, call the list_ledger_files MCP tool and show me the output."** at last in every prompt when you want to apply your project constraint or debug memory.
13
13
 
@@ -131,47 +131,41 @@ The ledger grows slowly — only when reality demands it.
131
131
  ## Quick Start
132
132
 
133
133
  ## Installation
134
-
135
- 1. Open your project in VS Code.
136
-
137
- 2. Clone the debug-ledger repository from GitHub using the following command.
138
-
139
- ```bash
140
- git clone https://github.com/bhavnesh75/debug-ledger.git
141
- ```
142
-
143
- 3. Open the terminal.
144
-
145
- ```bash
146
- cd debug-ledger
147
- npm install
148
- npm run build
149
- ```
150
-
151
- 4. After running the above commands, the build file will be available in your project at:
152
-
153
- ```
154
- debug-ledger/dist/mcp/server.js
155
- ```
156
-
157
- 5. Open your editor MCP settings file.
158
- (If you are using editors like Kilo Code, Cursor, or any other editor that supports MCP.)
159
- Add the following MCP configuration in your project MCP settings:
160
-
134
+
135
+ ### Step 1 Add MCP Config
136
+
137
+ Add this to your MCP settings file (Kilo Code / Cursor / Claude Desktop):
161
138
  ```json
162
139
  {
163
140
  "mcpServers": {
164
141
  "debug-ledger": {
165
- "command": "node",
166
- "args": ["dist/mcp/server.js"],
167
- "cwd": "your debug-ledger repo path"
142
+ "command": "npx",
143
+ "args": ["-y", "debug-ledger-mcp"],
144
+ "cwd": "/your/project/path"
168
145
  }
169
146
  }
170
147
  }
171
148
  ```
172
- 6. Replace your `debug-ledger repo path` with the actual path of your `debug-ledger` folder.
173
-
174
- **Note:** Do not forget to add this line **"Before starting, call the list_ledger_files MCP tool and show me the output."** at last in every prompt when you want to apply your project constraint or debug memory.
149
+
150
+ Replace `/your/project/path` with your actual project folder path.
151
+
152
+ ### Step 2 — Restart Your Editor
153
+
154
+ That's it. `debug_ledger/` folder with 16 example files will be automatically created in your project.
155
+
156
+ > **Node.js 18+** required.
157
+
158
+ ![](.example-ai-debug-with-memory.gif)
159
+
160
+ ---
161
+
162
+ ## Try It
163
+
164
+ After setup, add this line to any AI prompt:
165
+
166
+ > *"Before starting, call the list_ledger_files MCP tool and show me the output."*
167
+
168
+ If your editor shows the ledger files — it's working.
175
169
 
176
170
  ---
177
171
 
package/dist/mcp/setup.js CHANGED
@@ -8,14 +8,14 @@ export function setupIfNeeded() {
8
8
  const ledgerDir = path.join(projectDir, "debug_ledger");
9
9
  if (fs.existsSync(ledgerDir))
10
10
  return;
11
+ // npm package ની debug_ledger/ folder copy કરો
12
+ const sourceDir = path.join(__dirname, "../../debug_ledger");
11
13
  fs.mkdirSync(ledgerDir, { recursive: true });
12
- const templates = {
13
- "bugs.md": `# Bug Log\n\n| Date | Bug | Fix | Rejected Approaches |\n|------|-----|-----|--------------------|\n`,
14
- "fixes.md": `# Fix Log\n\n| Date | Fix | Why it worked |\n|------|-----|---------------|\n`,
15
- "README.md": `# Debug Ledger\n\nAI-readable log of past bugs and fixes.\n`,
16
- };
17
- for (const [filename, content] of Object.entries(templates)) {
18
- fs.writeFileSync(path.join(ledgerDir, filename), content);
19
- }
20
- console.log("debug_ledger/ created");
14
+ const files = fs.readdirSync(sourceDir);
15
+ files.forEach((file) => {
16
+ if (file.endsWith(".md")) {
17
+ fs.copyFileSync(path.join(sourceDir, file), path.join(ledgerDir, file));
18
+ }
19
+ });
20
+ console.log("debug_ledger/ created with all files");
21
21
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "debug-ledger-mcp",
3
- "version": "0.1.7",
3
+ "version": "0.1.9",
4
4
  "description": "Read-only debug memory for AI — a repo-local ledger of past bugs, rejected fixes, and historical constraints so AI debugs with context, not amnesia.",
5
5
  "type": "module",
6
6
  "engines": {