Installation¶

archimate-mcp is a standard Python package and a prebuilt container image. Pick the path that matches how the operator want to run it.

Requirements¶

Python 3.11 – 3.14.
No external services. The model engine is self-contained (Python standard-library XML); models are read from and written to a local Open Exchange Format file.

From PyPI (recommended)¶

pip install archimate-mcp

Optional extras¶

The base install is intentionally minimal. Install the extra for what the operator need:

Extra	Install	Pulls in
`mcp`	`pip install "archimate-mcp[mcp]"`	FastMCP MCP-server runtime (`agent-connector-sdk`)
`all`	`pip install "archimate-mcp[all]"`	Everything above
`test`	`pip install "archimate-mcp[test]"`	`pytest`, `pytest-asyncio`, `pytest-cov`, `pytest-xdist`

From source¶

git clone https://github.com/Knuckles-Team/archimate-mcp.git
cd archimate-mcp
pip install -e ".[all]"          # editable install with every extra

With uv:

uv pip install -e ".[all]"
uv run archimate-mcp

Prebuilt Docker image¶

A multi-stage runtime image is published on every release (installs archimate-mcp[all], entrypoint archimate-mcp):

docker pull example/archimate-mcp@sha256:<digest>

docker run --rm -i \
  -e ARCHI_MODEL_PATH=/data/model.archimate \
  -v "$PWD:/data" \
  example/archimate-mcp@sha256:<digest>        # stdio transport (default)

Deployment.

Verify the install¶

archimate-mcp --help
python -c "import archimate_mcp; print(archimate_mcp.__version__)"

Next steps¶

Usage — call the tools, the ArchiApi client, and the CLI.
Configuration — every environment variable.