callwright 1.0.0 → 1.0.1
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.
- package/README.md +27 -4
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -96,18 +96,35 @@ Callwright dials through [Retell](https://retellai.com), so you need a Retell ac
|
|
|
96
96
|
|
|
97
97
|
---
|
|
98
98
|
|
|
99
|
+
## Install
|
|
100
|
+
|
|
101
|
+
Published on npm as [`callwright`](https://www.npmjs.com/package/callwright). Install globally to get the `callwright` (server) and `callwright-init` (setup wizard) commands:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npm install -g callwright
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Or clone this repo and `npm install` to run from source (`node server.js`, `node init.js`).
|
|
108
|
+
|
|
109
|
+
Either way, callwright is a **self-hosted, single-user HTTP MCP server**: you run your own instance with your own [Retell](https://retellai.com) credentials (see [Retell setup](#retell-setup-prerequisites) above). Nothing is shared or multi-tenant.
|
|
110
|
+
|
|
99
111
|
## Run locally
|
|
100
112
|
|
|
113
|
+
Using the global install:
|
|
114
|
+
|
|
101
115
|
```bash
|
|
102
|
-
|
|
103
|
-
node init.js # one-time setup wizard (number, agent, your identity)
|
|
116
|
+
callwright-init # one-time setup wizard (number, agent, your identity)
|
|
104
117
|
export RETELL_API_KEY=key_xxx # [Environment]::SetEnvironmentVariable on Windows
|
|
105
|
-
|
|
118
|
+
callwright # MCP server on :8787 (POST /mcp)
|
|
106
119
|
```
|
|
107
120
|
|
|
108
|
-
|
|
121
|
+
From a cloned repo, use `node init.js` and `node server.js` instead.
|
|
122
|
+
|
|
123
|
+
Check setup anytime: `callwright-init status` (or `node init.js status`).
|
|
109
124
|
Place a call from the CLI (bypassing MCP): `node dispatch.js <job.json> --go`.
|
|
110
125
|
|
|
126
|
+
> For **local** use, `MCP_AUTH_TOKEN` is optional — with it unset the server accepts loopback connections only. Set it once you expose the server beyond localhost (see [Deploy hosted](#deploy-hosted-single-user)).
|
|
127
|
+
|
|
111
128
|
---
|
|
112
129
|
|
|
113
130
|
## Deploy hosted (single-user)
|
|
@@ -135,6 +152,12 @@ docker run -p 8787:8787 --env-file .env callwright
|
|
|
135
152
|
```
|
|
136
153
|
Or point the host at this repo (it auto-detects the Dockerfile). Mount a volume at the app dir so `config.json` / `scenario-profiles.json` persist across restarts.
|
|
137
154
|
|
|
155
|
+
No-Docker alternative: install from npm on the host and run the binary directly (point `CALLWRIGHT_DATA_DIR` at your persistent volume so runtime state survives restarts):
|
|
156
|
+
```bash
|
|
157
|
+
npm install -g callwright
|
|
158
|
+
CALLWRIGHT_DATA_DIR=/data callwright # reads RETELL_API_KEY / MCP_AUTH_TOKEN from env
|
|
159
|
+
```
|
|
160
|
+
|
|
138
161
|
### 4. First-run setup over MCP (no webpage needed)
|
|
139
162
|
Do setup **in chat**:
|
|
140
163
|
1. Connect the server (below).
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "callwright",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"mcpName": "io.github.topness-msft/callwright",
|
|
4
5
|
"description": "A voice agent that places phone calls (reservations, appointments, inquiries) on your behalf, shaped by LLM direction + grounding. Runs fire-and-forget on Retell; an MCP server lets an LLM shape the grounding before each call.",
|
|
5
6
|
"main": "server.js",
|
|
6
7
|
"bin": {
|