Skip to content
Engineering Decision Intelligence
How-toVersion 0.3.0

Install Brightway MCP

Install the server, verify Brightway, and start an MCP transport.

Install from source

bash
git clone https://github.com/SDAI-institute/Brightway-mcp.git
cd Brightway-mcp/brightway_mcp
python -m pip install -e .

For development and tests:

bash
python -m pip install -e ".[dev]"

Verify the environment

bash
python -m pytest -q

The default test configuration excludes tests that download a real background database. Run network-marked tests separately when you intentionally want that coverage.

Start the server

bash
brightway-mcp

After the client connects, start with health_check and list_projects before selecting or modifying a project.

Read-only mode

Use read-only mode when a client should inspect and calculate without creating databases or changing Brightway data. Keep write access disabled until a workflow explicitly requires it.