# Artifacts MCP server

> Allows AI clients to self-host and publish HTML, React components, Markdown, PDFs, and zipped static sites to unguessable URLs on a custom domain.

- Repository: https://github.com/kuyazee/artifacts
- Page: https://hostedmcp.org/servers/kuyazee/artifacts
- Transport: remote
- Stars: 8
- License: MIT
- Latest version: 1.0.0

## Install

### Claude Code

```sh
claude mcp add --env 'ARTIFACTS_API_KEY=<YOUR_ARTIFACTS_API_KEY>' artifacts -- docker run -i --rm ghcr.io/kuyazee/artifacts:latest
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "artifacts": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/kuyazee/artifacts:latest"
      ],
      "env": {
        "ARTIFACTS_API_KEY": "<YOUR_ARTIFACTS_API_KEY>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "artifacts": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/kuyazee/artifacts:latest"
      ],
      "env": {
        "ARTIFACTS_API_KEY": "<YOUR_ARTIFACTS_API_KEY>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"artifacts","type":"stdio","command":"docker","args":["run","-i","--rm","ghcr.io/kuyazee/artifacts:latest"],"env":{"ARTIFACTS_API_KEY":"<YOUR_ARTIFACTS_API_KEY>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "artifacts": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/kuyazee/artifacts:latest"
      ],
      "env": {
        "ARTIFACTS_API_KEY": "<YOUR_ARTIFACTS_API_KEY>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add artifacts --env 'ARTIFACTS_API_KEY=<YOUR_ARTIFACTS_API_KEY>' -- docker run -i --rm ghcr.io/kuyazee/artifacts:latest
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.artifacts]
command = "docker"
args = ["run", "-i", "--rm", "ghcr.io/kuyazee/artifacts:latest"]

[mcp_servers.artifacts.env]
ARTIFACTS_API_KEY = "<YOUR_ARTIFACTS_API_KEY>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'ARTIFACTS_API_KEY=<YOUR_ARTIFACTS_API_KEY>' artifacts docker -- run -i --rm ghcr.io/kuyazee/artifacts:latest
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "artifacts": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/kuyazee/artifacts:latest"
      ],
      "env": {
        "ARTIFACTS_API_KEY": "<YOUR_ARTIFACTS_API_KEY>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `ARTIFACTS_API_KEY` | yes | yes | Bearer token required for all writes and the MCP endpoint |
| `BASE_URL` | no | no | Public origin used in returned artifact URLs (e.g. https://artifacts.example.com) |

## FAQ

### What content types can I publish?

You can publish HTML, JSX/TSX (single React components), Markdown, BPMN 2.0 process maps, PDF, and zipped static sites.

### How do I back up my artifacts?

By default, each artifact is a directory of plain files under /data, so backing up that directory backs up everything.

### Can I use my own domain?

Yes, the service allows you to get an unguessable URL on a domain you control.

### Is there an MCP server included?

Yes, a built-in MCP server allows Claude Code, Codex, or any MCP client to publish artifacts with a single tool call.
