@blacksmithers/vaultforge 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.
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,83 @@ 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
 
281
- ```bash
282
- npm install -g @blacksmithers/vaultforge
283
- ```
282
+ Download the `.mcpb` file from the [latest release](https://github.com/blacksmithers/vaultforge/releases/latest) and double-click to install:
284
283
 
285
- ### Configure
284
+ | Platform | File |
285
+ |----------|------|
286
+ | Windows | `vaultforge.mcpb` |
287
+ | macOS | `vaultforge.mcpb` |
288
+ | Linux | `vaultforge.mcpb` |
286
289
 
287
- **Claude Desktop** edit `claude_desktop_config.json`:
290
+ Claude Desktop will prompt you for your vault path during installation.
288
291
 
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` |
292
+ ### Claude Code
294
293
 
295
- > **Tip (Windows):** press `Win+R`, paste `%APPDATA%\Claude`, hit Enter. The folder opens directly.
294
+ ```bash
295
+ claude mcp add vaultforge -- npx -y @blacksmithers/vaultforge /path/to/your/vault
296
+ ```
297
+
298
+ ### VS Code / Cursor / Windsurf
299
+
300
+ Add to your MCP settings JSON (`.vscode/mcp.json`, `.cursor/mcp.json`, or equivalent):
296
301
 
297
- macOS / Linux:
298
302
  ```json
299
303
  {
300
- "mcpServers": {
304
+ "servers": {
301
305
  "vaultforge": {
302
- "command": "vaultforge",
303
- "args": ["/Users/you/Documents/MyVault"]
306
+ "command": "npx",
307
+ "args": ["-y", "@blacksmithers/vaultforge", "/path/to/your/vault"]
304
308
  }
305
309
  }
306
310
  }
307
311
  ```
308
312
 
309
- Windows:
313
+ ### Any MCP client
314
+
315
+ Use this universal pattern — any client that supports MCP stdio transport will work:
316
+
317
+ - **Command:** `npx`
318
+ - **Args:** `["-y", "@blacksmithers/vaultforge", "/path/to/your/vault"]`
319
+
320
+ <details>
321
+ <summary>Global install + manual Claude Desktop config</summary>
322
+
323
+ ```bash
324
+ npm install -g @blacksmithers/vaultforge
325
+ ```
326
+
327
+ Edit `claude_desktop_config.json`:
328
+
329
+ | OS | Config file location |
330
+ |----|---------------------|
331
+ | macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
332
+ | Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
333
+ | Linux | `~/.config/Claude/claude_desktop_config.json` |
334
+
310
335
  ```json
311
336
  {
312
337
  "mcpServers": {
313
338
  "vaultforge": {
314
339
  "command": "vaultforge",
315
- "args": ["C:\\Users\\you\\Documents\\MyVault"]
340
+ "args": ["/path/to/your/vault"]
316
341
  }
317
342
  }
318
343
  }
319
344
  ```
320
345
 
321
- **Claude Code:**
322
-
323
- ```bash
324
- claude mcp add vaultforge -- vaultforge /path/to/your/vault
325
- ```
346
+ </details>
326
347
 
327
348
  ### Verify
328
349
 
Binary file
package/manifest.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "manifest_version": "0.3",
3
+ "name": "@blacksmithers/vaultforge",
4
+ "version": "1.0.1",
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
+ "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.1",
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
  ],