# arma3-wiki MCP server

An MCP (stdio) server that serves the Arma 3 wiki
data generated by [acemod/arma3-wiki](https://github.com/acemod/arma3-wiki) on its
`dist` branch, plus bundled scripting tutorials in `tutorials/`.

The server keeps its own shallow clone of upstream `dist` in `wiki/` (ignored).
It clones on first start, refreshes in the background on every start and every
24 hours while running. The `refresh_wiki` tool forces an update. If a refresh
fails, it keeps serving the cached data.

## Install (any PC)

```
git clone https://github.com/ScottTMConnors/arma3-wiki-mcp.git
cd arma3-wiki-mcp
python -m venv .venv
.venv/Scripts/python -m pip install -r requirements.txt   # Linux/macOS: .venv/bin/python
```

Register it with a client, e.g. a project `.mcp.json`:

```json
{ "mcpServers": { "arma3-wiki": {
    "command": "E:/Storage/repos/arma3-wiki-mcp/.venv/Scripts/python.exe",
    "args": ["E:/Storage/repos/arma3-wiki-mcp/server.py"] } } }
```

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

```toml
[mcp_servers.arma3-wiki]
command = "E:/Storage/repos/arma3-wiki-mcp/.venv/Scripts/python.exe"
args = ["E:/Storage/repos/arma3-wiki-mcp/server.py"]
```

## Tools

| Tool | Purpose |
|---|---|
| `lookup_command(name)` | Full YAML for an SQF command (syntax, locality, examples) |
| `lookup_event(name, category?)` | Full YAML for an event handler |
| `search(query, kind?, limit?)` | Keyword search over names, groups and text |
| `list_group(group)` | Commands in a wiki group; empty lists all groups |
| `list_tutorials()` / `get_tutorial(name)` | Bundled scripting tutorials |
| `wiki_status()` | Data revision, counts, last refresh |
| `refresh_wiki()` | Fetch upstream now |

## Environment

`ARMA3_WIKI_DATA` (cache dir, default `./wiki`), `ARMA3_WIKI_REFRESH_HOURS` (24),
`ARMA3_WIKI_UPSTREAM`, `ARMA3_WIKI_BRANCH` (`dist`).

## License

Server code: MIT (see LICENSE). `tutorials/` and the downloaded wiki data are Bohemia Interactive Community wiki content, non-commercial use only; see NOTICE.md.