@cyanheads/faostat-mcp-server
v0.3.0
Published
Global food & agriculture statistics from the UN FAOSTAT bulk-download corpus, served from a local SQLite mirror with a DataCanvas SQL surface, over MCP. STDIO & Streamable HTTP.
Downloads
772
Maintainers
Readme
Public Hosted Server: https://faostat.caseyjhand.com/mcp
Overview
Global food and agriculture statistics from the UN FAOSTAT bulk-download corpus — crop and livestock production, agricultural trade, food balances, food security and nutrition, land use, fertilizer use, and agrifood-systems emissions for 245+ countries and territories from 1961 to the present. Discover a domain, resolve area/item/element codes, then query the cube; large or merged result sets spill to a DataCanvas SQL surface for GROUP BY, ranking, and time-series analysis. Runs as a stdio process, a local Streamable HTTP server, or the public hosted endpoint above.
Tools
| Tool | Description |
|:---|:---|
| faostat_list_domains | Discover FAOSTAT statistical domains with codes, descriptions, last-update date, upstream row count, and local index status. The entry point — every query keys on a domain code. |
| faostat_resolve_codes | Resolve human terms to the opaque integer codes a query needs (areas, items, elements), flagging each area as a country or an aggregate region. |
| faostat_query_observations | Query a domain's cube by area(s), item(s), element(s), and year range. Inline preview for small results; large sets spill to a DataCanvas table. |
| faostat_commodity_profile | Workflow: assemble top producers, the production trend, and trade flows for one commodity from the production and trade domains in a single call. |
| faostat_dataframe_query | Run a read-only SQL SELECT against the canvas tables staged by the analytical tools. |
| faostat_dataframe_describe | List the canvas tables staged this session, each with provenance, row count, and column schema. |
| faostat_dataframe_drop | Drop one staged canvas table before its 2-hour TTL. Opt-in — callable only with FAOSTAT_DATAFRAME_DROP_ENABLED=true. |
Capability reference
faostat_list_domains tool
- Full FAOSTAT catalog (~69 domains) read live from the bulk manifest, annotated with local mirror status
codefor an exact domain lookup;topicsubstring filter over code/name/topic;indexed_onlyto list only domains queryable from the local mirroroffset+limit(max 200, default 20) page the catalog — response reportstotalMatches,truncated, andnextOffset- Each entry reports
indexed/index_readyflags, local row count, and last completed sync
faostat_resolve_codes tool
- FTS5 full-text
query, substringname_contains, or exactcodelookup within adimension:area,item, orelement - Item/element matches are scoped to codes present in the given
domain's cube; area codes are shared across domains - Every area match is flagged
countryoraggregate(codes ≥ 5000, plus curated sub-threshold roll-ups such as China=351) limit(max 200, default 50) +offsetpage the match set- Typed errors:
unknown_domain,index_not_ready,query_timeout
faostat_query_observations tool
- Filters by
area_codes/item_codes/element_codesand an inclusiveyear_start/year_endrange - Aggregate regions excluded by default (
include_aggregates: false); explicitarea_codesbypass the exclusion limitcaps the inline page (default 200, max 1000); a match that exceeds it spills in full to a DataCanvas table (50,000-row staging cap) —faostat_dataframe_describefor its columns, then SQL viafaostat_dataframe_query- Every row carries its data-quality
flag(A/E/I/B/M/T/X, others per domain) — never dropped - Typed errors:
domain_not_indexed,index_not_ready,canvas_disabled,canvas_not_found,invalid_year_range,query_timeout
faostat_commodity_profile tool
- Resolves
item_queryto up to 5 item codes, then ranks top producers/exporters/importers and returns an annual production trend in one call - Rankings are per-country sums grouped by unit, each country at its own latest reporting year; countries only (aggregates excluded)
- Returns a partial, production-only profile with a notice — rather than failing — when the trade domain (TCL) isn't indexed or still syncing
top_ncaps each ranked list (max 50); when the merged observation set is too large to inline it spills to a DataCanvas table —faostat_dataframe_describefor its columns, thenfaostat_dataframe_queryfor further SQL- Every staging outcome is stated in the notice: the staged table, a set that fit inline, a staging failure, or a disabled canvas
- Typed errors:
no_match,domain_not_indexed,index_not_ready,invalid_year_range,canvas_not_found,query_timeout
faostat_dataframe_query tool
- Single-statement read-only
SELECTover stagedfaostat_xxxxxxxxtables — joins, aggregates, window functions, and CTEs all work - Writes, DDL,
DROP,COPY,PRAGMA,ATTACH, external-file functions, and system catalogs (information_schema,sqlite_master,duckdb_*) are rejected row_limitcaps the response (default 1000, max 10000);truncatedmeans more rows exist, with no exact total computed on this path- Typed errors:
canvas_disabled,canvas_not_found,missing_table,system_catalog_access,invalid_sql
faostat_dataframe_describe tool
- Lists staged tables with source tool, query params, row count, column schema, and creation/expiry (2-hour sliding TTL)
namedescribes one table outright; otherwiseoffset+limit(max 100, default 20) page the listing newest-first- Typed errors:
canvas_disabled,canvas_not_found,missing_table
faostat_dataframe_drop tool
- Opt-in: registered disabled — listed on the landing page with its enable hint, absent from
tools/list— unlessFAOSTAT_DATAFRAME_DROP_ENABLED=true - Drops one staged
faostat_xxxxxxxxtable and its provenance from the session canvas, or from the canvas acanvas_idnames - Idempotent: a name not staged on that canvas returns
dropped: falsewith a notice and changes nothing - Typed errors:
canvas_disabled,canvas_not_found
Features
Built on @cyanheads/mcp-ts-core: stdio and Streamable HTTP transports, pluggable auth (none / jwt / oauth), swappable storage (in-memory, filesystem, Supabase, Cloudflare KV/R2/D1), structured logging with optional OpenTelemetry tracing.
FAOSTAT-specific:
- Persistent local SQLite mirror of the FAOSTAT bulk corpus via the framework
MirrorService, with FTS5 over the dimension labels driving code resolution - Streaming bulk-ZIP ingester — skips domains whose upstream update date hasn't advanced, and stream-parses the normalized CSV into SQLite without materializing the full file in memory
- Config-driven domain selection (
FAOSTAT_DOMAINS) — the indexed set can grow without code changes, and the full catalog stays browsable regardless - DataCanvas SQL surface (DuckDB) for
GROUP BY, ranking, and time-series analysis over spilled result sets
Agent-friendly output:
- Country-vs-aggregate classification on every area, with aggregates excluded from sums by default — guards against double-counting World/continent rows with their member countries
- Data-quality provenance — every observation carries its FAOSTAT flag (
A/E/I/B/M/T/X, others per domain), never dropped from output - Graceful partial results —
faostat_commodity_profilereturns a production-only profile with a notice, rather than failing, when the trade domain isn't indexed - Typed error contracts —
index_not_ready,domain_not_indexed,canvas_disabled, and others each carry a concrete recovery hint
Getting started
Public Hosted Instance
A public instance is available at https://faostat.caseyjhand.com/mcp — no installation required. Point any MCP client at it via Streamable HTTP:
{
"mcpServers": {
"faostat-mcp-server": {
"type": "streamable-http",
"url": "https://faostat.caseyjhand.com/mcp"
}
}
}Self-Hosted / Local
Add the following to your MCP client configuration file. The server runs entirely on a local mirror, so build the mirror once before querying.
{
"mcpServers": {
"faostat-mcp-server": {
"type": "stdio",
"command": "bunx",
"args": ["@cyanheads/faostat-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info"
}
}
}
}Or with npx (no Bun required):
{
"mcpServers": {
"faostat-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@cyanheads/faostat-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info"
}
}
}
}Or with Docker:
{
"mcpServers": {
"faostat-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "MCP_TRANSPORT_TYPE=stdio",
"-v", "faostat-mirror:/usr/src/app/.faostat-mirror",
"ghcr.io/cyanheads/faostat-mcp-server:latest"
]
}
}
}For Streamable HTTP, set the transport and start the server:
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http
# Server listens at http://localhost:3010/mcpNo API key is required — the FAOSTAT bulk-download service is public and keyless.
Prerequisites
- Bun v1.4.0 or higher (or Node.js v24+).
- Disk for the local mirror. The default domain set (
QCL,TCL,FBS,FS,RL,GLE,RFN,QV, ∼37M rows) needs a few GB;TCL(∼17M rows) dominates and can be dropped fromFAOSTAT_DOMAINSon a constrained host.
Installation
- Clone the repository:
git clone https://github.com/cyanheads/faostat-mcp-server.git- Navigate into the directory:
cd faostat-mcp-server- Install dependencies:
bun install- Configure environment:
cp .env.example .env
# edit .env to override the default domain set, mirror path, or refresh cronBuilding the mirror
The corpus is not bundled. Before the data tools can answer queries, sync the selected domains into the local mirror:
bun run mirror:init # one-time bootstrap — downloads and indexes the FAOSTAT_DOMAINS set
bun run mirror:refresh # re-sync domains whose upstream update date has advanced; build missing planner statistics
bun run mirror:verify # report sync status, local row counts, and sample readsmirror:init is idempotent and resumable per domain — re-running after an interrupt re-streams only the unfinished domain ZIP. FAOSTAT_DOMAINS selects which domains are indexed; everything else in the catalog shows in faostat_list_domains with indexed: false until added and re-synced. On HTTP transport, set FAOSTAT_REFRESH_CRON to refresh in-process on a schedule; on stdio, run mirror:refresh out-of-band. The read tools return index_not_ready until the first sync completes.
mirror:refresh also builds query-planner statistics (ANALYZE) for any selected domain that has none, even when its data is unchanged upstream — a mirror synced by an older release, or one whose last build failed. Otherwise the server builds them itself, in the background on a worker thread, the first time a data read touches that domain, and keeps answering meanwhile.
Configuration
| Variable | Description | Default |
|:---------|:------------|:--------|
| FAOSTAT_DOMAINS | Comma-separated FAOSTAT domain codes to index into the local mirror. Domains outside this set appear in faostat_list_domains but are not queryable until added and re-synced. | QCL,TCL,FBS,FS,RL,GLE,RFN,QV |
| FAOSTAT_MIRROR_PATH | Directory holding the per-domain SQLite stores and the shared dimension database. Created if absent. | ./.faostat-mirror |
| FAOSTAT_BULK_BASE_URL | FAOSTAT bulk-download service base URL (manifest + per-domain ZIPs). | https://bulks-faostat.fao.org/production |
| FAOSTAT_REFRESH_CRON | Cron for the in-process incremental refresh (HTTP transport only). Omit to disable and run mirror:refresh out-of-band. | — |
| CANVAS_PROVIDER_TYPE | DataCanvas engine. duckdb enables the SQL surface; set none to disable analytical staging (the dataframe_* tools then report canvas_disabled and large queries refuse to spill). | duckdb |
| FAOSTAT_DATAFRAME_DROP_ENABLED | Set true to make faostat_dataframe_drop callable. Off, the tool is registered disabled: absent from tools/list, shown on the landing page with this hint. | false |
| MCP_TRANSPORT_TYPE | Transport: stdio or http. | stdio |
| MCP_SESSION_MODE | HTTP session mode: stateless, stateful, or auto (resolves to stateful). The server declares stateless in src/index.ts — no tool asks the caller for input mid-handler — and setting this overrides that declaration. | stateless |
| MCP_HTTP_PORT | Port for the HTTP server. | 3010 |
| MCP_AUTH_MODE | Auth mode: none, jwt, or oauth. | none |
| MCP_LOG_LEVEL | Log level (RFC 5424). | info |
| LOGS_DIR | Directory for log files (Node.js only). | <project-root>/logs |
See .env.example for the full list of optional overrides.
Running the server
Local development
Build and run:
# One-time build bun run rebuild # Run the built server bun run start:stdio # or bun run start:httpRun checks and tests:
bun run devcheck # Lint, format, typecheck, security bun run test # Vitest suite under Bun, then under Node bun run lint:mcp # Validate MCP definitions against spec
Docker
docker build -t faostat-mcp-server .
docker run --rm -p 3010:3010 -v faostat-mirror:/usr/src/app/.faostat-mirror faostat-mcp-serverThe Dockerfile defaults to HTTP transport, stateless session mode, and logs to /var/log/faostat-mcp-server. A dedicated dependency stage installs the production tree for the target platform (DuckDB's prebuilt native binding included), so the slim runtime image carries no build toolchain and a multi-arch build never runs Bun under emulation. OpenTelemetry peer dependencies are installed by default — build with --build-arg OTEL_ENABLED=false to omit them. Mount a volume at the mirror path to persist the corpus across container recreations, and bootstrap it inside the container:
docker exec <container> bun run mirror:init # one-time bootstrap
docker exec <container> bun run mirror:verify # sync status + sample reads
docker exec <container> bun run mirror:refresh # re-sync updated domains; build missing planner statisticsProject structure
| Directory | Purpose |
|:----------|:--------|
| src/index.ts | createApp() entry point — registers the seven tools (faostat_dataframe_drop behind its opt-in flag), wires the mirror and canvas in setup(), schedules the HTTP refresh. |
| src/config | Server-specific environment variable parsing and validation with Zod. |
| src/mcp-server/tools/definitions | Tool definitions (*.tool.ts). |
| src/services/faostat-mirror | The bulk-download mirror service — manifest discovery, streaming ZIP ingester, CSV parsing, dimension store, SQLite-backed MirrorService wiring, and the two-worker read pool (read-pool.ts, read-worker.ts) that runs cube reads and statistics builds off the main thread. |
| src/services/canvas-accessor.ts, canvas-staging.ts | DataCanvas accessor and the spill/query/describe/drop staging layer. |
| scripts/faostat-mirror-*.ts | mirror:init / mirror:refresh / mirror:verify CLIs. |
| tests/ | Unit and integration tests mirroring src/. |
Development guide
See CLAUDE.md/AGENTS.md for development guidelines and architectural rules. The short version:
- Handlers throw, framework catches — no
try/catchin tool logic - Use
ctx.logfor request-scoped logging,ctx.statefor tenant-scoped storage - Register new tools in the
createApp()array insrc/index.ts - Wrap external data: validate raw → normalize to domain type → return output schema; never fabricate missing fields, and carry the data-quality flag through
Data attribution
Data is sourced from FAOSTAT, the statistics division of the Food and Agriculture Organization of the United Nations (FAO). FAOSTAT data is published under CC BY-4.0; cite FAO as the source in downstream use. This project is not affiliated with or endorsed by the FAO.
Contributing
Issues are welcome. Run checks and tests before submitting:
bun run devcheck
bun run testLicense
Apache-2.0 — see LICENSE for details.
