iit-mcp-autotask 0.4.3 → 0.6.0

package/.env.example

@@ -21,6 +21,7 @@
 # in the X-Autotask-* headers injected by the gateway.
 
 # stdio (local: Claude Code / Claude Desktop / VS Code) or http (remote MCP clients / gateway).
+# The CLI defaults to http on 127.0.0.1; local clients pass --transport stdio (or set this).
 MCP_TRANSPORT=stdio
 
 # --- Credentials (stdio: required from the environment; http: optional discouraged defaults) ---
@@ -47,21 +48,26 @@ MCP_TRANSPORT=stdio
 # AUTOTASK_ALLOWED_BASE_HOSTS=*.autotask.net
 # AUTOTASK_ALLOW_ANY_BASE_HOST=false
 
-# --- Mutation surface (opt-in; reads are never affected) ---
-# Omit all mutation tools entirely. Set false before enabling a write policy.
-AUTOTASK_READ_ONLY=true
-# deny (default — forgetting this yields a read-only server, never an open one) | allow_list | all
-# (must be typed out deliberately).
-AUTOTASK_WRITE_POLICY=deny
-# Only under allow_list: comma-separated registry operation keys (e.g. time_entries.create).
-# Must be non-empty and every key must exist in the SDK registry and be a write, or boot fails
-# with the variable named. Ignored under deny/all.
-# AUTOTASK_WRITE_ALLOW=time_entries.create
-
-# --- Secret reads (independent of the write policy) ---
-# deny (default) refuses authenticate.get, which returns a plaintext vendor token that the SDK's
-# redaction deliberately exempts. allow permits it; the token is still never logged.
-AUTOTASK_SECRET_READS=deny
+# --- Profile and toolsets (0.6.0) ---
+# readonly (default): reads only, no state. operator: adds autotask_write (preview) and
+# autotask_apply (execute the previewed plan), governed by a policy file; needs the four below.
+AUTOTASK_PROFILE=readonly
+# operator: the write policy (closed JSON schema, default deny; see examples/policy.time-entries.json).
+# AUTOTASK_POLICY_FILE=/etc/autotask-mcp/policy.json
+# operator: the state dir (mode 0700; plans, ledger, audit log, lock; one process per dir).
+# AUTOTASK_STATE_DIR=/var/lib/autotask-mcp
+# operator on stdio: the run scope (required), {"companyIds":[...]} or {"all":true} (= the policy's
+# own scope). It only narrows the policy. On HTTP set runScope per token instead.
+# AUTOTASK_RUN_SCOPE={"companyIds":[12345]}
+# operator on stdio: the principal plans and the audit log are bound to (default stdio).
+# AUTOTASK_PRINCIPAL=nightly-time-entries
+# The kill file: while it exists every preview and apply is denied (default <state dir>/KILL).
+# AUTOTASK_KILL_FILE=/var/lib/autotask-mcp/KILL
+# Optional toolsets on top of core (core is always on): a comma list of service, records, finance,
+# or all. An unknown name fails boot. Unset = core only (10 tools).
+# AUTOTASK_TOOLSETS=service,records,finance
+# Removed in 0.6.0 (boot fails if set): AUTOTASK_READ_ONLY, AUTOTASK_WRITE_POLICY, AUTOTASK_WRITE_ALLOW,
+# AUTOTASK_SECRET_READS. authenticate.* (a credential-minting read) is always refused.
 
 # --- Per-tenant read cache (in-process; never cross-tenant; never on disk) ---
 # on (default): each pooled tenant client applies the SDK reference TTL table (structural ~1 h /
@@ -82,6 +88,24 @@ AUTOTASK_CACHE_PRESET=on
 # symlink escape is refused BEFORE anything is created. See README, Query results.
 # AUTOTASK_OUTPUT_DIR=/srv/autotask-output
 
+# --- HTTP hardening (http transport only) ---
+# Bind address (the --host flag): 127.0.0.1 by default. Off loopback, the two settings below are
+# required or boot fails.
+# MCP_HOST=127.0.0.1
+# Host header values /mcp accepts (comma-separated hostnames; DNS-rebinding defence).
+# AUTOTASK_HTTP_ALLOWED_HOSTS=mcp.example.com
+# Browser Origin hostnames /mcp accepts (a request without an Origin always passes).
+# AUTOTASK_HTTP_ALLOWED_ORIGINS=
+# Caller auth: gateway (the gateway in front authenticates and rate-limits callers) or tokens
+# (this process checks bearer tokens and rate-limits per principal). tokens is required for the
+# operator profile on HTTP and when this process holds Autotask credentials on HTTP.
+# AUTOTASK_HTTP_AUTH=gateway
+# tokens mode: a JSON file mapping the lowercase hex SHA-256 of each token to
+# { "principal": "...", "profile": "readonly"|"operator", "toolsets"?: [...], "runScope"?: {...} }.
+# Every operator token needs a runScope ({"companyIds":[...]} or {"all":true}).
+# AUTOTASK_HTTP_TOKENS_FILE=/run/secrets/autotask-mcp-tokens.json
+# AUTOTASK_HTTP_RATE_PER_MIN=60
+
 # --- Operational ---
 PORT=8080
 LOG_LEVEL=info