@honkio/mcp 1.0.0 → 1.0.1

package/README.md

@@ -28,28 +28,11 @@ Live sending also requires that the account owner has completed phone verificati
 
 ---
 
-## 2. Install
+## 2. Connect your AI tool
 
-> **The package is not on npm yet**, so `npx @honkio/mcp` will not work. Until it is published, install from source. It takes about thirty seconds.
+There is nothing to install. `npx` fetches the server on first use and caches it.
 
-```sh
-git clone https://github.com/jeffcaldwellca/honkio
-cd honkio/mcp
-npm install
-npm run build
-```
-
-That produces `dist/index.js`, which is the server entry point. Note its absolute path — you will need it in the next step:
-
-```sh
-pwd    # e.g. /Users/you/code/honkio/mcp
-```
-
----
-
-## 3. Connect your AI tool
-
-In every example below, replace `/ABSOLUTE/PATH/TO/honkio/mcp` with the path from `pwd`, and put your own key in `HONKIO_API_KEY`.
+In every example below, put your own key in `HONKIO_API_KEY`.
 
 ### Claude Code
 
@@ -58,7 +41,7 @@ From inside your project:
 ```sh
 claude mcp add honkio \
   --env HONKIO_API_KEY=mk_test_YOUR_KEY_HERE \
-  -- node /ABSOLUTE/PATH/TO/honkio/mcp/dist/index.js
+  -- npx -y @honkio/mcp
 ```
 
 Or commit a `.mcp.json` at the project root to share it with your team (keep the real key out of git — see [Keeping your key out of git](#keeping-your-key-out-of-git)):
@@ -67,8 +50,8 @@ Or commit a `.mcp.json` at the project root to share it with your team (keep the
 {
   "mcpServers": {
     "honkio": {
-      "command": "node",
-      "args": ["/ABSOLUTE/PATH/TO/honkio/mcp/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "@honkio/mcp"],
       "env": { "HONKIO_API_KEY": "mk_test_YOUR_KEY_HERE" }
     }
   }
@@ -83,8 +66,8 @@ Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) o
 {
   "mcpServers": {
     "honkio": {
-      "command": "node",
-      "args": ["/ABSOLUTE/PATH/TO/honkio/mcp/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "@honkio/mcp"],
       "env": { "HONKIO_API_KEY": "mk_test_YOUR_KEY_HERE" }
     }
   }
@@ -101,8 +84,8 @@ Edit `.cursor/mcp.json` in your project, or `~/.cursor/mcp.json` globally:
 {
   "mcpServers": {
     "honkio": {
-      "command": "node",
-      "args": ["/ABSOLUTE/PATH/TO/honkio/mcp/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "@honkio/mcp"],
       "env": { "HONKIO_API_KEY": "mk_test_YOUR_KEY_HERE" }
     }
   }
@@ -118,8 +101,8 @@ Edit `.vscode/mcp.json` in your workspace:
   "servers": {
     "honkio": {
       "type": "stdio",
-      "command": "node",
-      "args": ["/ABSOLUTE/PATH/TO/honkio/mcp/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "@honkio/mcp"],
       "env": { "HONKIO_API_KEY": "mk_test_YOUR_KEY_HERE" }
     }
   }
@@ -128,7 +111,7 @@ Edit `.vscode/mcp.json` in your workspace:
 
 ---
 
-## 4. Confirm it works
+## 3. Confirm it works
 
 Ask your agent:
 
@@ -142,7 +125,7 @@ List my HonkIO phone numbers.
 To check the server outside any AI tool:
 
 ```sh
-HONKIO_API_KEY=mk_test_YOUR_KEY node dist/index.js
+HONKIO_API_KEY=mk_test_YOUR_KEY npx -y @honkio/mcp
 ```
 
 It should start and wait silently on stdin — an MCP server speaks JSON-RPC over stdio, so no output is the healthy state. Press Ctrl-C to exit. If it exits immediately with an error, the message tells you what is wrong.
@@ -310,8 +293,9 @@ Agents act on instructions that can be vaguer than you intended. If you are expl
 | Symptom | Cause and fix |
 |---|---|
 | `Error [UNAUTHORIZED]` | Key is wrong, revoked, or `HONKIO_API_KEY` never reached the server. Check the `env` block in your config. |
-| Tools do not appear in the agent | The client did not start the server. Confirm the path in `args` is absolute and that `dist/index.js` exists — run `npm run build` if it does not. Restart the client. |
-| `Cannot find module …/dist/index.js` | You skipped `npm run build`, or the path is wrong. |
+| Tools do not appear in the agent | The client did not start the server. Restart the client, and check that `npx` is on its `PATH` — GUI apps do not always inherit your shell's `PATH`. |
+| First start is slow, or times out once | `npx` downloads the package on first use. Run `npx -y @honkio/mcp` once in a terminal to warm the cache, then restart your client. |
+| `npm ERR! 404 @honkio/mcp` | Usually an npm registry override or a private proxy. Check `npm config get registry`. |
 | `Error [PAYMENT_REQUIRED]` | The account needs an initial top-up before live use. |
 | `Error [ACCOUNT_NOT_VERIFIED]` | Live sending needs the account owner's phone verified. Do it in the dashboard. |
 | `501 DNCL_COMING_SOON` | Expected. DNCL checking is not live yet. |
@@ -321,13 +305,21 @@ Agents act on instructions that can be vaguer than you intended. If you are expl
 
 ## Development
 
+To work on the server rather than just use it:
+
 ```sh
+git clone https://github.com/jeffcaldwellca/honkio
+cd honkio/mcp
+npm install
+
 npm run dev        # run from source with tsx, no build step
 npm run typecheck  # types only
 npm run build      # compile to dist/
 ```
 
-Point the server at a local API with `HONKIO_API_URL=http://localhost:3000`.
+Point a local checkout at your own API with `HONKIO_API_URL=http://localhost:3000`, and at a local build by using `node /path/to/honkio/mcp/dist/index.js` as the `command` in your client config instead of `npx`.
+
+`dist/` is gitignored and the published tarball is built from it, so `prepublishOnly` rebuilds on every `npm publish` — never publish without letting it run.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkio/mcp",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "HonkIO MCP server — lets AI coding agents send SMS, manage Canadian phone numbers, and handle CASL/DNCL compliance",
   "type": "module",
   "main": "dist/index.js",