@cyanheads/federal-reserve-mcp-server
Search and fetch ~800K Federal Reserve economic time-series from the FRED API via MCP. STDIO or Streamable HTTP.
8 Tools
Overview
Federal Reserve economic data from the FRED API (Federal Reserve Bank of St. Louis) — ~800K time series covering output, prices, employment, money, rates, housing, trade, and international macro. Search series, fetch metadata and observations, browse the category tree, look up releases, and query large result sets with SQL over DataCanvas. Runs as a stdio process or a local Streamable HTTP server.
| Tool | Description |
|---|
fedreserve_search_series | Full-text search across FRED series titles, tags, and notes |
fedreserve_get_series | Fetch metadata for one or more series — title, units, frequency, observation range |
fedreserve_get_observations | Fetch date+value observations for one or more series, with date-range and unit-transform filtering |
fedreserve_browse_categories | Navigate the FRED category tree |
fedreserve_get_release | Look up a FRED release by ID or name search, with its associated series |
fedreserve_dataframe_describe | List active DataCanvas dataframes with provenance, schema, and row count |
fedreserve_dataframe_query | Run a SELECT against registered DataCanvas dataframes via DuckDB SQL |
fedreserve_dataframe_drop | Drop a DataCanvas dataframe by name (opt-in) |
Capability reference
- Full-text or series-ID search, with
frequency, units, seasonal_adjustment, and tag_names filters
- Pagination via
limit (default and max 1000) and offset (max 4999; FRED caps searchable results at 5000)
- Output includes
active_filters when applied and popularity (0–100) when FRED provides it; empty results suggest a broader query or category browsing
- Accepts a single series ID or up to 50 in one call; fires parallel upstream requests (no FRED batch endpoint exists)
- Returns title, units, frequency, seasonal adjustment, observation range, popularity, and notes per series
- Partial-batch failures land in a
failed array with per-ID error messages; a single unresolved ID throws series_not_found instead
- Accepts one series ID or up to 10, with
observation_start / observation_end, native unit transforms, and frequency downsampling via aggregation_method (avg, sum, eop)
- Returns date/value observations with string values that preserve trailing zeros, plus per-series failures
- Multi-series or >500-row results spill to DataCanvas, returning
dataset.name for fedreserve_dataframe_query; without canvas, returns a truncated inline preview
- Omit
category_id to start at the root (ID 0); returns the category, its child categories, and — for a leaf with no children — a sample of up to 10 series
- An unknown
category_id throws category_not_found
- Exactly one of
release_id (integer) or release_search (case-insensitive substring, filtered client-side — FRED has no server-side release search) is required
- Returns release name, link, notes, upcoming scheduled dates, and a paginated series list (
series_limit max 1000, series_offset)
- An ambiguous name search returns up to 10
search_alternatives instead of guessing; retry with the exact release_id
- Lists active DataCanvas dataframes for the tenant, or one by
name, newest first
- Each entry carries
source_tool, query_params, created_at, expires_at, row_count, truncated / max_rows, and column_schema
- Runs a single read-only DuckDB SELECT against
df_<id> tables, including joins, aggregates, window functions, and CTEs; external files and system catalogs are blocked
row_limit caps returned rows (default 1000, max 10000); preview sets the inline sample. BIGINT results serialize as strings
- Optional
register_as persists the result as a new dataframe with its own TTL for further queries
- Opt-in — enabled when
FRED_DATAFRAME_DROP_ENABLED=true; otherwise registered as a disabled tool card (visibility depends on the client's protocol version)
- Drops the named dataframe early; returns
dropped: false when absent. TTL also reclaims expired tables
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.
FRED-specific:
- Dataframe tools require
CANVAS_PROVIDER_TYPE=duckdb and report canvas_unavailable otherwise
FRED_API_KEY-gated access to the St. Louis Fed's FRED API (api.stlouisfed.org/fred) at up to 120 requests/minute
- Parallel multi-series fetching via
Promise.allSettled, with partial success reported per ID rather than failing the whole batch
- DataCanvas spillover for multi-series or >500-row observation results, queryable via
fedreserve_dataframe_query
- FRED's native unit transformations and frequency downsampling delegated server-side for precision against the full series history
- Category tree navigation across all FRED domains — Money & Banking, National Accounts, Employment, Prices, Housing, Trade, and more
Agent-friendly output:
- Graceful partial failure —
fedreserve_get_series and fedreserve_get_observations return per-ID failed rows with error messages instead of failing the whole request
- Ambiguous-input disambiguation —
fedreserve_get_release's name search returns typed search_alternatives instead of guessing when multiple releases match
- Provenance on DataCanvas output — every dataframe carries
source_tool, query_params, and TTL fields so agents can reason about where staged data came from and how long it's valid
- Degrades gracefully —
fedreserve_get_observations falls back to a truncated inline preview with an explanatory message when DataCanvas isn't configured, rather than failing
Getting started
Add the following to your MCP client configuration file. Obtain a free FRED API key at research.stlouisfed.org/docs/api/api_key.html.
{
"mcpServers": {
"federal-reserve-mcp-server": {
"type": "stdio",
"command": "bunx",
"args": ["@cyanheads/federal-reserve-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info",
"FRED_API_KEY": "your-api-key"
}
}
}
}
Or with npx (no Bun required):
{
"mcpServers": {
"federal-reserve-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@cyanheads/federal-reserve-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info",
"FRED_API_KEY": "your-api-key"
}
}
}
}
Or with Docker:
{
"mcpServers": {
"federal-reserve-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "MCP_TRANSPORT_TYPE=stdio",
"-e", "FRED_API_KEY=your-api-key",
"ghcr.io/cyanheads/federal-reserve-mcp-server:latest"
]
}
}
}
For Streamable HTTP, set the transport and start the server:
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 FRED_API_KEY=... bun run start:http
Prerequisites
Installation
- Clone the repository:
git clone https://github.com/cyanheads/federal-reserve-mcp-server.git
- Navigate into the directory:
cd federal-reserve-mcp-server
- Install dependencies:
- Configure environment:
Configuration
All configuration is validated at startup via Zod schemas in src/config/server-config.ts.
| Variable | Description | Default |
|---|
FRED_API_KEY | Required. API key from stlouisfed.org. | — |
FRED_BASE_URL | Override the FRED API base URL. | https://api.stlouisfed.org/fred |
FRED_DATASET_TTL_SECONDS | Sliding TTL for DataCanvas-registered observation tables (seconds). | 86400 |
FRED_DATAFRAME_DROP_ENABLED | Set true to enable fedreserve_dataframe_drop; otherwise registered as disabled. | false |
CANVAS_PROVIDER_TYPE | Set to duckdb to enable DataCanvas SQL querying for observation results. | — |
MCP_TRANSPORT_TYPE | Transport: stdio or http. | stdio |
MCP_HTTP_PORT | Port for HTTP server. | 3010 |
MCP_SESSION_MODE | HTTP session posture: auto, stateful, or stateless. Declared as stateless in src/index.ts — no tool holds per-session state. | stateless |
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 |
STORAGE_PROVIDER_TYPE | Storage backend. | in-memory |
OTEL_ENABLED | Enable OpenTelemetry instrumentation. | false |
OTEL_EXPORTER_OTLP_ENDPOINT | Base OTLP URL for traces (/v1/traces) and metrics (/v1/metrics). | — |
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT | Opt-in OTLP log endpoint, used as-is; the base endpoint does not enable logs. | — |
LOG_TOOL_FAILURE_PAYLOADS | Log failed tool arguments and results with key-name redaction; secrets in free-form values are not redacted. | false |
LOG_TOOL_FAILURE_PAYLOAD_MAX_BYTES | Per-payload UTF-8 byte cap for failed-call logging. | 16384 |
See .env.example for the full list of optional overrides.
Set CANVAS_PROVIDER_TYPE=duckdb to enable SQL over observation tables. npm installs and Docker images include the DuckDB runtime. Portable Claude Desktop bundles omit native bindings; use the npm or Docker installation for canvas mode.
Running the server
Local development
-
Build and run:
bun run rebuild
bun run start:stdio
bun run start:http
-
Run checks and tests:
bun run devcheck
bun run test
bun run lint:mcp
Docker
docker build -t federal-reserve-mcp-server .
docker run --rm -e FRED_API_KEY=your-key -e MCP_TRANSPORT_TYPE=http -p 3010:3010 federal-reserve-mcp-server
The Dockerfile defaults to HTTP transport, stateless session mode, and logs to /var/log/federal-reserve-mcp-server. OpenTelemetry peer dependencies are installed by default — build with --build-arg OTEL_ENABLED=false to omit them.
Project structure
| Directory | Purpose |
|---|
src/index.ts | createApp() entry point — registers tools and inits services. |
src/config | Server-specific environment variable parsing and validation with Zod. |
src/mcp-server/tools | Tool definitions (*.tool.ts). Eight tools across FRED domain and DataCanvas. |
src/services/fred | FRED API service — HTTP client, retry, 429 handling, key injection. |
src/services/canvas-bridge | DataCanvas adapter — table naming, TTL/provenance tracking, SQL gate extras. |
tests/ | Unit and integration tests mirroring src/. |
docs/ | Design and planning documents. |
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 in
src/mcp-server/tools/definitions/index.ts
- Wrap FRED API calls: validate raw response → 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.