@hatchbox/hatchbox-mcp 0.8.1 → 0.8.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.
Files changed (2) hide show
  1. package/README.md +41 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  An MCP server that wraps Hatchbox's `/api/v1` API, so an LLM agent can inspect and operate your Hatchbox apps, domains, databases, and servers.
4
4
 
5
+ It also ships a Claude Code skill, **`migrate-from-heroku`**, which uses those tools to take a Rails app from Heroku to Hatchbox. See [Migrating from Heroku](#migrating-from-heroku).
6
+
5
7
  ## Tools
6
8
 
7
9
  One tool per operation, each with a `readOnlyHint` or `destructiveHint` annotation, grouped by resource:
@@ -58,23 +60,45 @@ One tool per operation, each with a `readOnlyHint` or `destructiveHint` annotati
58
60
  }
59
61
  ```
60
62
 
61
- ## Plugin (Claude Code)
62
-
63
- Claude Code users can install the MCP server and the Heroku migration skill together:
64
-
65
- ```
66
- /plugin marketplace add hatchboxio/hatchbox-mcp
67
- /plugin install hatchbox@hatchbox
68
- ```
69
-
70
- Set `HATCHBOX_API_TOKEN` in your environment first — the plugin passes it through to the server.
71
-
72
- The bundled `migrate-from-heroku` skill takes a Rails app from Heroku to Hatchbox. It currently
73
- covers preflight, inventory and planning; all of it is read-only and writes nothing to Hatchbox
74
- or Heroku.
75
-
76
- Users of other MCP clients configure the server directly per the Setup section above; the skill
77
- is Claude Code specific.
63
+ ## Migrating from Heroku
64
+
65
+ The `migrate-from-heroku` skill moves one Rails app from Heroku to Hatchbox in Claude Code. It
66
+ plans before it changes anything and waits for your approval, then creates your app, databases,
67
+ env vars and cron jobs on Hatchbox, rehearses the deploy and data transfer, and finally cuts over.
68
+ Your Heroku app is left intact throughout, so you can always roll back.
69
+
70
+ ### Install and run
71
+
72
+ 1. Install or update Claude Code to the latest version
73
+ 2. Make sure your Hatchbox account has an active subscription
74
+ 3. Create an API token at https://hatchbox.io/api_tokens
75
+ 4. Add `export HATCHBOX_API_TOKEN=<your token>` to your shell profile (e.g. `~/.zshrc`)
76
+ 5. Install the Heroku CLI, run `heroku login`, and confirm with `heroku auth:whoami`
77
+ 6. Install `jq` (`brew install jq`)
78
+ 7. In the Hatchbox dashboard, connect GitHub and grant it access to the repo of the Rails app you're migrating
79
+ 8. In the Hatchbox dashboard, add your SSH public key so you can `ssh deploy@<server-ip>` — the database restore runs from a shell on the server
80
+ 9. In the Hatchbox dashboard, create a cluster in the region closest to your Heroku app's region
81
+ 10. In that cluster, create a server with the `web` and `postgresql` roles, plus `redis` if you use Sidekiq or Redis, `worker` for any non-web Procfile entries, and `cron` if you use Heroku Scheduler — wait until it shows active
82
+ 11. Open a **new** terminal window so it picks up `HATCHBOX_API_TOKEN`, then start Claude Code from there
83
+ 12. Run `/plugin marketplace add hatchboxio/hatchbox-mcp`
84
+ 13. Run `/plugin install hatchbox@hatchbox`
85
+ 14. Quit and restart Claude Code, again from a terminal that has the token
86
+ 15. Run `/mcp` and confirm `hatchbox` is connected; if it isn't, reconnect it there
87
+ 16. Ask Claude to call `hatchbox_get_me` and confirm it returns your user
88
+ 17. `cd` into the Rails app's repo and make sure `git status` is clean
89
+ 18. Ask Claude to run the `migrate-from-heroku` skill on your Heroku app, giving it the Heroku app name
90
+ 19. Answer what it stops to ask for: your Heroku Scheduler jobs, approval of the generated `MIGRATION.md`, your app's `<hashid>.hatchboxapp.com` hostname from the dashboard, fresh credentials for any add-ons you're re-signing up for, and the output of the database restore commands you run on the server
91
+ 20. Stop after Phase 6 unless you have a custom domain you control and are prepared for a real cutover — Phase 7 has not been tested yet
92
+ 21. Report anything that was wrong, confusing, or needed a workaround at https://github.com/hatchboxio/hatchbox-mcp/issues, noting which phase it happened in
93
+
94
+ ### Updating
95
+
96
+ 1. Run `/plugin marketplace update hatchbox`
97
+ 2. Run `/plugin update hatchbox@hatchbox`
98
+ 3. Restart Claude Code
99
+
100
+ Using a different MCP client? Configure the server directly as described in [Setup](#setup) — the
101
+ skill itself is Claude Code only.
78
102
 
79
103
  ## Development
80
104
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hatchbox/hatchbox-mcp",
3
- "version": "0.8.1",
3
+ "version": "0.8.2",
4
4
  "description": "MCP server that wraps the Hatchbox /api/v1 API",
5
5
  "type": "module",
6
6
  "main": "build/index.js",