使用说明
Stat-Xplore MCP
MCP server for querying DWP Stat-Xplore benefit statistics.
Setup
You need a Stat-Xplore API key. Get one from Stat-Xplore under Account > Open Data API Access.
Provide it in one of two ways.
Option 1: save it once (recommended)
Run this in a terminal — it prompts for your key and saves it to ~/.config/stat-xplore-mcp/config.json (owner-readable only):
uvx --from git+https://github.com/PolicyEngine/stat-xplore-mcp stat-xplore-mcp configure
Then add the server:
claude mcp add stat-xplore -- uvx --from git+https://github.com/PolicyEngine/stat-xplore-mcp stat-xplore-mcp
Option 2: environment variable
Pass the key via STAT_XPLORE_API_KEY when registering the server:
claude mcp add stat-xplore --env STAT_XPLORE_API_KEY=your_key_here -- uvx --from git+https://github.com/PolicyEngine/stat-xplore-mcp stat-xplore-mcp
If no key is configured, the tools return setup instructions rather than a raw HTTP error.
Tools
list_databases- list all 118 benefit datasets (UC, PIP, ESA, etc.)get_database_schema- get fields and measures for a databasequery_table- query statistics data with full support for dimensions, recodes, and statistical functionsbrowse_schema- navigate the schema hierarchyget_rate_limit- check API rate limit status
Query Examples
Basic count query
{
"database": "str:database:HBAI",
"measures": ["str:count:HBAI:V_F_HBAI"],
"dimensions": [["str:field:HBAI:V_F_HBAI:YEAR"]]
}
Median income query
For median/mean calculations, use statistical function measures with the pattern:
str:statfn:{database}:{view}:{measure}:{MEDIAN|MEAN}
{
"database": "str:database:HBAI",
"measures": [
"str:statfn:HBAI:V_F_HBAI:S_OE_BHC:MEDIAN",
"str:statfn:HBAI:V_F_HBAI:S_OE_AHC:MEDIAN"
],
"dimensions": [
["str:field:HBAI:V_F_HBAI:YEAR"],
["str:field:HBAI:V_F_HBAI:KIDECOBU_WORK"]
],
"recodes": {
"str:field:HBAI:V_F_HBAI:YEAR": {
"map": [
["str:value:HBAI:V_F_HBAI:YEAR:C_HBAI_YEAR:2223"],
["str:value:HBAI:V_F_HBAI:YEAR:C_HBAI_YEAR:2324"]
]
},
"str:field:HBAI:V_F_HBAI:KIDECOBU_WORK": {
"map": [
["str:value:HBAI:V_F_HBAI:KIDECOBU_WORK:C_HBAI_KIDECOBU_WORK:1"]
]
}
}
}
Recodes structure
Recodes filter and group values:
map: List of value groups. Each inner array becomes one row/column. Multiple values in same array are combined.total: Set totrueto include a total row/column.
{
"str:field:HBAI:V_F_HBAI:NEWFAMBU": {
"map": [
["str:value:...:1"],
["str:value:...:2", "str:value:...:3"]
],
"total": true
}
}
License
Code in this repository is released under the MIT License. Original text and figures are released under CC BY 4.0 with attribution to PolicyEngine. Third-party data and materials keep their own terms.
