iit-mcp-autotask 0.7.2 → 0.9.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.
- package/README.md +108 -44
- package/dist/config.d.ts +4 -0
- package/dist/config.js +30 -4
- package/dist/doctor.js +6 -1
- package/dist/main.js +13 -0
- package/dist/mocks/fixture-ops.d.ts +1 -1
- package/dist/tools/catalog-data.d.ts +1 -1
- package/dist/tools/catalog-data.js +1 -1
- package/dist/tools/context.d.ts +1 -1
- package/dist/tools/lists.js +158 -6
- package/dist/tools/results.d.ts +11 -4
- package/dist/tools/results.js +17 -31
- package/dist/tools/schemas.d.ts +35 -1
- package/dist/tools/schemas.js +62 -4
- package/dist/tools/server.d.ts +2 -2
- package/dist/tools/server.js +1 -1
- package/dist/tools/write.js +103 -40
- package/dist/write/store.d.ts +49 -18
- package/dist/write/store.js +990 -424
- package/package.json +2 -2
- package/server.json +4 -4
- package/skills/filter-semantics.md +69 -0
- package/skills/invoice-export.md +1 -1
- package/skills/unbilled-work-review.md +3 -2
package/README.md
CHANGED
|
@@ -8,10 +8,10 @@ context into one call, a generic read layer for the long tail, one result envelo
|
|
|
8
8
|
packaged playbooks, strong security boundaries, and predictable per-tenant in-process state (pooled
|
|
9
9
|
client + SDK-owned TTL caches).
|
|
10
10
|
|
|
11
|
-
> **Package status (2026-10-
|
|
12
|
-
> at `0.
|
|
11
|
+
> **Package status (2026-10-20):** the runtime dependency `node-autotask` is published to public npm
|
|
12
|
+
> at `0.20.0`; the committed `pnpm-lock.yaml` pins that
|
|
13
13
|
> release with its integrity hash, so installs resolve deterministically. The dependency is always npm
|
|
14
|
-
> (node-autotask pinned exactly at `0.
|
|
14
|
+
> (node-autotask pinned exactly at `0.20.0`) — never a `file:`, `git:`, `link:` or workspace reference
|
|
15
15
|
> to a local checkout.
|
|
16
16
|
|
|
17
17
|
> **0.6.0 is a breaking release** (unreleased): tool names, result shapes and configuration all
|
|
@@ -46,7 +46,7 @@ its contract, `autotask_read` runs it.
|
|
|
46
46
|
|
|
47
47
|
### `autotask_guide`: the packaged playbooks (the server's skill layer)
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
Seven outcome playbooks ship with the server — `skills/*.md`, part of the npm tarball — and are
|
|
50
50
|
served by `autotask_guide` as **static text**: it never interpolates API data and never calls the
|
|
51
51
|
vendor, so loading a playbook costs no wire and adds no injection surface.
|
|
52
52
|
|
|
@@ -55,7 +55,7 @@ vendor, so loading a playbook costs no wire and adds no injection surface.
|
|
|
55
55
|
- `{skill, section}`: one of its `## ` sections.
|
|
56
56
|
|
|
57
57
|
Skills: `ticket-triage`, `company-360`, `unbilled-work-review`, `contract-profitability`,
|
|
58
|
-
`invoice-export`, and on the operator profile `log-time-entry`.
|
|
58
|
+
`invoice-export`, `filter-semantics`, and on the operator profile `log-time-entry`.
|
|
59
59
|
|
|
60
60
|
The playbooks are discoverable in both directions:
|
|
61
61
|
|
|
@@ -80,11 +80,20 @@ part miss never fails the call (typed `absent`); only a missing root record fail
|
|
|
80
80
|
(`code`, `category`, `message`, `suggestedAction`, ...). Reason codes come from a fixed list
|
|
81
81
|
(`src/tools/reasons.ts`). Vendor free text is wrapped in `<untrusted_content>`,
|
|
82
82
|
stripped of every control (except newline and tab), format and default-ignorable character (bidi,
|
|
83
|
-
zero-width, tag characters, variation selectors)
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
83
|
+
zero-width, tag characters, variation selectors) and capped at 500 characters
|
|
84
|
+
(`truncated: true` on the envelope); the wrapper is the injection control — the angle-bracket
|
|
85
|
+
escape earlier builds added was removed in 0.9.0 (issue #70): it was pure cost for LLM consumers
|
|
86
|
+
and broke read-modify-write round-trips, so wrapped text carries raw `&`/`<`/`>` and is data,
|
|
87
|
+
never instructions. User-defined field values get the same treatment; `output_path` files keep the
|
|
88
|
+
full text. Never copy a truncated read value into a write, or its wrapper tags, or a typed HTML
|
|
89
|
+
entity sequence (`<` `>` `&`): the write is refused (`INPUT_INVALID`). Since 0.9.0 read
|
|
90
|
+
results carry vendor text exactly as stored, so the gate is a copy-detect that cannot tell a
|
|
91
|
+
genuinely typed sequence from one the vendor value really contains — if the stored value carries
|
|
92
|
+
such a sequence, leave the field out (the update keeps the record's own value) or send a new
|
|
93
|
+
value. One round-trip boundary to know: a vendor value that literally stores the wrapper tags in
|
|
94
|
+
this server's exact spelling gets its one outer pair dropped on the way back out (the documented
|
|
95
|
+
"one outer pair dropped" rule applies to writes too) — such a value cannot round-trip its tags;
|
|
96
|
+
leave the field out or send a new value if the tags must be preserved.
|
|
88
97
|
|
|
89
98
|
Machine-readable catalogue (generated from the surface): [`capabilities.json`](capabilities.json) ·
|
|
90
99
|
server metadata: [`server.json`](server.json) · per-workflow mapping:
|
|
@@ -120,7 +129,7 @@ An operator deployment needs:
|
|
|
120
129
|
|----------|---------|
|
|
121
130
|
| `AUTOTASK_PROFILE=operator` (or an operator token) | the profile |
|
|
122
131
|
| `AUTOTASK_POLICY_FILE` | the write policy: a closed JSON schema, default deny ([example](examples/policy.time-entries.json)) |
|
|
123
|
-
| `AUTOTASK_STATE_DIR` | mode 0700; holds encrypted plans, the idempotency ledger, the hash-chained audit log
|
|
132
|
+
| `AUTOTASK_STATE_DIR` | mode 0700; holds encrypted plans, the idempotency ledger, the hash-chained audit log, the primary lock and the holder registry (many processes may share one dir — see below) |
|
|
124
133
|
| `AUTOTASK_RUN_SCOPE` | stdio: `{"companyIds":[...]}` or `{"all":true}` (the policy's own scope); it can only narrow the policy. On HTTP each operator token carries `runScope` instead |
|
|
125
134
|
| `AUTOTASK_PRINCIPAL` | stdio: the name plans and the audit log are bound to (default `stdio`) |
|
|
126
135
|
| `AUTOTASK_KILL_FILE` | optional: while this file exists every preview and apply is denied (default `<state dir>/KILL`) |
|
|
@@ -159,19 +168,25 @@ the same key only replays `unknown`. Re-read the target; if the write is absent,
|
|
|
159
168
|
a new `idempotency_key` (a new attempt) after the 10-minute cooldown; its duplicate query refuses
|
|
160
169
|
it if the first write did land. Payload field names are matched case-insensitively, and keys that
|
|
161
170
|
differ only by case, or are not plain ASCII field names, are refused. `STATE_UNAVAILABLE` means the
|
|
162
|
-
state dir could not be checked (`retry`) or the server
|
|
171
|
+
state dir could not be checked (`retry`) or the server's own registration in the state dir was removed (`stop`; see below). Use a separate Autotask API user for operator deployments, and run
|
|
163
172
|
the live write leg on throwaway data before relying on it (B7 in the 0.6.0 plan).
|
|
164
173
|
|
|
165
174
|
#### The state lock: recovery
|
|
166
175
|
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
176
|
+
Many processes may share a state dir (issue #68): every process registers its boot in a holder
|
|
177
|
+
registry (`<state dir>/holders/<boot>` plus a 5 s lease) before any other state work, and a
|
|
178
|
+
per-operation lock (`<state dir>/op.lock`) serialises the short shared-state critical sections —
|
|
179
|
+
the boot ledger rewrite, an apply's claim (the fresh ledger scan + the write-ahead `sending`
|
|
180
|
+
line), the apply's result append and every audit append. The dir still names ONE primary in
|
|
181
|
+
`<state dir>/lock` (host, pid and a per-boot id): a boot that finds a LIVE primary (same host,
|
|
182
|
+
a fresh lease) no longer refuses — it boots as a SECONDARY and shares the dir under the op lock.
|
|
170
183
|
|
|
171
|
-
The
|
|
172
|
-
than 15 s (3 refresh cycles) is expired.
|
|
184
|
+
The primary keeps the #55 recovery machinery unchanged. The primary refreshes
|
|
185
|
+
`<state dir>/lock.lease` every 5 s, and a lease older than 15 s (3 refresh cycles) is expired.
|
|
186
|
+
The succession rules:
|
|
173
187
|
|
|
174
|
-
- A live
|
|
188
|
+
- A live primary is never taken: a FRESH lease vetoes any takeover, whatever the pid probe says.
|
|
189
|
+
A secondary boot under a live primary simply registers and shares; it never touches the lock.
|
|
175
190
|
- After a crash, a SIGKILL or an OOM kill the next boot takes the lock over by itself when the
|
|
176
191
|
old holder is gone, including a container where node is PID 1 again (the boot id tells the runs
|
|
177
192
|
apart).
|
|
@@ -182,16 +197,16 @@ than 15 s (3 refresh cycles) is expired. The takeover rules:
|
|
|
182
197
|
its own. With a new hostname (the docker default: the container id) the R6 host refusal applies
|
|
183
198
|
and the operator deletes `<state dir>/lock` (the case below). Every takeover is appended to the
|
|
184
199
|
`audit.jsonl` hash chain as a `lock_takeover` line, and `/ready` reports the lock's age, holder
|
|
185
|
-
id and
|
|
200
|
+
id, lease freshness and the holder count, so an orchestrator can tell a stale lock from a live
|
|
201
|
+
one.
|
|
202
|
+
|
|
203
|
+
Boots sweep the dead registrations, and a `sending` ledger entry becomes `unknown` only when its
|
|
204
|
+
origin is not a live holder: a live peer's in-flight write stays `sending` (an apply of the same
|
|
205
|
+
key replays it, it is never re-sent), while a dead peer's — or a pre-0.8.0, unstamped — entry
|
|
206
|
+
becomes `unknown` exactly as in the single-process case.
|
|
186
207
|
|
|
187
208
|
Cases that need an operator:
|
|
188
209
|
|
|
189
|
-
- **`locked by a running process (pid N)`** (with or without `; its lease is X ms old`): another
|
|
190
|
-
live server holds this state dir (the lease-less form is a pre-0.6.0 server, which never wrote
|
|
191
|
-
one). Confirm with `ps -p N` that it is not a server you forgot, stop it, and start again. If it
|
|
192
|
-
is really gone and the lock's pid is dead, no unlock is needed: the next boot takes the lock
|
|
193
|
-
over immediately (a lease-less pre-0.6.0 lock has no lease to wait out). A live pid with no
|
|
194
|
-
lease is never taken over - stop that server, or delete `<state dir>/lock`.
|
|
195
210
|
- **`locked by host H (pid N); one container per state dir`**: the lock belongs to another host or
|
|
196
211
|
container, whose pids mean nothing here, so it is never taken over automatically. Make sure the
|
|
197
212
|
server on H is stopped (or the container is gone), then delete `<state dir>/lock` and start
|
|
@@ -201,12 +216,25 @@ Cases that need an operator:
|
|
|
201
216
|
atomic renames, so this is not a crash remnant of our own). Make sure no server is running on
|
|
202
217
|
this state dir, delete `<state dir>/lock.lease`, and start again.
|
|
203
218
|
- **`another process is taking over the lock (<state dir>/lock.takeover)`**: a boot crashed in the
|
|
204
|
-
middle of a takeover, a disk error hit mid-create, or two boots raced
|
|
205
|
-
dir, delete `<state dir>/lock.takeover`,
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
219
|
+
middle of a takeover, a disk error hit mid-create, or two boots raced and the wait ran out.
|
|
220
|
+
Make sure no other server is starting on this state dir, delete `<state dir>/lock.takeover`,
|
|
221
|
+
and start again.
|
|
222
|
+
- **`<state dir>/lock disappeared or is unreadable` / `names no pid`**: the lock file is gone or
|
|
223
|
+
corrupt (our writes are atomic, so this is not a crash remnant of our own). Make sure no server
|
|
224
|
+
is running on this state dir, delete `<state dir>/lock` (and `lock.lease`), and start again.
|
|
225
|
+
- **`the op lock could not be taken at boot: …`**: the per-operation lock was already stuck when
|
|
226
|
+
this boot started (the `op.lock` case below, seen at boot). Make sure no server is running on
|
|
227
|
+
this state dir, delete `<state dir>/op.lock` (and `op.lock.lease`), and start again.
|
|
228
|
+
- **`op.lock names no pid` / `a peer process holds <state dir>/op.lock; the wait ran out`**: the
|
|
229
|
+
per-operation lock is stuck — a boot crashed mid-operation and the 10 s wait ran out, or the
|
|
230
|
+
file is corrupt. Make sure no server is running on this state dir, delete `<state dir>/op.lock`
|
|
231
|
+
(and `op.lock.lease`), and start again.
|
|
232
|
+
|
|
233
|
+
Never delete a running server's registration (`<state dir>/holders/<boot>`) while it is running:
|
|
234
|
+
writes stop (`STATE_UNAVAILABLE`) the moment the server notices the file is gone, and it stops
|
|
235
|
+
refreshing the registration's lease. Deleting the primary `lock` out from under a running primary
|
|
236
|
+
is not a stop signal (the next boot simply takes the lock over) — the registration is the stop
|
|
237
|
+
signal. Keep the rest of the state dir; `audit.jsonl` is the write history.
|
|
210
238
|
|
|
211
239
|
### Query results: TSV, `output_path` and the saved-file shape
|
|
212
240
|
|
|
@@ -262,12 +290,25 @@ caller is a request, not the process owner), and it cannot be combined with `for
|
|
|
262
290
|
|
|
263
291
|
The invoice export is the second `output_path` file kind (issue #54): `autotask_invoice_get` with
|
|
264
292
|
`format` `html`/`xml`/`pdf` writes the RAW vendor document (UTF-8 text for `html`/`xml`, the
|
|
265
|
-
decoded bytes for `pdf`) under the same root rules — never a JSON envelope, never a cleaned
|
|
266
|
-
|
|
293
|
+
decoded bytes for `pdf`) under the same root rules — never a JSON envelope, never a cleaned form
|
|
294
|
+
— and the result carries only `outputPath`, `bytes` and `encoding`. Without
|
|
267
295
|
`output_path` the export crosses in-band as the base64 of the raw document (`result.data` decodes
|
|
268
296
|
to the exact vendor markup); a `pdf` past the vendor 1 MiB inline limit is truncated and carries no
|
|
269
297
|
data (and no file).
|
|
270
298
|
|
|
299
|
+
**`enrich` resolves FK ids to names in the same call** (issue #67): `enrich: ['company',
|
|
300
|
+
'resource', 'assignedResource', 'ticket']` — the keys are per-resource (a key that does not apply to
|
|
301
|
+
the resource is refused pre-dispatch, zero wire) — fetches the referenced records per key — a
|
|
302
|
+
`fetchByIds` batch of 250 distinct ids, then one authority read per id the batch did not return
|
|
303
|
+
(query-blind resources are read one by one) — and lands `<key>Name` in each row (`companyName`, the
|
|
304
|
+
joined `firstName middleName lastName`, `ticketNumber`). A key with more than 500 distinct ids is
|
|
305
|
+
skipped (its rows are null) and named in the summary; `include_fields` never blinds it — the server
|
|
306
|
+
adds the keys' FK ids to the outgoing projection; a miss (an id the vendor does not resolve) is a
|
|
307
|
+
`null` on that row only. There is no `contact` key in this release: the SDK's bulk id read refuses
|
|
308
|
+
parent-scoped resources (`contacts` is one — its get needs (parentId, id)) before the request,
|
|
309
|
+
after the query wire is spent; contact names stay reachable via `autotask_resolve` and the
|
|
310
|
+
composite tools, and a scoped contact read is a follow-up.
|
|
311
|
+
|
|
271
312
|
## Transports
|
|
272
313
|
|
|
273
314
|
| Transport | For | Caller auth | Autotask credential |
|
|
@@ -410,7 +451,7 @@ preview/apply path; a plan previewed under 0.6.0 cannot be applied after a rollb
|
|
|
410
451
|
|----------|---------|------|
|
|
411
452
|
| `POST /mcp` | the canonical MCP endpoint (Streamable HTTP transport); Host/Origin validated, 1 MiB body cap | a bearer token in `tokens` mode; per-request `X-Autotask-*` headers for tool calls |
|
|
412
453
|
| `GET /health` | process alive — pre-auth, **no vendor call** (container healthcheck) | none |
|
|
413
|
-
| `GET /ready` | config valid, SDK plan-hash pin checked, server initialised, client factory ready — **no live vendor call** (credentials are request-scoped). In an operator deployment the payload also carries `lock` (the state lock's age, holder id
|
|
454
|
+
| `GET /ready` | config valid, SDK plan-hash pin checked, server initialised, client factory ready — **no live vendor call** (credentials are request-scoped). In an operator deployment the payload also carries `lock` (the state lock's age, holder id, lease freshness and the holder count — see "The state lock: recovery") | none |
|
|
414
455
|
| `GET /doctor` | zero-wire credential/config preflight: per credential field `present`/`len`/`prefix2`/`shapeOk` (`AUTOTASK_SECRET`'s prefix is masked to `[REDACTED]` — no character of a secret is ever emitted; identifiers keep their format prefix), the base-url + allow-list resolution (`default_only` / `allow_list` / `default_and_list` / `any`), the SDK plan-hash gate status and the host-policy mode — **no vendor call, by construction** | Host/Origin validated; a bearer token in `tokens` mode |
|
|
415
456
|
| `GET /metadata` | server identity + the MCP protocol **era pair** (baseline `2026-07-28` + legacy fallback `2025-11-25`) + capability-manifest pointer + the `deployment` block (profile, toolsets, approval mode, caller auth, rate limiting) — the served payload is the repo's `server.json` + build stamp | Host/Origin validated; a bearer token in `tokens` mode |
|
|
416
457
|
|
|
@@ -618,18 +659,41 @@ guards (rate limiter, 429 cooldown) — a worse security posture, not a safer on
|
|
|
618
659
|
|
|
619
660
|
## Security posture
|
|
620
661
|
|
|
621
|
-
- **Redaction on by default, no opt-out surface
|
|
622
|
-
and
|
|
662
|
+
- **Redaction is on by default, with no opt-out surface.** The SDK redacts the personal-data class
|
|
663
|
+
(`redactPersonalData` default-on) and this server never disables it: there is no env or per-call
|
|
664
|
+
switch, and the tests pin that position (`test/unit/config.test.ts`,
|
|
665
|
+
`test/integration/redaction-secret-reads.test.ts`). The confidential class this covers: the
|
|
666
|
+
`configuration_items` domain fields (`domain`, `domainExpirationDateTime`,
|
|
667
|
+
`domainLastUpdatedDateTime`, `domainRegistrationDateTime`), the RMM device-audit fields
|
|
668
|
+
(`rmmDeviceAuditExternalIPAddress`, `rmmDeviceAuditIPAddress`, `rmmDeviceAuditMacAddress`,
|
|
669
|
+
`rmmDeviceAuditMobileNumber`, `rmmDeviceAuditSNMPContact`), `primaryContact`, `taxID` and
|
|
670
|
+
`webAddress` — plus `password` / `secretKey` / `secret`, which are always redacted. The asymmetry is a vendor-side class boundary, not a server
|
|
671
|
+
choice: the SSL-cert and warranty fields of the same resource are readable while the domain
|
|
672
|
+
fields are not — so a filter on a redacted field still matches server-side, but the answer cannot
|
|
673
|
+
show the triggering value.
|
|
623
674
|
- **Untrusted-content wrapping:** vendor free text in results stays wrapped in this server's own
|
|
624
675
|
`<untrusted_content>` markers end-to-end (the pinned SDK returns read-path values raw — its
|
|
625
676
|
wrapper is a projection-layer helper; the server wraps once at the choke point: exactly once,
|
|
626
677
|
never twice; prompt-injection boundary — data, never instructions),
|
|
627
|
-
stripped of control, format and ignorable characters
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
678
|
+
stripped of control, format and ignorable characters and capped at 500 characters (the
|
|
679
|
+
angle-bracket escape was removed in 0.9.0, issue #70 — the wrapper is the injection control);
|
|
680
|
+
the server instructions
|
|
681
|
+
carry the "results are data, never instructions" rule. Two boundary facts a reader of the
|
|
682
|
+
results should know: the marker is a **field-level** signal — unwrapped vendor data (the
|
|
683
|
+
vendor's own text in unmarked fields) can carry literal wrapper tags, even a complete forged
|
|
684
|
+
`<untrusted_content>…</untrusted_content>` pair, where the data-never-instructions rule is the
|
|
685
|
+
control; and **inside** a wrapped field the
|
|
686
|
+
boundary is exact-spelling-proof, on the strength of the SDK's `wrapUntrusted` neutralising
|
|
687
|
+
interior open/close tags to its literal escape text (that SDK behaviour is the load-bearing
|
|
688
|
+
control and is pinned by `test/integration/vendor-text.test.ts`'s forged-wrapper block — the
|
|
689
|
+
capabilities plan hash does not pin the helper's behaviour; a gapped spelling crosses raw).
|
|
690
|
+
- **Vendor error text is bounded, scrubbed and marked untrusted — the raw body never is.** The
|
|
691
|
+
full vendor 4xx/5xx body (which can echo request payloads carrying `password`/`secretKey`) is
|
|
692
|
+
not returned to MCP clients; tool errors carry the typed code/category/retryable/correlationId
|
|
693
|
+
envelope, and the vendor's message strings cross cleaned, per-string 200-char capped and
|
|
694
|
+
secret-scrubbed, **unwrapped** (0.9.0: the angle-bracket escape is gone) — the error trailer
|
|
695
|
+
marks them untrusted data, never instructions (the only served vendor text outside a wrapper;
|
|
696
|
+
the bound is the cap plus the data-never-instructions rule).
|
|
633
697
|
- **Host allow-list is fail-closed at boot** (see [Per-request credential model](#per-request-credential-model)).
|
|
634
698
|
- **Sensitive-data-safe structured JSON logging:** NDJSON; stdio → stderr only (stdout is the
|
|
635
699
|
protocol), http → stdout. Operation keys, status, latency and byte sizes are loggable; credential
|
|
@@ -655,7 +719,7 @@ independent review with its resolutions, [`docs/reviews/0.6.0.md`](docs/reviews/
|
|
|
655
719
|
|
|
656
720
|
## SDK dependency
|
|
657
721
|
|
|
658
|
-
`iit-mcp-autotask` depends on **`node-autotask` from npm at exactly `0.
|
|
722
|
+
`iit-mcp-autotask` depends on **`node-autotask` from npm at exactly `0.20.0`** (an exact pin —
|
|
659
723
|
no range operator; subpaths `.` / `/capabilities` / `/operations` / `/resources` / `/types` /
|
|
660
724
|
`/pool`) — the only **vendor** dependency; the other two runtime dependencies are
|
|
661
725
|
`@modelcontextprotocol/server` (the MCP framework) and `zod` (schema validation). It never
|
|
@@ -665,7 +729,7 @@ user — the published tarball ships no lockfile) must resolve to the release th
|
|
|
665
729
|
reviewed against, or the plan-hash boot check refuses to start.
|
|
666
730
|
|
|
667
731
|
**Publishing `node-autotask` is the maintainer's action, done manually.** It is published on the
|
|
668
|
-
public registry at `0.
|
|
732
|
+
public registry at `0.20.0` (published 2026-10-20); the
|
|
669
733
|
exact pin and the committed `pnpm-lock.yaml` (with `pnpm-workspace.yaml`) pin the real published
|
|
670
734
|
tarball with its integrity hash, so installs resolve to exactly that release — the lockfile
|
|
671
735
|
freezes the pnpm/git/Docker paths, the pin freezes the npm/npx paths. The docs are written against this
|
package/dist/config.d.ts
CHANGED
|
@@ -112,6 +112,10 @@ declare const schema: z.ZodObject<{
|
|
|
112
112
|
warn: "warn";
|
|
113
113
|
}>>;
|
|
114
114
|
}, z.core.$strip>;
|
|
115
|
+
/** The recognised AUTOTASK_* names: the config schema's AUTOTASK_ keys + the removed 0.5.x set (derived, never hand-listed). */
|
|
116
|
+
export declare function recognisedAutotaskVars(): string[];
|
|
117
|
+
/** The set-but-unrecognised AUTOTASK_* env keys (stale 0.4.x-era vars the server never reads). */
|
|
118
|
+
export declare function unrecognisedAutotaskVars(env: Record<string, string | undefined>): string[];
|
|
115
119
|
/**
|
|
116
120
|
* Load the three server-held credential values through the SDK's canonical loader
|
|
117
121
|
* (`loadAutotaskCredentialsFromEnv`, node-autotask 0.8.0), so this process has exactly ONE parser
|
package/dist/config.js
CHANGED
|
@@ -103,7 +103,7 @@ function isPlausibleHost(entry) {
|
|
|
103
103
|
}
|
|
104
104
|
/** Blank-to-undefined preprocessor: `VAR=` (a copied `.env.example` line) means "unset". */
|
|
105
105
|
const blankToUndefined = z.preprocess((raw) => (typeof raw === 'string' && raw.trim() === '' ? undefined : raw), z.string());
|
|
106
|
-
const
|
|
106
|
+
const CONFIG_FIELDS = z
|
|
107
107
|
.object({
|
|
108
108
|
MCP_TRANSPORT: z.enum(TRANSPORTS).default('http'),
|
|
109
109
|
/**
|
|
@@ -249,7 +249,8 @@ const schema = z
|
|
|
249
249
|
AUTOTASK_MAX_RETRIES: z.coerce.number().int().min(0).optional(),
|
|
250
250
|
PORT: z.coerce.number().int().positive().max(65535).default(8080),
|
|
251
251
|
LOG_LEVEL: z.enum(['debug', 'info', 'warn', 'error']).default('info'),
|
|
252
|
-
})
|
|
252
|
+
});
|
|
253
|
+
const schema = CONFIG_FIELDS
|
|
253
254
|
.superRefine((c, ctx) => {
|
|
254
255
|
// The three credential values are all-or-nothing on the config surface: partial server-held
|
|
255
256
|
// tuples cannot be filled field-by-field (a caller splicing its own code with the server's
|
|
@@ -352,6 +353,16 @@ const schema = z
|
|
|
352
353
|
}
|
|
353
354
|
}
|
|
354
355
|
});
|
|
356
|
+
/** The recognised AUTOTASK_* names: the config schema's AUTOTASK_ keys + the removed 0.5.x set (derived, never hand-listed). */
|
|
357
|
+
export function recognisedAutotaskVars() {
|
|
358
|
+
const schemaKeys = Object.keys(CONFIG_FIELDS.shape).filter((k) => k.startsWith('AUTOTASK_'));
|
|
359
|
+
return [...new Set([...schemaKeys, ...Object.keys(REMOVED_VARIABLES)])].sort();
|
|
360
|
+
}
|
|
361
|
+
/** The set-but-unrecognised AUTOTASK_* env keys (stale 0.4.x-era vars the server never reads). */
|
|
362
|
+
export function unrecognisedAutotaskVars(env) {
|
|
363
|
+
const recognised = new Set(recognisedAutotaskVars());
|
|
364
|
+
return Object.keys(env).filter((k) => k.startsWith('AUTOTASK_') && !recognised.has(k)).sort();
|
|
365
|
+
}
|
|
355
366
|
function loadServerCredentials(env) {
|
|
356
367
|
// Only the PRODUCTION spellings are consulted: `loadAutotaskCredentialsFromEnv` also reads the
|
|
357
368
|
// deprecated aliases (`AUTOTASK_API_CODE` / `AUTOTASK_API_INTEGRATION_CODE`, `AUTOTASK_USER`), so
|
|
@@ -464,8 +475,23 @@ export function loadConfig(env = process.env) {
|
|
|
464
475
|
...(parsed.success ? [] : parsed.error.issues.map((i) => ` ${i.path.join('.') || '(config)'}: ${i.message}`)),
|
|
465
476
|
];
|
|
466
477
|
const all = [...problems, ...shapeIssues];
|
|
478
|
+
// #73: the stale-variable diagnostics (additive, throw path only — a valid config still boots;
|
|
479
|
+
// the section is never served on the success path).
|
|
480
|
+
const unrecognised = unrecognisedAutotaskVars(env);
|
|
481
|
+
const section = [
|
|
482
|
+
'AUTOTASK_* env vars:',
|
|
483
|
+
` recognised and set: ${Object.keys(CONFIG_FIELDS.shape).filter((k) => k.startsWith('AUTOTASK_') && env[k] !== undefined).sort().join(', ') || 'none'} — the vars this server actually reads (removed names above are not read)`,
|
|
484
|
+
...(unrecognised.length > 0
|
|
485
|
+
? [
|
|
486
|
+
` unrecognised (ignored by this server): ${unrecognised.join(', ')}`,
|
|
487
|
+
'Unrecognised AUTOTASK_* vars are ignored by this server; if they belong to a newer (or older) server version, check the version this deployment runs, then upgrade or remove them.',
|
|
488
|
+
'Known legacy renames: AUTOTASK_API_CODE -> set AUTOTASK_API_INTEGRATION_CODE instead (the pinned SDK\'s canonical name).',
|
|
489
|
+
]
|
|
490
|
+
: []),
|
|
491
|
+
];
|
|
492
|
+
const tail = `\n\n${section.join('\n')}`;
|
|
467
493
|
throw new ConfigError(shapeIssues.length > 0
|
|
468
|
-
? `Invalid configuration (credential intake refused a value):\n${all.join('\n')}`
|
|
469
|
-
: `Invalid configuration:\n${all.join('\n')}`);
|
|
494
|
+
? `Invalid configuration (credential intake refused a value):\n${all.join('\n')}${tail}`
|
|
495
|
+
: `Invalid configuration:\n${all.join('\n')}${tail}`);
|
|
470
496
|
}
|
|
471
497
|
//# sourceMappingURL=config.js.map
|
package/dist/doctor.js
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* contract it feeds (README §Credentials): run `doctor` before a live session — a green doctor means
|
|
16
16
|
* any later 401 is vendor-side, not a mangled load.
|
|
17
17
|
*/
|
|
18
|
-
import { serverCredentialDefaults } from './config.js';
|
|
18
|
+
import { serverCredentialDefaults, unrecognisedAutotaskVars } from './config.js';
|
|
19
19
|
import { describeCredential, isMalformedCredential } from './credential.js';
|
|
20
20
|
import { SECRET_MARKER, SECRET_VARIABLE } from './credential.js';
|
|
21
21
|
import { assertPlanHash, BUILT_AGAINST_PLAN_HASH } from './tools/catalog-data.js';
|
|
@@ -120,6 +120,11 @@ export function runDoctor(config, env = {}) {
|
|
|
120
120
|
'shape facts only (length, two-character prefix — masked for the secret — and anomaly names) — a credential value is never read out',
|
|
121
121
|
'a green doctor means any later 401 is vendor-side (rotated, revoked or role-restricted credential), not a mangled load',
|
|
122
122
|
];
|
|
123
|
+
// #73: the stale-variable note (diagnostics only — a clean env adds nothing, byte-identical).
|
|
124
|
+
const unrecognised = unrecognisedAutotaskVars(env);
|
|
125
|
+
if (unrecognised.length > 0) {
|
|
126
|
+
notes.push(`unrecognised AUTOTASK_* env vars (ignored by this server): ${unrecognised.join(', ')} — they are not config errors; check the server version if they were copied from another deployment; a known legacy rename is AUTOTASK_API_CODE -> AUTOTASK_API_INTEGRATION_CODE`);
|
|
127
|
+
}
|
|
123
128
|
if (!isStdio) {
|
|
124
129
|
notes.push('http transport: the tool-call credential arrives per request in the X-Autotask-* headers and is checked at that boundary, not here');
|
|
125
130
|
}
|
package/dist/main.js
CHANGED
|
@@ -189,6 +189,19 @@ function main() {
|
|
|
189
189
|
log.error('uncaught exception', { err: err instanceof Error ? (err.stack ?? err.message) : String(err) });
|
|
190
190
|
void handle.close().finally(() => process.exit(1));
|
|
191
191
|
});
|
|
192
|
+
// SIGTERM/SIGINT: close the transport and exit through process.exit, whose 'exit' hook
|
|
193
|
+
// releases the state dir (issue #68: a terminated process must not leave its holder
|
|
194
|
+
// registration behind for the next boot to sweep).
|
|
195
|
+
let stopping = false;
|
|
196
|
+
const stop = (signal) => {
|
|
197
|
+
if (stopping)
|
|
198
|
+
return; // a second signal mid-close: the first one is finishing it
|
|
199
|
+
stopping = true;
|
|
200
|
+
log.info('shutting down', { signal });
|
|
201
|
+
void handle.close().finally(() => process.exit(0));
|
|
202
|
+
};
|
|
203
|
+
process.on('SIGTERM', () => stop('SIGTERM'));
|
|
204
|
+
process.on('SIGINT', () => stop('SIGINT'));
|
|
192
205
|
return;
|
|
193
206
|
}
|
|
194
207
|
// tokens mode: the tokens file is read and validated once, before the listener binds.
|
|
@@ -84,7 +84,7 @@ export declare class MockToolOps implements ToolOps {
|
|
|
84
84
|
}, signal?: AbortSignal) => Promise<unknown>;
|
|
85
85
|
fetchByIds: (client: ToolClient, items: readonly Readonly<{
|
|
86
86
|
resource: string;
|
|
87
|
-
id: number;
|
|
87
|
+
id: number | string;
|
|
88
88
|
fields?: string[];
|
|
89
89
|
}>[], opts?: {
|
|
90
90
|
maxItems?: number;
|
|
@@ -96,7 +96,7 @@ export declare function cacheOptionsForPreset(preset: 'on' | 'off', fieldCacheTt
|
|
|
96
96
|
* fails the boot (or the CI test) instead of quietly shipping a tool surface that no longer
|
|
97
97
|
* describes the SDK behind it.
|
|
98
98
|
*/
|
|
99
|
-
export declare const BUILT_AGAINST_PLAN_HASH = "
|
|
99
|
+
export declare const BUILT_AGAINST_PLAN_HASH = "f6a579e0b7a8544f6e477a730d21a9ba031536392d8dbaeb2f73c61ca290ae91";
|
|
100
100
|
/**
|
|
101
101
|
* Fail fast when the installed SDK's plan has moved out from under this surface.
|
|
102
102
|
* Called at boot (main.ts) and safe to call repeatedly (pure comparison).
|
|
@@ -159,7 +159,7 @@ export function cacheOptionsForPreset(preset, fieldCacheTtlMs) {
|
|
|
159
159
|
* fails the boot (or the CI test) instead of quietly shipping a tool surface that no longer
|
|
160
160
|
* describes the SDK behind it.
|
|
161
161
|
*/
|
|
162
|
-
export const BUILT_AGAINST_PLAN_HASH = '
|
|
162
|
+
export const BUILT_AGAINST_PLAN_HASH = 'f6a579e0b7a8544f6e477a730d21a9ba031536392d8dbaeb2f73c61ca290ae91';
|
|
163
163
|
/**
|
|
164
164
|
* Fail fast when the installed SDK's plan has moved out from under this surface.
|
|
165
165
|
* Called at boot (main.ts) and safe to call repeatedly (pure comparison).
|
package/dist/tools/context.d.ts
CHANGED