docx-store 0.1.6

Storage models and schema helpers for docx-mcp.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# docx-mcp

Docx MCP workspace with a daemon and supporting libraries for indexing and serving docx metadata.

Crates:
- docx-mcpd: MCP daemon
- docx-mcp: MCP tools
- docx-core: core types and helpers
- docx-store: storage models and schema helpers

Testing:

`npx @modelcontextprotocol/inspector -- target\debug\docx-mcpd.exe --stdio`

## Docker

Pull the image:

```bash
docker pull barronkane/docx-mcp:latest
```

Run (HTTP MCP + ingest enabled by default):

```bash
docker run --rm -p 4020:4020 -p 4010:4010 \
  -e DOCX_DB_URI=ws://surrealdb:8000 \
  -e DOCX_DB_USERNAME=root \
  -e DOCX_DB_PASSWORD=root \
  barronkane/docx-mcp:latest
```

Endpoints:
- MCP HTTP: `http://127.0.0.1:4020/mcp`
- Ingest HTTP: `http://127.0.0.1:4010/ingest`

Run with stdio (optional):

```bash
docker run --rm -it \
  -e DOCX_DB_URI=ws://surrealdb:8000 \
  -e DOCX_DB_USERNAME=root \
  -e DOCX_DB_PASSWORD=root \
  barronkane/docx-mcp:latest --stdio
```

HTTP ingest payloads accept one of `contents` or `contents_path`.
`contents_path` must point to a file accessible to the server host.

Or use compose (pulls `barronkane/docx-mcp:latest`, includes SurrealDB):

```bash
docker compose up -d
```

Development (local build only, not required for normal usage):

```bash
docker compose -f compose.dev.yaml up --build
```

Container defaults:
- MCP HTTP: enabled (`DOCX_MCP_SERVE=1`).
- Ingest HTTP: enabled (`DOCX_INGEST_SERVE=1`).
- Stdio: disabled (`DOCX_ENABLE_STDIO=0`).
- Database: in-memory if `DOCX_DB_URI` is missing (or `DOCX_DB_IN_MEMORY=1`).

Notes:
- Compose runs SurrealDB as a separate service and wires `DOCX_DB_URI=ws://surrealdb:8000` by default.
- When running the container directly with SurrealDB, provide your own `DOCX_DB_URI` + credentials.
- Without SurrealDB args (`DOCX_DB_URI` unset), the server uses the in-memory database by default.
- When `DOCX_MCP_SERVE=0`, a non-memory database is required unless `--test` is supplied (set `DOCX_DB_IN_MEMORY=0` with `DOCX_DB_URI` + credentials).

Override addresses with:
- `DOCX_MCP_HTTP_ADDR`
- `DOCX_INGEST_ADDR`

Override SurrealDB settings in compose via the `surrealdb` service definition.