@cyanheads/census-mcp-server

中文文档
0.7.2发布于 2026/11/04Apache-2.0TypeScriptES Module近 30 天下载 2233

Query U.S. Census Bureau data, variables, and geography via MCP. STDIO or Streamable HTTP.

原始使用文档
文档目录21 节
  1. Overview
  2. Tools
  3. Capability reference
  4. census_list_datasets tool
  5. census_list_geographies tool
  6. census_search_variables tool
  7. census_get_variable tool
  8. census_list_predicate_values tool
  9. census_resolve_geography tool
  10. census_query_data tool
  11. census_compare_geographies tool
  12. Features
  13. Getting started
  14. Configuration
  15. Running the server
  16. Local development
  17. Docker
  18. Project structure
  19. Development guide
  20. Contributing
  21. License

@cyanheads/census-mcp-server

Query U.S. Census Bureau data, variables, and geography via MCP. STDIO or Streamable HTTP.

8 Tools

Version License Docker MCP SDK npm TypeScript Bun

Install in Claude Desktop Install in Cursor Install in VS Code

Framework

Public Hosted Server: https://census.caseyjhand.com/mcp


Overview

US Census Bureau demographic, economic, and housing data. Find datasets and variables, resolve place names or addresses to FIPS codes, and query or rank estimates across any set of geographies.

Tools

ToolDescription
census_list_datasetsBrowse available Census Bureau datasets (ACS5 and ACS1 with their profile, subject, and comparison tables, ACS Supplemental Estimates and Selected Population Profiles, Population Estimates, Decennial, County Business Patterns, Economic Census, Nonemployer Statistics) with vintage years and dataset codes.
census_list_geographiesList the geography levels supported by a dataset and year, with parent requirements and example FIPS values.
census_search_variablesKeyword search across variable labels and concept groups, or lookup by variable or table code. On ACS, returns estimate and margin-of-error codes together.
census_get_variableFetch full metadata for one or more variable codes — label, concept, predicate type, universe, MOE sibling — including the annotation and flag columns the data tools accept.
census_list_predicate_valuesList the codes a filter dimension accepts (EMPSZES, LFO, POPGROUP, NAICS2017…), from the dataset dictionary or a live wildcard enumeration.
census_resolve_geographyConvert place names (e.g., "King County, WA"), ZIP codes, or street addresses to Census FIPS identifiers via TIGERweb and Census Geocoder.
census_query_dataQuery a Census dataset for variables at one geography, a comma-separated list of them, or every geography at a level. Returns estimates with MOE, Census sentinel values and withheld business values resolved to their published meanings, and predicate filtering for the business datasets.
census_compare_geographiesRank and compare variables across multiple geographies — all counties in a state, all states nationally, or a named set. Sorted table output, with the same predicate filtering.

Capability reference

census_list_datasets tool

  • Returns dataset codes, names, descriptions, and available vintage years, with an optional keyword filter. Covers ACS5 and ACS1 (data profiles, subject tables, comparison profiles, and acs/acs1/spp), acs/acsse, Population Estimates, the 2020 Decennial files (Redistricting (P.L. 94-171), dec/dhc, dec/dp, dec/sdhc, dec/ddhca, dec/ddhcb), cbp, ecnbasic, and nonemp
  • Each description names the filter predicates the dataset requires and the geography levels it publishes
  • Dataset codes (e.g., acs/acs5) are what the other tools take. Case is ignored and a two-part code works by its last part alone (acs5, pl); three-part codes such as acs/acs5/profile must be given in full
  • available_years is exhaustive: any other year fails with year_not_available, naming the years that work

census_list_geographies tool

  • Returns one row per geography level and parent hierarchy: geography_level, whether a parent is required, required_parent_levels, and an example FIPS value. totalLevels counts each level once
  • geography_level values are the exact inputs to census_query_data and census_compare_geographies; year defaults to the latest vintage
  • Fails with dataset_not_found or year_not_available (naming the years served)

census_search_variables tool

  • Whole-word search across label and concept: every query word must match, otherwise the closest matches come back with a notice. A variable or table code in any case returns that variable, or the whole table in code order, first (B19013 returns B19013_001E then B19013_001M)
  • A code the dataset does not publish gets a notice naming the sibling dataset that holds it (S1701 in acs/acs5 points to acs/acs5/subject) or census_get_variable for an attribute column such as B19013_001EA
  • On ACS datasets, estimate (E suffix) and margin-of-error (M suffix) codes come back together; comparison profiles and the other families publish no margins of error. Also finds predicate codes by keyword (naics) or code (NAICS2017 in cbp)
  • limit is an integer from 1 to 100 (default 20), rejected rather than clamped when out of range. offset pages the complete match ordering; totalMatches counts matches before paging, truncated means another page exists, and nextOffset names it. variables.json is cached per dataset+year (default TTL 24h)

census_get_variable tool

  • Takes one or more variable codes (case-insensitive) and returns label, concept, predicate type, and the table's universe, in the order given. If groups.json can't be fetched, variables come back without universe and a notice says to retry
  • Resolves annotation and flag columns such as B19013_001EA and EMP_F, with attribute_of naming the column each belongs to and attribute_type its kind (ANNOTATION, FLAG, MARGIN_OF_ERROR). On ACS datasets it also returns estimate_code/moe_code sibling references
  • Confirms predicate dimension codes (NAICS2017, SEX) exist in a dataset; census_list_predicate_values lists their values. dataset defaults to acs/acs5 and year to the latest vintage
  • variable_not_found when a code isn't defined, naming the sibling dataset that publishes it when one is found (DP03_0062E in acs/acs5 points to acs/acs5/profile)

census_list_predicate_values tool

  • Lists the codes a filter dimension accepts, read from the dataset dictionary when it publishes a list and enumerated live otherwise. NAICS* and POPGROUP have long lists (thousands of codes; narrow with query); EMPSZES, LFO, RCPSZES, TAXSTAT, and TYPOP are live-only
  • Dictionary lists are checked against the rows the dataset actually publishes and unpublished codes are dropped; source says whether the check ran and the notice gives the number withheld. A dictionary list does not validate publication at a supplied geography level
  • Live enumeration takes geography_level (default us) and echoes that scope. Codes vary by level; only levels whose dataset metadata permits an unparented wildcard are accepted
  • query matches code and label; results are sorted by code before offset/limit paging (limit 1 to 500, default 50). totalCount counts all matches; truncated means another page exists, with nextOffset only then. On ecnbasic, within_naics scopes TAXSTAT and TYPOP to one industry
  • The live route and the dictionary check read the data endpoint, so they need CENSUS_API_KEY: without a working key a live-only dimension fails with missing_api_key, while a dictionary list still answers, unchecked, with a notice naming the key

census_resolve_geography tool

  • Named places (e.g., "King County, WA") resolve via TIGERweb; street addresses resolve to tract level via Census Geocoder, with block_group_fips and place_fips. A 5-digit ZIP (or ZIP+4) resolves to its ZIP Code Tabulation Area (zip code tabulation area)
  • Auto-detects geography_type for state, county, place, tract, and ZIP. Metropolitan/micropolitan statistical areas, combined statistical areas, consolidated cities, and economic places need an explicit geography_type; economic place returns the 8-digit ecnbasic code (Seattle 03363000)
  • The place level includes census-designated places, which answer a name only when no incorporated place or county matches exactly; use the full name ("Arlington CDP, VA") or geography_type: "place" to reach one. Optional county_fips scopes county and tract resolution (county_scope_unsupported for any other level or an address)
  • Matching ignores case, accepts a state abbreviation or full name, and tolerates Saint/St. and accent differences. New York City boroughs resolve to their counties ("Brooklyn, NY" → Kings County 047) with a notice
  • A name matching several geographies returns ambiguous_name with every candidate's FIPS code and state. Results carry state_fips (→ parent_fips) and fips_summary (→ geography_fips) for the next tool; statistical areas and ZCTAs omit state_fips

census_query_data tool

  • Requires FIPS codes (use census_resolve_geography for place names). geography_fips: "*" returns every geography at the level within the parent; each row carries geography_fips and the nationally unique geography_geoid. Wildcards return up to limit rows (default 50, max 500) in GEOID order, with offset for paging and totalCount for all matches. truncated is true only when another page exists; nextOffset names that page
  • A comma-separated list ("06,53", or "033,061" with parent_fips: "53") returns one row per listed code at the same level, in GEOID order and paged the same way; codes take the level's width, no "*" member, and the parents a single code needs. The notice names each listed code no row came back for
  • Up to 49 variable codes per call, fewer on datasets that add label or record columns (too_many_variables states the maximum). Unknown codes fail with variable_not_found; level and parent problems fail with parent_required or parent_not_accepted. Optional tract_fips (6 digits, with a concrete county_fips) scopes a block-group or decennial block query to one tract
  • Optional predicates map filters the business, pep, and dec datasets and acs/acs1/spp (e.g., {"NAICS2017": "5112"}). Unset dimensions take a Census default, echoed per row in applied_filters; "*" returns one row per category, labelled in record. pep/charv returns several rows per geography, so pin one (e.g., {"MONTH": "7"})
  • ACS sentinel values resolve to their published meanings, and a median in an open-ended interval is flagged open_ended. On cbp, ecnbasic, and nonemp, withheld values are reported as suppressed with the flag's meaning. A null estimate means suppressed, a text cell (returned under value), or empty
  • On dec/ddhca and dec/ddhcb, a geography's POPGROUP group sits in only one table of a family; a no_data hint or notice names the sibling tables. Requires CENSUS_API_KEY
  • Missing-geography guidance names applicable ACS publication thresholds as possible causes alongside code checks, and pairs broader-coverage datasets with variable rediscovery

census_compare_geographies tool

  • Ranks all geographies at a level, or a named geographies list of GEOIDs/bare level codes; within/within_county scope to a state/county, omit for a national comparison
  • Ranks on one variable: sort_by (default the first code; must be a requested code, else sort_by_not_requested), sort_dir (default desc), and limit (1 to 500, default 50). Equal numeric values share competition ranks (1, 2, 2, 4) and are ordered by GEOID; a notice identifies a page boundary inside a tie. A count ranks by size, not rate, so rank a published percentage for a rate (S1701_C03_001E in acs/acs5/subject, DP04_0047PE in acs/acs5/profile)
  • offset counts rows in the sorted matched set; ranks are assigned before paging. totalCount counts that set, truncated means another page exists, and nextOffset appears only then. A nonempty geographies filter also returns scope_rank against all fetched geographies and scopeCount for that denominator
  • Takes the same predicates, variable limit, validation, and applied_filters as census_query_data; multi-record datasets (pep/charv) or a "*" predicate fail with ambiguous_rows unless predicates pins one. Suppressed values sort last with the same reasons, and text values can't be ranked (the notice says so). Requires CENSUS_API_KEY

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.

Census-specific:

  • In-process variable cache with configurable TTL — variables.json fetched once per dataset+year, searched client-side
  • Three-API backend: Census Data API for data queries, TIGERweb for named-place resolution, Census Geocoder for address-to-tract
  • Automatic retry with backoff on all external API calls
  • Keyed tool calls share a 50-second upstream budget across metadata, data, retries, and optional probes; data requests retain a 40-second ceiling within the remaining budget
  • FIPS formatting helpers — zero-padded state, county, and tract codes ready to pass between tools

Agent-friendly output:

  • Workflow-oriented tool surface — fips_summary and state_fips return values are ready to pass as geography_fips and parent_fips to the next tool
  • Suppression codes decoded — Census negative sentinel values (e.g., -666666666) and business-dataset withholding flags (e.g., D) surfaced as their published meanings instead of raw numbers or false zeros
  • Recovery hints on errors — ambiguous geography names include candidate lists; missing API key errors include registration URL

Getting started

Connect to the hosted instance, no install:

claude mcp add --transport http census-mcp-server https://census.caseyjhand.com/mcp

Or run it locally:

claude mcp add census-mcp-server -e CENSUS_API_KEY=your-key -- npx -y @cyanheads/census-mcp-server

For other clients, add this to the MCP config file:

{
  "mcpServers": {
    "census-mcp-server": {
      "command": "npx",
      "args": ["-y", "@cyanheads/census-mcp-server"],
      "env": { "CENSUS_API_KEY": "your-key" }
    }
  }
}

Register a free key at api.census.gov/data/key_signup.html. Data queries (census_query_data, census_compare_geographies) require it, as does census_list_predicate_values for a dimension it enumerates live; variable search and geography resolution work without one. For Docker or a source build, see Running the server.


Configuration

VariableDescriptionDefault
CENSUS_API_KEYRequired for data queries (census_query_data, census_compare_geographies) and for census_list_predicate_values on a live-enumerated dimension; without it those fail with missing_api_key, and a dictionary list comes back unchecked. Register free at api.census.gov/data/key_signup.html.—
CENSUS_DEFAULT_YEARDefault vintage year when no year is specified.2024
CENSUS_VARIABLE_CACHE_TTL_HOURSHours to cache variables.json per dataset+year in memory.24
MCP_TRANSPORT_TYPETransport: stdio or http.stdio
MCP_SESSION_MODEHTTP session mode: stateful, stateless, or auto.stateless
MCP_HTTP_PORTPort for HTTP server.3010
MCP_AUTH_MODEAuth mode: none, jwt, or oauth.none
MCP_LOG_LEVELLog level (debug, info, notice, warning, error).info
LOG_TOOL_FAILURE_PAYLOADSLog each failed tool call's arguments and result, redacted by key name and capped at LOG_TOOL_FAILURE_PAYLOAD_MAX_BYTES (default 16384). A secret inside a free-form value is not redacted.false
OTEL_ENABLEDEnable OpenTelemetry instrumentation.false

See .env.example for the full list of optional overrides.


Running the server

Local development

Requires Bun v1.4.0 or higher (or Node.js v24+).

  • Clone and install:

    git clone https://github.com/cyanheads/census-mcp-server.git
    cd census-mcp-server && bun install
    cp .env.example .env   # set CENSUS_API_KEY
    
  • Build and run:

    # One-time build
    bun run rebuild
    
    # Run the built server
    bun run start:stdio
    # or
    bun run start:http
    
  • Run checks and tests:

    bun run devcheck   # Lint, format, typecheck, security audit
    bun run test       # Vitest test suite
    bun run lint:mcp   # Validate MCP definitions against spec
    

Docker

docker run --rm -e CENSUS_API_KEY=your-key -p 3010:3010 ghcr.io/cyanheads/census-mcp-server:latest

The image defaults to HTTP transport, stateless session mode, and logs to /var/log/census-mcp-server. To run it over stdio from an MCP client, use "command": "docker" with "args": ["run", "-i", "--rm", "-e", "MCP_TRANSPORT_TYPE=stdio", "-e", "CENSUS_API_KEY=your-key", "ghcr.io/cyanheads/census-mcp-server:latest"]. To build locally, docker build -t census-mcp-server .; OpenTelemetry peer dependencies are installed by default — build with --build-arg OTEL_ENABLED=false to omit them.


Project structure

PathPurpose
src/index.tscreateApp() entry point — registers tools and initializes services.
src/config/server-config.tsCensus-specific env var parsing and validation with Zod.
src/mcp-server/tools/definitions/Tool definitions (*.tool.ts).
src/services/census-api/Census Data API client — data queries, suppression code mapping, retry logic.
src/services/geography/Geography resolution — TIGERweb named-place lookup and Census Geocoder address-to-tract.
src/services/variable-cache/In-process variables.json cache with TTL and keyword search.
tests/Vitest tests mirroring src/ structure.

Development guide

See CLAUDE.md for development guidelines and architectural rules. The short version:

  • Handlers throw, framework catches — no try/catch in tool logic
  • Use ctx.log for request-scoped logging, ctx.state for tenant-scoped storage
  • Register new tools via the barrel in src/mcp-server/tools/definitions/index.ts
  • Wrap external API calls: validate raw → normalize to domain type → return output schema; never fabricate missing fields

Contributing

Issues are welcome. Run checks and tests before submitting:

bun run devcheck
bun run test

License

Apache-2.0 — see LICENSE for details.

版本与发布记录

@cyanheads/census-mcp-server 共发布 27 个版本,首次发布于 2026/05/25;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.7.2latest2026/11/047 天前
0.7.12026/10/2913 天前
0.7.02026/10/2813 天前
0.6.32026/10/2517 天前
0.6.22026/10/1428 天前
0.6.12026/10/081 个月前

关于 @cyanheads/census-mcp-server 的常见问题

@cyanheads/census-mcp-server 是什么?

Query U.S. Census Bureau data, variables, and geography via MCP. STDIO or Streamable HTTP.

如何安装 @cyanheads/census-mcp-server?

在项目目录运行 npm install @cyanheads/census-mcp-server,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 census-mcp-server,可以用 npx census-mcp-server 直接运行。

@cyanheads/census-mcp-server 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cyanheads/census-mcp-server 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cyanheads/census-mcp-server 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cyanheads/census-mcp-server 可以商用吗?

@cyanheads/census-mcp-server 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@cyanheads/census-mcp-server 的下载量有多少?

根据 npm 官方下载统计,@cyanheads/census-mcp-server 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,233 次,日均约 74 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cyanheads/census-mcp-server 还在维护吗?

最新版本 0.7.2 发布于 2026/11/04(7 天前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/05/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。