@squirrelnotes.app/mcp 1.27.3 → 1.28.0

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 +41 -17
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -96,8 +96,8 @@ Add both servers to `claude_desktop_config.json`:
96
96
  {
97
97
  "mcpServers": {
98
98
  "squirrel-notes": {
99
- "command": "node",
100
- "args": ["/path/to/squirrel-notes-mcp/dist/stdio-handler.js"],
99
+ "command": "npx",
100
+ "args": ["-y", "@squirrelnotes.app/mcp"],
101
101
  "env": {
102
102
  "SQUIRREL_API_BASE_URL": "https://api.squirrelnotes.app",
103
103
  "SQUIRREL_API_KEY": "sqn_your_api_key",
@@ -167,7 +167,41 @@ Neither header is ever stored, cached, or logged by the server.
167
167
 
168
168
  The stdio transport runs the MCP server as a local process on your machine. No OAuth, no network headers, no AWS account needed. Your passphrase is set as an env var in the config file and **never leaves your machine**.
169
169
 
170
- #### 1. Build the stdio handler
170
+ #### Option A — npx (zero install, recommended)
171
+
172
+ No download or build step required. `npx` fetches the latest published version automatically on first run and caches it locally.
173
+
174
+ **1. Configure Claude Desktop**
175
+
176
+ Open `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows) and add:
177
+
178
+ ```json
179
+ {
180
+ "mcpServers": {
181
+ "squirrel-notes": {
182
+ "command": "npx",
183
+ "args": ["-y", "@squirrelnotes.app/mcp"],
184
+ "env": {
185
+ "SQUIRREL_API_BASE_URL": "https://api.squirrelnotes.app",
186
+ "SQUIRREL_API_KEY": "sqn_<your_api_key>",
187
+ "SQUIRREL_PASSPHRASE": "<your_passphrase>"
188
+ }
189
+ }
190
+ }
191
+ }
192
+ ```
193
+
194
+ **2. Restart Claude Desktop**
195
+
196
+ Quit and reopen Claude Desktop. The Squirrel Notes MCP server will start automatically.
197
+
198
+ **3. Verify**
199
+
200
+ Ask Claude: *"List my Squirrel Notes"* — you should see your note titles.
201
+
202
+ #### Option B — build from source (local development / pinned version)
203
+
204
+ Use this if you want to run a specific local build or contribute to the server code.
171
205
 
172
206
  ```bash
173
207
  cd mcp
@@ -176,9 +210,7 @@ npm run build:stdio
176
210
  # Produces dist/stdio-handler.js
177
211
  ```
178
212
 
179
- #### 2. Configure Claude Desktop
180
-
181
- Open `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) and add:
213
+ Then reference the built file directly:
182
214
 
183
215
  ```json
184
216
  {
@@ -196,15 +228,7 @@ Open `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) a
196
228
  }
197
229
  ```
198
230
 
199
- > **Windows:** Use `"command": "node"` and replace the path with `C:\\path\\to\\mcp\\dist\\stdio-handler.js` (double backslashes).
200
-
201
- #### 3. Restart Claude Desktop
202
-
203
- Quit and reopen Claude Desktop. The Squirrel Notes MCP server will start automatically.
204
-
205
- #### 4. Verify
206
-
207
- Ask Claude: *"List my Squirrel Notes"* — you should see your note titles.
231
+ > **Windows:** Replace the path with `C:\\path\\to\\mcp\\dist\\stdio-handler.js` (double backslashes).
208
232
 
209
233
  ---
210
234
 
@@ -332,8 +356,8 @@ Set `SQUIRREL_LOG_FILE` to an absolute path in your `claude_desktop_config.json`
332
356
  {
333
357
  "mcpServers": {
334
358
  "squirrel-notes": {
335
- "command": "node",
336
- "args": ["/absolute/path/to/mcp/dist/stdio-handler.js"],
359
+ "command": "npx",
360
+ "args": ["-y", "@squirrelnotes.app/mcp"],
337
361
  "env": {
338
362
  "SQUIRREL_API_BASE_URL": "https://api.squirrelnotes.app",
339
363
  "SQUIRREL_API_KEY": "sqn_<your_api_key>",
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@squirrelnotes.app/mcp",
3
- "version": "1.27.3",
4
- "description": "MCP server Lambda for Squirrel Notes — bridges AI agents to the encrypted note-taking API",
3
+ "version": "1.28.0",
4
+ "description": "MCP stdio CLI for Squirrel Notes — bridges AI agents to the encrypted note-taking API",
5
5
  "type": "module",
6
6
  "bin": {
7
- "squirrelnotes-app-mcp": "./dist/stdio-handler.js"
7
+ "squirrelnotes-app-mcp": "dist/stdio-handler.js"
8
8
  },
9
9
  "files": [
10
10
  "dist/stdio-handler.js",