@blacksmithers/vaultforge 1.0.0 → 1.0.2

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
@@ -21,7 +21,7 @@
21
21
  <a href="#smart-search">Search</a> ·
22
22
  <a href="#vault-intelligence">Intelligence</a> ·
23
23
  <a href="#all-tools">All 27 Tools</a> ·
24
- <a href="#quick-start">Quick Start</a>
24
+ <a href="#install">Install</a>
25
25
  </p>
26
26
 
27
27
  ---
@@ -267,62 +267,85 @@ The vault maps itself.
267
267
 
268
268
  ---
269
269
 
270
- ## Quick Start
270
+ ## Install
271
271
 
272
272
  ### Prerequisites
273
273
 
274
- - [Node.js](https://nodejs.org/) v22+
275
274
  - A folder with Markdown files (Obsidian vault or any structure)
275
+ - One of: [Claude Desktop](https://claude.ai/download), [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [VS Code](https://code.visualstudio.com/), [Cursor](https://cursor.com/), [Windsurf](https://windsurf.com/), or any MCP-compatible client
276
+ - [Node.js](https://nodejs.org/) v22+ (not required for `.mcpb` one-click install)
276
277
 
277
278
  **Obsidian app is not required.** VaultForge operates directly on the filesystem. If Obsidian is open, it picks up changes in real time.
278
279
 
279
- ### Install
280
+ ### Claude Desktop (one-click)
280
281
 
282
+ **Windows** — [⬇ Download vaultforge.mcpb](https://github.com/blacksmithers/vaultforge/releases/latest/download/vaultforge.mcpb) — open the file, enter your vault path, done.
283
+
284
+ **macOS:**
281
285
  ```bash
282
- npm install -g @blacksmithers/vaultforge
286
+ curl -fsSL https://github.com/blacksmithers/vaultforge/releases/latest/download/vaultforge.mcpb -o /tmp/vaultforge.mcpb && open /tmp/vaultforge.mcpb
283
287
  ```
284
288
 
285
- ### Configure
289
+ **Linux:**
290
+ ```bash
291
+ curl -fsSL https://github.com/blacksmithers/vaultforge/releases/latest/download/vaultforge.mcpb -o /tmp/vaultforge.mcpb && xdg-open /tmp/vaultforge.mcpb
292
+ ```
286
293
 
287
- **Claude Desktop** — edit `claude_desktop_config.json`:
294
+ ### Claude Code
288
295
 
289
- | OS | Config file location |
290
- |----|---------------------|
291
- | macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
292
- | Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
293
- | Linux | `~/.config/Claude/claude_desktop_config.json` |
296
+ ```bash
297
+ claude mcp add vaultforge -- npx -y @blacksmithers/vaultforge /path/to/your/vault
298
+ ```
299
+
300
+ ### VS Code / Cursor / Windsurf
294
301
 
295
- > **Tip (Windows):** press `Win+R`, paste `%APPDATA%\Claude`, hit Enter. The folder opens directly.
302
+ Add to your MCP settings JSON (`.vscode/mcp.json`, `.cursor/mcp.json`, or equivalent):
296
303
 
297
- macOS / Linux:
298
304
  ```json
299
305
  {
300
- "mcpServers": {
306
+ "servers": {
301
307
  "vaultforge": {
302
- "command": "vaultforge",
303
- "args": ["/Users/you/Documents/MyVault"]
308
+ "command": "npx",
309
+ "args": ["-y", "@blacksmithers/vaultforge", "/path/to/your/vault"]
304
310
  }
305
311
  }
306
312
  }
307
313
  ```
308
314
 
309
- Windows:
315
+ ### Any MCP client
316
+
317
+ Use this universal pattern — any client that supports MCP stdio transport will work:
318
+
319
+ - **Command:** `npx`
320
+ - **Args:** `["-y", "@blacksmithers/vaultforge", "/path/to/your/vault"]`
321
+
322
+ <details>
323
+ <summary>Global install + manual Claude Desktop config</summary>
324
+
325
+ ```bash
326
+ npm install -g @blacksmithers/vaultforge
327
+ ```
328
+
329
+ Edit `claude_desktop_config.json`:
330
+
331
+ | OS | Config file location |
332
+ |----|---------------------|
333
+ | macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
334
+ | Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
335
+ | Linux | `~/.config/Claude/claude_desktop_config.json` |
336
+
310
337
  ```json
311
338
  {
312
339
  "mcpServers": {
313
340
  "vaultforge": {
314
341
  "command": "vaultforge",
315
- "args": ["C:\\Users\\you\\Documents\\MyVault"]
342
+ "args": ["/path/to/your/vault"]
316
343
  }
317
344
  }
318
345
  }
319
346
  ```
320
347
 
321
- **Claude Code:**
322
-
323
- ```bash
324
- claude mcp add vaultforge -- vaultforge /path/to/your/vault
325
- ```
348
+ </details>
326
349
 
327
350
  ### Verify
328
351
 
Binary file
package/manifest.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "manifest_version": "0.3",
3
+ "name": "@blacksmithers/vaultforge",
4
+ "version": "1.0.2",
5
+ "description": "Blazing-fast local MCP server for Obsidian vault operations via stdio",
6
+ "author": {
7
+ "name": "Solutions Forge LTDA",
8
+ "url": "https://solutionsforge.tech"
9
+ },
10
+ "icon": "assets/icon.png",
11
+ "server": {
12
+ "type": "node",
13
+ "entry_point": "dist/index.js",
14
+ "mcp_config": {
15
+ "command": "node",
16
+ "args": [
17
+ "${__dirname}/dist/index.js",
18
+ "${user_config.vault_path}"
19
+ ]
20
+ }
21
+ },
22
+ "user_config": {
23
+ "vault_path": {
24
+ "type": "string",
25
+ "title": "Vault Path",
26
+ "description": "Absolute path to your Obsidian vault (e.g. /Users/you/Documents/MyVault)",
27
+ "required": true
28
+ }
29
+ },
30
+ "repository": {
31
+ "type": "git",
32
+ "url": "https://github.com/blacksmithers/vaultforge.git"
33
+ },
34
+ "license": "MIT"
35
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blacksmithers/vaultforge",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Blazing-fast local MCP server for Obsidian vault operations via stdio",
5
5
  "type": "module",
6
6
  "bin": {
@@ -11,6 +11,8 @@
11
11
  },
12
12
  "files": [
13
13
  "dist",
14
+ "manifest.json",
15
+ "assets/icon.png",
14
16
  "README.md",
15
17
  "LICENSE"
16
18
  ],