WordClaw is a safe content runtime for AI agents and human supervisors.
It combines structured content contracts, review-aware workflows, dry-run safety, auditability, paid-content flows, and agent-native REST/MCP access so autonomous systems can work with content without losing governance.
For active product direction, see the roadmap and RFC index.
- Structured content with JSON Schema validation, globals, localization, versioning, rollback, and published-vs-working-copy reads.
- Governance primitives such as workflows, dry-run mutation paths, audit logs, idempotency, and tenant isolation.
- Schema-aware assets, reusable forms, background jobs, preview tokens, and reverse-reference inspection.
- REST-first and MCP-first agent surfaces, plus a supervisor UI for oversight.
- Optional semantic search via pgvector and embeddings when
OPENAI_API_KEYis configured.
For the fuller capability breakdown, see Features.
git clone https://github.com/dligthart/wordclaw.git
cd wordclaw
npm install
cp .env.example .env
docker compose up -d
npm run db:migrate
npm run dev:allThat gives you:
- API:
http://localhost:4000/api - Swagger/OpenAPI docs:
http://localhost:4000/documentation - MCP endpoint:
http://localhost:4000/mcp - Supervisor UI (dev):
http://localhost:5173/ui/
Verify the runtime:
curl http://localhost:4000/health
curl http://localhost:4000/api/deployment-status
npx tsx src/cli/index.ts capabilities statusIf deployment-status reports domainCount: 0, bootstrap the first domain before creating content types or content items. Prefer the dedicated CLI path locally:
npx tsx src/cli/index.ts domains create \
--name "Local Development" \
--hostname local.developmentEquivalent bootstrap paths are MCP create_domain and REST POST /api/domains. AUTH_REQUIRED=false only opens public discovery; write-capable routes still need a credential unless ALLOW_INSECURE_LOCAL_ADMIN=true is active in a non-production environment.
The step-by-step version lives in Getting Started.
npx tsx src/cli/index.ts capabilities status
npx tsx src/cli/index.ts mcp call guide_task --json '{"taskId":"discover-deployment"}'
npx tsx src/cli/index.ts domains list
npx tsx src/cli/index.ts mcp inspect --mcp-transport http --api-key writer
npx tsx src/cli/index.ts workspace guide
npx tsx src/cli/index.ts content guide
npx tsx src/cli/index.ts content guide --content-type-id 1Use content guide without --content-type-id when you need to bootstrap a new schema first. It now returns starter guidance for agent memory, task-log, and checkpoint-style content models.
Live verification helpers now live under scripts/verification/ and are exposed as npm run verify:* commands.
- Fork the repository.
- For major features or architecture changes, start with an RFC in
doc/rfc/. - Create a feature branch.
- Commit your changes.
- Open a pull request.