obsidian-accomplishments-mcp 0.1.11 → 0.1.13

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 +50 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -16,10 +16,10 @@ This MCP server lets AI assistants:
16
16
  │ Your Workflow │
17
17
  ├─────────────────────────────────────────────────────────────────────┤
18
18
  │ │
19
- │ ┌──────────┐ ┌──────────────┐ ┌──────────┐
20
- │ │ Obsidian │◄────►│ MCP Server │◄────►│ AI │
21
- │ │ Vault │ │ (this repo) │ │ Assistant│
22
- │ └──────────┘ └──────────────┘ └──────────┘
19
+ │ ┌──────────┐ ┌──────────────┐ ┌──────────┐
20
+ │ │ Obsidian │◄────►│ MCP Server │◄────►│ AI │
21
+ │ │ Vault │ │ (this repo) │ │ Assistant│
22
+ │ └──────────┘ └──────────────┘ └──────────┘
23
23
  │ │
24
24
  └─────────────────────────────────────────────────────────────────────┘
25
25
  ```
@@ -33,10 +33,22 @@ This MCP server lets AI assistants:
33
33
  - Node.js 18 or later
34
34
  - An Obsidian vault
35
35
 
36
- ### Install from Source
36
+ ### Option 1: Install from npm (Recommended)
37
37
 
38
38
  ```bash
39
- git clone <repository-url>
39
+ npm install -g obsidian-accomplishments-mcp
40
+ ```
41
+
42
+ Or run directly with npx (no installation required):
43
+
44
+ ```bash
45
+ npx obsidian-accomplishments-mcp
46
+ ```
47
+
48
+ ### Option 2: Install from Source
49
+
50
+ ```bash
51
+ git clone https://github.com/ostanlabs/obsidian_mcp.git
40
52
  cd obsidian_mcp
41
53
  npm install
42
54
  npm run build
@@ -70,6 +82,38 @@ Add the MCP server to your AI client's configuration.
70
82
 
71
83
  **For Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
72
84
 
85
+ Using npx (recommended):
86
+ ```json
87
+ {
88
+ "mcpServers": {
89
+ "obsidian": {
90
+ "command": "npx",
91
+ "args": ["-y", "obsidian-accomplishments-mcp"],
92
+ "env": {
93
+ "VAULT_PATH": "/absolute/path/to/your/obsidian/vault",
94
+ "DEFAULT_CANVAS": "projects/main.canvas"
95
+ }
96
+ }
97
+ }
98
+ }
99
+ ```
100
+
101
+ Using global install:
102
+ ```json
103
+ {
104
+ "mcpServers": {
105
+ "obsidian": {
106
+ "command": "obsidian-accomplishments-mcp",
107
+ "env": {
108
+ "VAULT_PATH": "/absolute/path/to/your/obsidian/vault",
109
+ "DEFAULT_CANVAS": "projects/main.canvas"
110
+ }
111
+ }
112
+ }
113
+ }
114
+ ```
115
+
116
+ Using local install:
73
117
  ```json
74
118
  {
75
119
  "mcpServers": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-accomplishments-mcp",
3
- "version": "0.1.11",
3
+ "version": "0.1.13",
4
4
  "description": "Model Context Protocol (MCP) server for managing structured project accomplishments in Obsidian",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",