@wirl/mcp 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# @wirl/mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The wirl MCP server, run locally. It lets a coding agent deploy what it just built to wirl, share it with a named colleague, pull a deployed app's source, list versions and roll back.
+
+## Prefer the hosted server
+
+If your agent supports HTTP MCP, you do not need this package. Connect to the hosted endpoint and it opens the browser once to sign in:
+
+```bash
+claude mcp add --transport http wirl https://app.wirl.dev/mcp
+```
+
+The token it receives is deploy-scoped by default: it can deploy, roll back, pull and list, and cannot share apps, change who can open them, or touch connections, members or tokens. One checkbox on the consent page grants full access.
+
+## Running it locally
+
+For agents without HTTP MCP support, this package runs the same tools over stdio, using the credentials `wirl login` wrote. wirl serves the package itself, so the command names its address rather than an npm name:
+
+```bash
+claude mcp add wirl -- npx -y https://app.wirl.dev/cli/wirl-mcp.tgz
+```
+
+Cursor and anything else that speaks MCP take the same command in their own configuration:
+
+```json
+{ "mcpServers": { "wirl": { "command": "npx", "args": ["-y", "https://app.wirl.dev/cli/wirl-mcp.tgz"] } } }
+```
+
+The first time, the agent calls `wirl_login`, shows you a link and a code, and carries on once you approve in the browser. A local server acts with the CLI's credentials, which are full-scope; revoke them on the Connect an agent page at app.wirl.dev if an agent should lose access.
+
+## Tools
+
+`wirl_deploy`, `wirl_preview`, `wirl_preview_fetch`, `wirl_list_previews`, `wirl_delete_preview`, `wirl_delete_app`, `wirl_logs`, `wirl_egress`, `wirl_share`, `wirl_pull`, `wirl_list_apps`, `wirl_list_versions`, `wirl_rollback`, `wirl_list_schedules`, `wirl_run`, `wirl_list_connections`, `wirl_whoami`, and `wirl_login` (local only). No app files pass through the model: deploy reads the directory the agent names. If `wirl.json` declares `public_paths`, `wirl_deploy` hands back the exact URL to paste into Slack, Stripe or GitHub's dashboard.
+
+## Keys never pass through the agent
+
+An app that needs a third-party API declares the connection in `wirl.json`. If the key is missing, the deploy hands back a link to the app's keys page; the person adds the key in their own browser and it goes straight into wirl's vault.
+
+## Requirements
+
+Node 20 or later. Docs: https://docs.wirl.dev. Site: https://wirl.dev. Issues: https://github.com/Brycce/wirl-platform/issues.
+
+wirl is a hosted service; use of this server is governed by the terms at https://wirl.dev/terms.