Skip to content
VoLCA Docs

server

Starts the HTTP API server. The server loads databases and methods on startup according to your config, then exposes the HTTP API and MCP endpoint.

Usage

Section titled “Usage”
Terminal window
volca --config volca.toml server [OPTIONS]

Command reference

Section titled “Command reference”
{serverHelp}

Examples

Section titled “Examples”
Terminal window
# Start on the default port (from config)
volca --config volca.toml server


# Override port
volca --config volca.toml server --port 9000


# Load specific databases only
volca --config volca.toml server --load ecoinvent,agribalyse


# Desktop mode (minimal logging, prints port for desktop integration)
volca --config volca.toml server --desktop


# Auto-stop after 30 minutes without use (the value is in seconds)
volca --config volca.toml server --idle-timeout 1800

Notes

Section titled “Notes”
  • The server loads all databases with load = true in the config. This may take 30s–2min for large databases.
  • --idle-timeout counts seconds without use. An API request or a running matrix solve postpones the shutdown; an MCP client that stays connected without asking anything does not.
  • To stop a running server: volca --config volca.toml stop or POST /api/v1/auth + DELETE /api/v1/session.
  • The HTTP API is at /api/v1/. The OpenAPI spec is at /api/v1/openapi.json and the Swagger UI at /api/v1/docs.
  • The MCP endpoint is at POST /mcp.