staticx 0.1.3 → 0.1.6

package/README.md

@@ -14,11 +14,13 @@ npm install -g staticx
 staticx login --base-url "https://staticx.site/api/v1" --token "STATICX_API_TOKEN"
 staticx whoami
 staticx guide
+staticx mcp
 ```
 
 `staticx login` stores the credentials locally, verifies them with `GET /user`, and prints the active user, token scope, access level, expiry, and next safe commands.
 
 Use `staticx guide` or `staticx commands` when you want the full command map from the terminal.
+Use `staticx mcp` when you want copy-safe MCP snippets for Claude, Cursor, Codex, Cline, Windsurf, Zed, and generic clients.
 
 ## Core commands
 
@@ -33,6 +35,7 @@ staticx deploy --site-id SITE_ID --dir dist
 staticx domain --site-id SITE_ID --domain app.example.com
 staticx domain-status --site-id SITE_ID
 staticx logs --site-id SITE_ID
+staticx mcp
 ```
 
 ## Custom domains
@@ -51,6 +54,27 @@ Check progress any time:
 staticx domain-status --site-id SITE_ID
 ```
 
+## Machine-readable sources
+
+Use these when you want the same contract that the dashboard, CLI, and agents share:
+
+- https://staticx.site/llms.txt
+- https://staticx.site/llms-full.txt
+- https://staticx.site/api/v1/openapi.json
+
+## Plan limits
+
+StaticX enforces the same limits through the dashboard, API, CLI, MCP, URL imports, and hosted forms runtime.
+
+| Plan | Sites | Storage | Max upload | Form entries | Team seats | Rollback history |
+| --- | ---: | ---: | ---: | ---: | ---: | ---: |
+| Free | 1 | 500 MB | 500 MB | 1,000 | 1 | Last 5 versions |
+| Plus | 15 | 10 GB | 50 GB | 20,000 | 5 | Last 10 versions |
+| Pro | 100 | 20 GB | 50 GB | 100,000 | 10 | Last 50 versions |
+| Agency | Custom | Custom | 50 GB | Custom | Custom | Custom |
+
+If a command receives `PLAN_QUOTA_EXCEEDED`, stop and return the exact message. Clean up files/form entries or upgrade before retrying.
+
 ## Token scopes
 
 - Global token: account-wide access for internal operator tools.
@@ -63,9 +87,35 @@ Generate those tokens from:
 - `Project Settings → Agent deploy` for Site
 - `Workspace → Agent deploy` for Workspace
 
+## MCP for AI agents
+
+StaticX MCP uses the separate public package `staticx-mcp-server` and the same scoped API tokens as the CLI.
+
+```json
+{
+  "mcpServers": {
+    "staticx": {
+      "command": "npx",
+      "args": ["-y", "staticx-mcp-server"],
+      "env": {
+        "STATICX_API_TOKEN": "sx_replace_with_your_token",
+        "STATICX_API_BASE_URL": "https://staticx.site/api/v1"
+      }
+    }
+  }
+}
+```
+
+For local HTTP debugging:
+
+```bash
+STATICX_API_TOKEN=sx_replace_with_your_token npx staticx-mcp-server http
+```
+
 ## Notes
 
 - `staticx login` stores the base URL and bearer token locally.
 - `staticx whoami` verifies the token with `GET /user`.
 - `staticx deploy` zips the contents of the given build directory, uploads them, and publishes a new release. The directory must contain `index.html` or `index.htm` plus `404.html` at its root.
 - `staticx domain` calls `POST /projects/{project}/domain` and returns the DNS record plus activation status.
+- Golden deploy prompt: “Deploy `dist` to StaticX project `SITE_ID` using `STATICX_API_TOKEN`. Build, validate `index.html` + `404.html`, apply StaticX form rules if forms exist, zip `dist` root, upload, deploy, check logs, then return the live URL or the exact API error. If you receive `PLAN_QUOTA_EXCEEDED`, stop and return the exact quota message. Never expose the token.”

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "staticx",
-  "version": "0.1.3",
+  "version": "0.1.6",
   "description": "Public CLI for STATICX using token-authenticated /api/v1 routes.",
   "type": "module",
   "publishConfig": {

package/src/index.js

@@ -14,10 +14,12 @@ import {
   printJson,
   printKeyValue,
   printLoginSuccess,
+  printMcpGuide,
   printTable,
+  mcpGuideJson,
 } from './output.js';
 
-const CLI_VERSION = '0.1.3';
+const CLI_VERSION = '0.1.5';
 
 export async function run(argv) {
   const program = new Command();
@@ -32,6 +34,7 @@ export async function run(argv) {
 Common workflow:
   staticx login --base-url "https://staticx.site/api/v1" --token "STATICX_API_TOKEN"
   staticx guide
+  staticx mcp
   staticx deploy --site-id SITE_ID --dir dist
   staticx domain --site-id SITE_ID --domain app.example.com
 
@@ -53,6 +56,19 @@ Deploy rule:
       printCliGuide();
     });
 
+  program
+    .command('mcp')
+    .description('Print MCP setup snippets for Claude, Cursor, Codex, Cline, Windsurf, Zed, and generic clients.')
+    .option('--json', 'Print JSON output')
+    .action((options) => {
+      if (options.json) {
+        printJson(mcpGuideJson());
+        return;
+      }
+
+      printMcpGuide();
+    });
+
   program
     .command('login')
     .description('Store the base URL and token locally, then verify them with GET /user.')

package/src/output.js

@@ -104,8 +104,54 @@ export function printCliGuide() {
     ['staticx logs --site-id SITE_ID --limit 50', 'Read more rows.'],
   ]);
   console.log('');
+  printCommandGroup('Machine-readable sources', [
+    ['https://staticx.site/llms.txt', 'Short index for agents and crawlers.'],
+    ['https://staticx.site/llms-full.txt', 'Expanded agent playbook with prompts and curl examples.'],
+    ['https://staticx.site/api/v1/openapi.json', 'Canonical OpenAPI schema for the public API.'],
+  ]);
+  console.log('');
   console.log('Token scopes: use Site tokens for one-site deploys, Workspace tokens for client workspaces, and Global tokens only for broad operator workflows.');
   console.log('Build rule: deploy folders must include index.html or index.htm and 404.html at the root.');
+  console.log('Plan limits: Free includes 1 site, 500 MB storage, 500 MB uploads, 1,000 form entries, 1 seat, and 5 rollback versions. Plus and Pro raise capacity. Agency uses custom capacity.');
+  console.log('Quota rule: stop on PLAN_QUOTA_EXCEEDED and return the exact API message before retrying.');
+}
+
+export function printMcpGuide() {
+  printBanner();
+  console.log('MCP setup for AI agents');
+  console.log('');
+  printCommandGroup('Install and test', [
+    ['npx -y staticx-mcp-server', 'Run the stdio MCP server from any compatible client.'],
+    ['STATICX_API_TOKEN=sx_xxxxx npx staticx-mcp-server http', 'Start local HTTP mode at http://localhost:3100/mcp for debugging.'],
+  ]);
+  console.log('');
+  console.log('Standard MCP config');
+  console.log(JSON.stringify(mcpGuideJson().config, null, 2));
+  console.log('');
+  console.log('Use a site-scoped token for one-site deploys. Rollback and delete tools require explicit confirmation.');
+}
+
+export function mcpGuideJson() {
+  return {
+    package: 'staticx-mcp-server',
+    auth: 'Scoped API token through STATICX_API_TOKEN.',
+    config: {
+      mcpServers: {
+        staticx: {
+          command: 'npx',
+          args: ['-y', 'staticx-mcp-server'],
+          env: {
+            STATICX_API_TOKEN: 'sx_replace_with_your_token',
+            STATICX_API_BASE_URL: 'https://staticx.site/api/v1',
+          },
+        },
+      },
+    },
+    local_http: {
+      command: 'STATICX_API_TOKEN=sx_replace_with_your_token npx staticx-mcp-server http',
+      url: 'http://localhost:3100/mcp',
+    },
+  };
 }
 
 export function cliGuideJson() {
@@ -136,9 +182,25 @@ export function cliGuideJson() {
         'staticx logs --site-id SITE_ID',
         'staticx logs --site-id SITE_ID --limit 50',
       ],
+      mcp: [
+        'staticx mcp',
+        'npx -y staticx-mcp-server',
+      ],
     },
+    machine_readable: [
+      'https://staticx.site/llms.txt',
+      'https://staticx.site/llms-full.txt',
+      'https://staticx.site/api/v1/openapi.json',
+    ],
     build_rule: 'Deploy folders must include index.html or index.htm and 404.html at the root.',
     token_scopes: 'Use Site tokens for one-site deploys, Workspace tokens for client workspaces, and Global tokens only for broad operator workflows.',
+    plan_limits: {
+      free: '1 site, 500 MB storage, 500 MB max upload, 1,000 form entries, 1 team seat, last 5 rollback versions.',
+      plus: '15 sites, 10 GB storage, 50 GB max upload, 20,000 form entries, 5 team seats, last 10 rollback versions.',
+      pro: '100 sites, 20 GB storage, 50 GB max upload, 100,000 form entries, 10 team seats, last 50 rollback versions.',
+      agency: 'Custom sites, storage, form entries, seats, and rollback history, with 50 GB max upload.',
+    },
+    quota_rule: 'Stop on PLAN_QUOTA_EXCEEDED and return the exact API message.',
   };
 }