io.github.cyanheads/finnhub-mcp-server
Real-time US-equity quotes, company fundamentals, earnings, analyst trends, and news via Finnhub.
ماذا يمكنك أن تفعل مع io.github.cyanheads/finnhub-mcp-server؟
- Single rate-aware Finnhub client — token injected server-side (never a tool input), with timeout and retry calibrated to the 60 req/min free tier
- Live market-status pairing on quotes so a closed-market price is reported as the prior close, never as live
- Status classification at the service boundary: 403 → a clear
not_us_or_paiddomain error, 401 → loud configuration failure at first call (not "no data"), 429/5xx → retried finnhub_get_companyfans out profile + metrics + peers in parallel and degrades to partial results when a leg fails- Honest sparsity — every fundamental is nullable and absent values stay null; Finnhub's thinly-covered names are surfaced as-is, never zero-filled or fabricated
- Two distinct "not available" signals —
symbol_not_found(unknown US ticker, detected from the all-zero quote / empty profile sentinel) vs.not_us_or_paid(international or paid-only, HTTP 403) — so an agent can tell them apart and recover - Typed error contracts with recovery hints on every failure, plus the
isLikelyUSsearch heuristic so an agent can prioritize likely free-tier symbols - Capped lists report their total count and disclose truncation, so an agent knows when more data exists
التثبيت
أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: .cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).
@cyanheads/finnhub-mcp-serverclaude mcp add finnhub-mcp-server -e 'FINNHUB_API_KEY=<FINNHUB_API_KEY>' -e 'FINNHUB_BASE_URL=https://finnhub.io/api/v1' -e 'MCP_LOG_LEVEL=info' -- npx -y @cyanheads/finnhub-mcp-server@0.2.0
{
"mcpServers": {
"finnhub-mcp-server": {
"command": "npx",
"args": [
"-y",
"@cyanheads/finnhub-mcp-server@0.2.0"
],
"env": {
"FINNHUB_API_KEY": "<FINNHUB_API_KEY>",
"FINNHUB_BASE_URL": "https://finnhub.io/api/v1",
"MCP_LOG_LEVEL": "info"
}
}
}
}
متغيرات البيئة
FINNHUB_API_KEYإلزامي Required. Free Finnhub API key from https://finnhub.io/register (Dashboard → API key). Free tier: 60 req/min, US real-time.FINNHUB_BASE_URLOverride the Finnhub REST API base URL (local testing / proxy).MCP_LOG_LEVELSets the minimum log level for output (e.g., 'debug', 'info', 'warn').
@cyanheads/finnhub-mcp-serverclaude mcp add finnhub-mcp-server -e 'MCP_TRANSPORT_TYPE=<MCP_TRANSPORT_TYPE>' -e 'FINNHUB_API_KEY=<FINNHUB_API_KEY>' -e 'FINNHUB_BASE_URL=https://finnhub.io/api/v1' -e 'MCP_HTTP_HOST=127.0.0.1' -e 'MCP_HTTP_PORT=3010' -e 'MCP_HTTP_ENDPOINT_PATH=/mcp' -e 'MCP_AUTH_MODE=none' -e 'MCP_LOG_LEVEL=info' -- npx -y @cyanheads/finnhub-mcp-server@0.2.0
{
"mcpServers": {
"finnhub-mcp-server": {
"command": "npx",
"args": [
"-y",
"@cyanheads/finnhub-mcp-server@0.2.0"
],
"env": {
"MCP_TRANSPORT_TYPE": "<MCP_TRANSPORT_TYPE>",
"FINNHUB_API_KEY": "<FINNHUB_API_KEY>",
"FINNHUB_BASE_URL": "https://finnhub.io/api/v1",
"MCP_HTTP_HOST": "127.0.0.1",
"MCP_HTTP_PORT": "3010",
"MCP_HTTP_ENDPOINT_PATH": "/mcp",
"MCP_AUTH_MODE": "none",
"MCP_LOG_LEVEL": "info"
}
}
}
}
متغيرات البيئة
MCP_TRANSPORT_TYPESelects the HTTP transport.FINNHUB_API_KEYإلزامي Required. Free Finnhub API key from https://finnhub.io/register (Dashboard → API key). Free tier: 60 req/min, US real-time.FINNHUB_BASE_URLOverride the Finnhub REST API base URL (local testing / proxy).MCP_HTTP_HOSTThe hostname for the HTTP server.MCP_HTTP_PORTThe port to run the HTTP server on.MCP_HTTP_ENDPOINT_PATHThe endpoint path for the MCP server.MCP_AUTH_MODEAuthentication mode to use: 'none', 'jwt', or 'oauth'.MCP_LOG_LEVELSets the minimum log level for output (e.g., 'debug', 'info', 'warn').
التوثيق
مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.
المحتويات
@cyanheads/finnhub-mcp-server
Real-time US-equity quotes, company fundamentals, earnings, analyst trends, and financial news via Finnhub. STDIO or Streamable HTTP.
6 Tools • 1 Resource
Overview
Real-time US-equity data from Finnhub — quotes, company fundamentals, earnings, analyst recommendations, and financial news. Resolve a company name to a symbol with finnhub_search_symbols, then pull live pricing, valuation, or news for it from any MCP client. Runs as a stdio process or a local Streamable HTTP server.
Tools
| Tool | Description |
|---|---|
finnhub_search_symbols | Resolve a company name or partial ticker to stock symbols, best likely-US match first. The entry point for every other tool. |
finnhub_get_quote | Real-time price quote for one US symbol, paired with live market-status so the response states whether the price is live or the prior close, including the returned session and named holiday. |
finnhub_get_company | Full company context in one call — profile, headline fundamentals (P/E, EPS, margins, growth), and sector peers. |
finnhub_get_earnings | Earnings in two modes: a symbol's past quarters with actual-vs-estimate surprises (history), or upcoming releases in a date window with an optional symbol filter (calendar). |
finnhub_get_news | Financial news in two modes: recent articles for one symbol over a date range (company), or broad market headlines by category (market). |
finnhub_get_recommendations | Analyst recommendation trends for one US symbol — strong-buy / buy / hold / sell / strong-sell counts per month, newest first. |
Resources
| Resource | Description |
|---|---|
finnhub://news-categories | The four valid market-news categories (general, forex, crypto, merger) with one-line descriptions. |
Fully covered by the category enum on finnhub_get_news, so tool-only clients lose nothing.
Capability reference
finnhub_search_symbols tool
- Search by company name or ticker fragment with
query(1–20 characters) andlimit(1–50, default 10). - Returns likely-US Common Stock matches first, with an
isLikelyUSsymbol-format heuristic, total match count, and truncation disclosure. Quote and profile responses remain authoritative.
finnhub_get_quote tool
- Requires
symbol; returns current price, change, session open/high/low, previous close, and an ISO 8601 quote time. priceIsLivedistinguishes a live price from the prior close;marketOpen,session, andholidayare nullable when market status is unavailable. Unknown ticker →symbol_not_found; international or paid-only symbol →not_us_or_paid.
finnhub_get_company tool
- Requires
symbol; returns company profile, nullable headline fundamentals (P/E, EPS, 52-week range, beta, dividend yield, margins, growth, ROE), and sector peers. - Failed metrics or peers appear in
partial; the profile determinessymbol_not_foundandnot_us_or_paiderrors.
finnhub_get_earnings tool
historyrequiressymboland returns past quarters' actual/estimate EPS and surprise, newest first.calendaracceptsfrom/to(default today through +14 days) and an optionalsymbol, returning release dates, EPS/revenue estimates, and report times.limit(1–100, default 50) caps rows with total and truncation disclosure. History without a symbol →missing_symbol; international or paid-only symbol →not_us_or_paid.
finnhub_get_news tool
companyrequiressymboland accepts a date range (default last 7 days).marketusescategory:general,forex,crypto, ormerger(seefinnhub://news-categories).- Returns headline, source, ISO 8601 datetime, summary, and URL, newest first.
limit(1–100, default 15) caps articles with total and truncation disclosure; company mode without a symbol →missing_symbol, international or paid-only symbol →not_us_or_paid.
finnhub_get_recommendations tool
- Per-month strong-buy / buy / hold / sell / strong-sell counts, newest first (typically 12–24 months of history)
limit(1–24, default 12 — one year); reports total months and discloses truncation- Empty result (no analyst coverage) →
no_coverage, distinct from an invalid symbol; international or paid-only symbol →not_us_or_paid
finnhub://news-categories resource
- Returns the four valid
finnhub_get_newsmarket-mode categories (general,forex,crypto,merger) with one-line descriptions, asapplication/json - Convenience mirror — fully covered by the
categoryenum's.describe()onfinnhub_get_news, so tool-only clients lose nothing - Live data (quotes, news, earnings) is intentionally not exposed as a resource — it's time-sensitive, so freshness lives only in the tools
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.
Finnhub-specific:
- Single rate-aware Finnhub client — token injected server-side (never a tool input), with timeout and retry calibrated to the 60 req/min free tier
- Live market-status pairing on quotes so a closed-market price is reported as the prior close, never as live
- Status classification at the service boundary: 403 → a clear
not_us_or_paiddomain error, 401 → loud configuration failure at first call (not "no data"), 429/5xx → retried finnhub_get_companyfans out profile + metrics + peers in parallel and degrades to partial results when a leg fails
Agent-friendly output:
- Honest sparsity — every fundamental is nullable and absent values stay null; Finnhub's thinly-covered names are surfaced as-is, never zero-filled or fabricated
- Two distinct "not available" signals —
symbol_not_found(unknown US ticker, detected from the all-zero quote / empty profile sentinel) vs.not_us_or_paid(international or paid-only, HTTP 403) — so an agent can tell them apart and recover - Typed error contracts with recovery hints on every failure, plus the
isLikelyUSsearch heuristic so an agent can prioritize likely free-tier symbols - Capped lists report their total count and disclose truncation, so an agent knows when more data exists
Getting started
This server requires a free Finnhub API key (Dashboard → API key). The free tier covers US equities in real time at 60 req/min.
Each user must obtain their own API key. Use is subject to Finnhub's Terms of Service — the free tier is for personal use only, and redistributing or sharing access to Finnhub data with third parties requires written approval from Finnhub.
Add the following to your MCP client configuration file.
{
"mcpServers": {
"finnhub-mcp-server": {
"type": "stdio",
"command": "bunx",
"args": ["@cyanheads/finnhub-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info",
"FINNHUB_API_KEY": "your-api-key"
}
}
}
}
Or with npx (no Bun required):
{
"mcpServers": {
"finnhub-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@cyanheads/finnhub-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info",
"FINNHUB_API_KEY": "your-api-key"
}
}
}
}
Or with Docker:
{
"mcpServers": {
"finnhub-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "MCP_TRANSPORT_TYPE=stdio",
"-e", "FINNHUB_API_KEY=your-api-key",
"ghcr.io/cyanheads/finnhub-mcp-server:latest"
]
}
}
}
For Streamable HTTP, set the transport and start the server:
MCP_TRANSPORT_TYPE=http MCP_SESSION_MODE=stateless MCP_HTTP_PORT=3010 FINNHUB_API_KEY=... bun run start:http
# Server listens at http://localhost:3010/mcp
Prerequisites
- Bun v1.4.0 or higher (or Node.js v24+).
- A free Finnhub API key. The free tier is US equities only, real-time, 60 req/min — international symbols (any exchange-suffixed ticker like
.TOor.DE) and candle/forex endpoints are paid-tier and return a clear error.
Installation
- Clone the repository:
git clone https://github.com/cyanheads/finnhub-mcp-server.git
- Navigate into the directory:
cd finnhub-mcp-server
- Install dependencies:
bun install
- Configure environment:
cp .env.example .env
# edit .env and set FINNHUB_API_KEY
Configuration
All configuration is validated at startup via Zod schemas in src/config/server-config.ts. Key environment variables:
| Variable | Description | Default |
|---|---|---|
FINNHUB_API_KEY | Required. Free Finnhub API key from finnhub.io/register. Sent as the token query param; the server fails to start without it. | — |
FINNHUB_BASE_URL | Finnhub REST API base URL. Override for local testing or a proxy. | https://finnhub.io/api/v1 |
MCP_TRANSPORT_TYPE | Transport: stdio or http. | stdio |
MCP_HTTP_PORT | Port for the HTTP server. | 3010 |
MCP_HTTP_ENDPOINT_PATH | HTTP endpoint path where the MCP server is mounted. | /mcp |
MCP_SESSION_MODE | Session handling: auto, stateful, or stateless. The server declares stateless in src/index.ts, so an unset variable resolves there; .env.example and the Docker image set it explicitly too. An explicit environment value takes precedence. | stateless |
MCP_AUTH_MODE | Auth mode: none, jwt, or oauth. | none |
MCP_LOG_LEVEL | Log level (RFC 5424: debug, info, notice, warning, error). | info |
LOG_TOOL_FAILURE_PAYLOADS | Log failed tool calls' arguments and results, redacted by key name and capped at LOG_TOOL_FAILURE_PAYLOAD_MAX_BYTES (default 16384). Secrets inside free-form values are not redacted. | false |
STORAGE_PROVIDER_TYPE | Storage backend: in-memory, filesystem, supabase, cloudflare-kv/r2/d1. | in-memory |
OTEL_ENABLED | Enable OpenTelemetry instrumentation (spans, metrics, completion logs). | false |
OTEL_EXPORTER_OTLP_ENDPOINT | OTLP base URL for traces (/v1/traces) and metrics (/v1/metrics); signal-specific endpoints override it. | — |
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT | Opt-in OTLP log endpoint, used as-is. The base URL does not enable log export. | — |
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:http - Run checks and tests:
bun run devcheck # Lint, format, typecheck, security bun run test # Vitest test suite bun run lint:mcp # Validate MCP definitions against spec
Docker
docker build -t finnhub-mcp-server .
docker run --rm -e MCP_TRANSPORT_TYPE=http -e FINNHUB_API_KEY=your-key -p 3010:3010 finnhub-mcp-server
The Dockerfile defaults to HTTP transport, stateless session mode, and logs to /var/log/finnhub-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/resources and inits the Finnhub service. |
src/config | Server-specific environment variable parsing and validation with Zod. |
src/mcp-server/tools | Tool definitions (*.tool.ts). Six tools across symbols, quotes, company, earnings, news, and recommendations. |
src/mcp-server/resources | Resource definitions (*.resource.ts). News-categories reference. |
src/services/finnhub | Finnhub REST client — auth, typed endpoint methods, retry, and HTTP-status classification. |
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 and resources via the barrels in
src/mcp-server/*/definitions/index.ts - Wrap the Finnhub API: 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.
الأسئلة الشائعة
ما هو io.github.cyanheads/finnhub-mcp-server؟
Real-time US-equity quotes, company fundamentals, earnings, analyst trends, and news via Finnhub.
كيف أثبّت io.github.cyanheads/finnhub-mcp-server؟
يعمل على جهازك. في Claude Code: claude mcp add finnhub-mcp-server -e 'FINNHUB_API_KEY=<FINNHUB_API_KEY>' -e 'FINNHUB_BASE_URL=https://finnhub.io/api/v1' -e 'MCP_LOG_LEVEL=info' -- npx -y @cyanheads/finnhub-mcp-server@0.2.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.
هل يحتاج io.github.cyanheads/finnhub-mcp-server إلى مفتاح API؟
نعم. يتطلب FINNHUB_API_KEY، وتضبطها في إعداداته.
هل io.github.cyanheads/finnhub-mcp-server مفتوح المصدر؟
نعم. شيفرته متاحة على GitHub بترخيص Apache-2.0.
من يصون io.github.cyanheads/finnhub-mcp-server؟
ينشره cyanheads. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.
من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.