agent-artifact-engine
v0.1.0
Published
Self-hostable engine for publishing immutable HTML and safe MDX artifacts.
Maintainers
Readme
Agent Artifact Engine
Self-hostable engine for publishing immutable HTML and safe MDX artifacts.
This repo is the OSS core. It intentionally does not include hosted SaaS concerns such as account signup, email token queues, billing, plan limits, admin portals, content scanning policy, abuse adjudication, or provider-specific production policy.
Quick Start
Start a local engine with npx:
npx -y agent-artifact-engineOr clone and run from source:
npm install
npm run devOpen http://127.0.0.1:3000.
The source is split by responsibility:
src/core/ config, types, validation
src/http/ Fastify app and Node entrypoint
src/render/ HTML and safe MDX rendering
src/storage/ file-backed store
src/view/ HTML viewer pages
src/security/ CSP and sandbox helpers
src/utils/ URL, slug, hash, taxonomy helpers
src/cloudflare/ optional Worker adapterPublish an artifact:
curl -X POST http://127.0.0.1:3000/v1/artifacts \
-H "content-type: application/json" \
-d '{
"title": "Hello Artifact",
"format": "html",
"visibility": "public",
"html": "<h1>Hello from an agent</h1><p>This is an immutable artifact.</p>"
}'Core Features
- HTML and safe MDX publishing.
- Immutable artifact versions.
- Local file-backed metadata and blob storage.
- Public, unlisted, and private visibility.
- Share tokens for private/unlisted delivery.
- Sandboxed viewer and raw artifact routes.
- Static export for read-only hosting.
- Dynamic Cloudflare Worker adapter backed by D1/R2.
- Railway/VM/container deployment basics for the Node server.
- Generic stdio MCP server for agent publishing.
- Optional shared-token auth for self-hosted write protection.
Environment
| Name | Default | Notes |
| --- | --- | --- |
| PORT | 3000 | HTTP port. |
| HOST | 0.0.0.0 | HTTP host. |
| PUBLIC_BASE_URL | http://127.0.0.1:<PORT> | Public viewer URL base. |
| ARTIFACT_BASE_URL | PUBLIC_BASE_URL | Raw artifact URL base. |
| DATA_DIR | .data | Local metadata and blob storage. |
| MAX_SOURCE_BYTES | 1048576 | Maximum HTML or MDX source payload size. |
| PUBLISH_TOKEN | empty | Optional shared token for write/private-read routes. |
| ARTIFACT_ALLOW_SCRIPTS | false | If true, sandboxed artifacts may run scripts. |
When PUBLISH_TOKEN is set, send either:
Authorization: Bearer <token>or:
x-publish-token: <token>Routes
| Method | Route | Purpose |
| --- | --- | --- |
| GET | / | Recent public artifacts. |
| GET | /health | Health check. |
| POST | /v1/artifacts | Create an artifact. |
| GET | /v1/artifacts/:id | Read artifact metadata. |
| POST | /v1/artifacts/:id/versions | Add an immutable version. |
| POST | /v1/artifacts/:id/share | Create a share token. |
| GET | /v1/tags | List public tag counts. |
| GET | /v1/categories | List public category counts. |
| GET | /a/:slug | Artifact viewer. |
| GET | /s/:token | Share-token viewer. |
| GET | /raw/:versionId | Raw artifact HTML. |
| GET | /embed/:artifactId | Bare embed page. |
Static Export
DATA_DIR=.data STATIC_BASE_URL=http://127.0.0.1:4173 npm run static:export
npm run static:serve -- --dir static-export --port 4173Static export is read-only. New publishes require running the dynamic server and exporting again.
Cloudflare
Dynamic Worker deployment:
cp .dev.vars.example .dev.vars
npm run cf:worker:migrate
npm run cf:worker:dev
npm run cf:worker:deployStatic Pages deployment:
STATIC_BASE_URL=https://your-project.pages.dev npm run static:export
npm run cf:pages:deploy -- --project-name your-projectSee docs/cloudflare.md.
Railway
Deploy with the Railway button above. The template mounts persistent storage at /data; see docs/railway.md for storage and template notes.
MCP
Build the generic stdio MCP server:
npm run mcp:buildConfigure it with any Agent Artifact Engine URL:
{
"mcpServers": {
"agent-artifact-engine": {
"command": "npx",
"args": ["-y", "agent-artifact-engine-mcp"],
"env": {
"AGENT_ARTIFACT_ENGINE_URL": "https://your-engine.example.com",
"AGENT_ARTIFACT_ENGINE_TOKEN": "optional-publish-token"
}
}
}
}See mcp/agent-artifact-engine/README.md.
Boundary
Core exposes primitives and optional hooks. Hosted products should implement their own identity, moderation, analytics, billing, admin, and policy layers around this engine.
