# StaticX

> API-token-first deployment for static websites.
>
> Humans use the dashboard.
> AI agents use the API, CLI, MCP server, and scoped tokens.

## Machine-readable files

- Canonical OpenAPI:
  https://staticx.site/openapi.json
- API v1 OpenAPI alias:
  https://staticx.site/api/v1/openapi.json
- The OpenAPI alias is byte-identical to the canonical file.
- Full agent playbook:
  https://staticx.site/llms-full.txt
- API base URL:
  https://staticx.site/api/v1

## MCP package

- npm package: staticx-mcp-server
- GitHub:
  https://github.com/madprodworks-coder/staticx-mcp-server
- npm:
  https://www.npmjs.com/package/staticx-mcp-server

## Human docs

- Overview:
  https://staticx.site/documentation
- API reference:
  https://staticx.site/documentation/api
- CLI guide:
  https://staticx.site/documentation/cli
- MCP quick start:
  https://staticx.site/documentation/mcp
- MCP clients:
  https://staticx.site/documentation/mcp-clients
- MCP tools:
  https://staticx.site/documentation/mcp-tools
- Agent guide:
  https://staticx.site/documentation/agents

## Auth rules

- Use `Authorization: Bearer STATICX_API_TOKEN`.
- Prefer site-scoped tokens for one-site automation.
- Prefer workspace-scoped tokens for team or client workspaces.
- Never print, log, commit, or return real token values.

## Deployment rules

- Archive root must contain `index.html` or `index.htm`.
- Archive root must contain `404.html`.
- Upload files or a ZIP before publishing a deployment.
- Publish with `POST /projects/{project}/deployments`.
- Every deployment is versioned and rollback-ready.
- Explain write actions before calling them.
- Ask for explicit confirmation before rollback or deletion.

## Form rules

- StaticX Forms works with normal HTML forms.
- Add `data-staticx-form` to each form to collect entries.
- Use `data-staticx-form-id="contacts"` only when needed.
- Do not wire the form to a custom backend endpoint.
- Do not manually add the StaticX script or submit action.
- StaticX adds the action, honeypot, and same-page script.
- Optional attributes:
  `data-staticx-success-message`
  `data-staticx-error-message`
  `data-staticx-redirect`