Skip to main content
Glama
README.md
# @pipeworx/un-energy

United Nations energy statistics: country energy balances in terajoules and the Energy Statistics Database by fuel, flow and year, answered live per request.

Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 2024+ live data sources. This is an independent, unofficial integration — not affiliated with, endorsed by, or published by the upstream provider.

## Tools

- `un_energy_balance(country, commodity?, flow?, year?)` - energy balance in TJ: product group (coal and peat, oil products, natural gas, electricity, total energy) against a flow (production, imports, exports, total energy supply, transformation, final consumption). Answers "total natural gas supply of Egypt in 2023 in TJ".
- `un_energy_statistics(country, commodity?, flow?, year?)` - one named fuel or product against one flow in the unit the country reported (tonnes, cubic metres, GWh, TJ), with the UNSD conversion factor and the value converted to TJ. Answers "final energy consumption of aviation gasoline in Brazil in 2022".
- `un_energy_codes(kind, query?)` - browse valid countries, products and flows.

## Auth

Keyless.

## Data sources

- United Nations Statistics Division (UNSD), Energy Balances.
- United Nations Statistics Division (UNSD), Energy Statistics Database.

Queried live per request; nothing is stored. Country, product and flow words are resolved against UNSD's own code lists (held in memory for the life of the process). Words matching several products return every match, labelled.

Things worth knowing:

- The two datasets are not the same series. Energy balances are normalised to net calorific terajoules; the Energy Statistics Database carries each country's reported quantity plus the conversion factor UNSD applies. For the same country, fuel and year the TJ totals can differ between them (Egypt natural gas 2023: 1,712,327 TJ in the balances, 1,902,586 TJ in the statistics database).
- Balance flows are signed: exports, stock builds and transformation inputs are negative.
- A query with no record is an error naming what was asked, not an empty list. The latest published year varies by country.
- `value_published x unit_multiplier = value`; UNSD publishes tonnes as thousands (32.668 = 32,668 metric tons).

## Quick Start

Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):

```json
{
  "mcpServers": {
    "un-energy": {
      "url": "https://gateway.pipeworx.io/un-energy/mcp"
    }
  }
}
```

### What this endpoint actually serves

`tools/list` at `https://gateway.pipeworx.io/un-energy/mcp` returns the tools in the table
above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
`discover_tools`, `search_within`, `remember`/`recall` and the rest of the
gateway-wide set. So the tool count you see is larger than this table: a
single-pack endpoint currently lists roughly 30 shared tools alongside the
pack's own. The connection's `initialize` response states its exact scope, and
is the authoritative answer for a given day.

This is deliberate, not multiplexing by accident. The meta-tools are what let a
scoped connection answer a question this pack does not cover — via
`ask_pipeworx`, which routes across the whole catalog — without you adding a
second MCP server. There is currently no way to mount a pack endpoint without
them; if the extra schemas cost you more context than the routing is worth,
connect to the full gateway once rather than to several pack endpoints.

Or connect to the full Pipeworx gateway to get every pack's tools listed
directly, instead of just this one's:

```json
{
  "mcpServers": {
    "pipeworx": {
      "url": "https://gateway.pipeworx.io/mcp"
    }
  }
}
```

Both URLs reach the same gateway and the same 2024+ data sources. The
only difference is which pack's tools are listed **directly**; `ask_pipeworx`
reaches all of them from either one.

## No MCP client? Call it over HTTP

```bash
curl -X POST https://gateway.pipeworx.io/v1/tools/un_energy_balance \
  -H 'Content-Type: application/json' \
  -d '{"country":"Israel","commodity":"coal","flow":"total energy supply","year":2020}'
```

No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/un_energy_balance`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.

## Run it from npm

`@pipeworx/mcp-un-energy` is a local stdio bridge to the Pipeworx gateway: your MCP client
starts it with `npx`, and it forwards every call to the same
`https://gateway.pipeworx.io/un-energy/mcp` endpoint shown above. It needs network access;
there is no offline mode.

```json
{
  "mcpServers": {
    "un-energy": {
      "command": "npx",
      "args": ["-y", "@pipeworx/mcp-un-energy"]
    }
  }
}
```

Without a key it calls anonymously, capped at 50 calls a day. A free account
raises that to 200 a day: get a key at https://pipeworx.io/signup and add
`"env": { "PIPEWORX_API_KEY": "<your key>" }` to the server entry.
The key is sent as a Bearer token, the same way a hosted connection sends it,
so calls are metered and billed exactly as they are there.

It lists **only** this pack's tools by default. Set `PIPEWORX_META_TOOLS=1` to
also list `ask_pipeworx` and the other gateway-wide tools.

Behind an HTTPS proxy: Node's built-in `fetch` does not read `HTTPS_PROXY` by
default. Newer Node releases honour it when `NODE_USE_ENV_PROXY=1` is set; check
your Node version's documentation.

## Using with ask_pipeworx

Instead of calling tools directly, you can ask questions in plain English —
this works on the pack endpoint above as well as on the full gateway:

```
ask_pipeworx({ question: "your question about Un Energy data" })
```

The gateway picks the right tool and fills the arguments automatically.

## More

- [Docs and guides](https://pipeworx.io/docs)
- [pipeworx.io](https://pipeworx.io)

## License

MIT