Skip to main content
Glama
arma3-wiki MCP Server

arma3-wiki MCP Server

README.md
# arma3-wiki MCP server

[![CI](https://github.com/ScottTMConnors/arma3-wiki-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/ScottTMConnors/arma3-wiki-mcp/actions/workflows/ci.yml)

An MCP (stdio) server that gives AI assistants the Arma 3 scripting wiki: every
SQF command and event handler from
[acemod/arma3-wiki](https://github.com/acemod/arma3-wiki) (its `dist` branch),
plus bundled scripting tutorials.

![An assistant answering an Arma 3 multiplayer scripting question by looking up hint and remoteExec](docs/demo.gif)

The server keeps its own copy of the wiki data in a per-user cache folder. It
downloads it on first start, then 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.

Tested on Windows, Linux and macOS with Python 3.10 and 3.14.

## Install

You need [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/). There
is nothing to clone and no venv to set up. MCP clients run one of these commands:

```bash
uvx --from git+https://github.com/ScottTMConnors/arma3-wiki-mcp arma3-wiki-mcp
```

Or install it once and point your client at the `arma3-wiki-mcp` command. Use
either uv or pipx:

```bash
uv tool install git+https://github.com/ScottTMConnors/arma3-wiki-mcp
```

```bash
pipx install git+https://github.com/ScottTMConnors/arma3-wiki-mcp
```

The `uvx` command checks GitHub for updates every time it starts, so it needs
GitHub to be reachable. An installed copy starts without internet access, but you
update it yourself (see [Updating](#updating)).

Internet access is needed on first start to download the wiki data (about 11 MB).
If [git](https://git-scm.com/) is on your `PATH` the server keeps a shallow git
clone; otherwise it downloads a zip of the branch from GitHub.

## Register with an MCP client

### Claude Code

```bash
claude mcp add arma3-wiki -- uvx --from git+https://github.com/ScottTMConnors/arma3-wiki-mcp arma3-wiki-mcp
```

Or add it to a project's `.mcp.json`:

```json
{
  "mcpServers": {
    "arma3-wiki": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/ScottTMConnors/arma3-wiki-mcp", "arma3-wiki-mcp"]
    }
  }
}
```

### Claude Desktop

Add the same `mcpServers` block to `claude_desktop_config.json`
(Settings → Developer → Edit Config), then restart the app.

### Codex

In `~/.codex/config.toml`:

```toml
[mcp_servers.arma3-wiki]
command = "uvx"
args = ["--from", "git+https://github.com/ScottTMConnors/arma3-wiki-mcp", "arma3-wiki-mcp"]
```

### Other clients

Any client that supports stdio MCP servers works: run
`uvx --from git+https://github.com/ScottTMConnors/arma3-wiki-mcp arma3-wiki-mcp`, or `arma3-wiki-mcp` if you installed it with uv or pipx.

## Updating

There are two kinds of updates, and you only handle the first:

- **Server code** (this repository). How you get it depends on how you installed:
  - `uvx --from git+...`: nothing to do. It fetches the latest version each time
    your client starts the server.
  - `uv tool install`: run `uv tool upgrade arma3-wiki-mcp`.
  - `pipx install`: run `pipx upgrade arma3-wiki-mcp`.

  Then restart your MCP client so it starts the new version. Run
  `arma3-wiki-mcp --version` (or ask the assistant to call `wiki_status`) to see
  which version you have.
- **Wiki data** (commands, events). Updates itself every 24 hours. To update
  right away, ask the assistant to call `refresh_wiki`.

## 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 variables

All optional.

| Variable | Default | Purpose |
|---|---|---|
| `ARMA3_WIKI_DATA` | Windows: `%LOCALAPPDATA%\arma3-wiki-mcp\wiki`<br>Linux: `~/.cache/arma3-wiki-mcp/wiki`<br>macOS: `~/Library/Caches/arma3-wiki-mcp/wiki` | Where the wiki data is stored |
| `ARMA3_WIKI_REFRESH_HOURS` | `24` | How often to refresh while running |
| `ARMA3_WIKI_UPSTREAM` | `https://github.com/acemod/arma3-wiki.git` | Data repository (must be on GitHub if git is not installed) |
| `ARMA3_WIKI_BRANCH` | `dist` | Data branch |

## Running from a source checkout

```bash
git clone https://github.com/ScottTMConnors/arma3-wiki-mcp.git
cd arma3-wiki-mcp
uv run arma3-wiki-mcp
```

Older setups that point an MCP client at `python /path/to/arma3-wiki-mcp/server.py`
keep working, and keep using the checkout's `wiki/` folder if it has one.

## Development

```bash
uv run pytest              # unit and end-to-end tests, no network
uv run pytest -m network   # also downloads the real wiki data
```

To regenerate the demo GIF: `uv run --with pillow docs/demo/render_demo.py`.
It runs the tool calls for real against the server and renders their results.

## License

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

TDQS

A3.6/5.0

Scored across 8 tools

Disambiguation5/5

Each tool targets a clearly distinct operation: exact command lookup, exact event lookup, keyword search, group listing, tutorial listing/reading, status, and refresh. The boundary between lookup_command/lookup_event and search is well explained by the descriptions (exact YAML vs keyword search).

Naming Consistency4/5

All names use snake_case consistently, but the verb/prefix conventions vary (lookup_, list_, get_, wiki_, refresh_, bare search). The mix is still readable and understandable, with only minor deviations from a pure verb_noun pattern.

Tool Count5/5

Eight tools is well-scoped for a wiki lookup server: it covers lookup, search, browsing, tutorials, and maintenance without excessive redundancy. Each tool earns its place.

Completeness4/5

The surface covers the main lifecycle: exact lookups, keyword search, group browsing, tutorials, status, and refresh. Minor gaps exist, such as no explicit list of event categories or a dedicated event-listing tool, but agents can work around these via search.