secedgar-mcp-server

SEC EDGAR फाइलिंग और वित्तीय जानकारी

दस्तावेज़

@cyanheads/secedgar-mcp-server

Query SEC EDGAR filings, XBRL financials, and company data via MCP. STDIO or Streamable HTTP.

16 Tools (+1 opt-in) • 2 Resources • 1 Prompt

npm License Docker MCP SDK TypeScript Bun

Install in Claude Desktop Install in Cursor Install in VS Code

Framework

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


Overview

SEC EDGAR filings, financials, and ownership data. Look up companies by ticker, name, or CIK, search filings back to 1993, compare financials across companies, and trace ownership through insider trades, 13F holdings, 13D/13G blockholders, and fund portfolios. No API key required.

Tools

ToolDescription
secedgar_company_searchFind companies and retrieve entity info with optional recent filings
secedgar_search_filingsSearch EDGAR filings since 1993: full text from 2001, archive browse before that
secedgar_get_filingFetch a filing's metadata and document text, paged, by section, or at a phrase
secedgar_get_financialsGet historical XBRL financial data for one company and concept
secedgar_get_snapshotOne-call financial profile: the latest value of every supported concept
secedgar_get_material_events8-K filings with item codes decoded and filterable
secedgar_get_insider_transactionsForm 4 / 4-A insider transactions parsed from ownership XML
secedgar_get_institutional_holdings13F-HR quarterly holdings of one institutional manager
secedgar_find_holdersReverse 13F lookup: which managers reported holding an issuer
secedgar_get_beneficial_owners5%+ blockholders of an issuer from structured SCHEDULE 13D / 13G filings
secedgar_get_fund_holdingsETF and mutual fund portfolio holdings from the quarterly NPORT-P report
secedgar_fetch_framesOne XBRL concept × one period across every reporting company
secedgar_compare_companiesCompare named companies across several concepts, aligned on fiscal years or calendar quarters
secedgar_search_conceptsDiscover supported XBRL concept names or reverse-lookup a raw tag
secedgar_dataframe_describeDescribe canvas dataframes by name with provenance, TTL, and schema; the nameless listing is refused over HTTP with auth none
secedgar_dataframe_queryRun a single-statement SELECT across dataframes
secedgar_dataframe_dropDrop a canvas dataframe by name; opt-in via EDGAR_DATAFRAME_DROP_ENABLED=true

Resources

ResourceDescription
secedgar://conceptsXBRL financial concepts grouped by statement, mapping friendly names to XBRL tags
secedgar://filing-typesCommon SEC filing types, plus the 8-K item-code tables for both numbering regimes

secedgar_search_concepts serves the same concept catalog to tool-only clients.

Prompts

PromptDescription
secedgar_company_analysisStructured analysis of a company's SEC filings: financial trends, risk factors, material events

Skills

SkillDescription
secedgar-guideWhich tool answers each ownership question, where CIKs, accession numbers, CUSIPs, and fund series IDs come from, and the coverage limits to check before reporting data absent

The skill ships in skills/secedgar-guide/SKILL.md. Plugin hosts load it from the package, and MCP clients that support the Skills extension read it from the server as skill://secedgar-guide/SKILL.md.

Capability reference

secedgar_company_search tool

  • query takes a ticker (equities, ETFs, mutual funds), a current or former company name, or a CIK; include_filings (default on) adds up to filing_limit filings (default 10; a value up to 1,000 is served at the 50 inline cap), filtered by forms, filed_after, and filed_before
  • An uppercase ticker also resolves as market-data feeds write it: venue-coded (UEC.N), a preferred class run together (CFGPH), or a root listed only as share classes (GLOP); resolvedAs says how it was read (UEC.N read as UEC (URANIUM ENERGY CORP)), and a non-US listing such as 7203.T fails no_match with a note that EDGAR indexes SEC registrants by US ticker, name, or CIK
  • Returns SIC code, exchanges, fiscal year end, and state of incorporation, plus series_id / class_id for a fund ticker; fails as no_match (with near matches in data.suggestions) or, for a name matching several companies, ambiguous_company, listing up to 10 by CIK, name, and ticker to retry with, plus the full count in total_matches
  • A date or form filter can reach into the archive (up to 10 pages); history_scanned_through reports how far it got

secedgar_search_filings tool

  • Full-text query (phrases, OR, -exclusion, wildcard*, and one ticker: / cik: term to scope it, which fails as unsupported_entity_scope when led by - or NOT or joined by a second), or browse by forms and/or entity with no query; filed_after / filed_before work alone (a lone filed_after runs through today, a lone filed_before starts at 2001-01-01, or at 1993-01-01 before 2001); limit up to 100 (default 20; a value up to 1,000 is served at 100), offset up to 9,999; only sort: "relevance" on a 2001-onward search without ticker: / cik: scope pages EDGAR server-side, where offsets reach 9,900 (a page of 100 there ends at its 10,000-document cap) and a deeper one fails as offset_out_of_range
  • Full text covers 2001 onward; earlier ranges back to 1993 come from the archives, where free text needs ticker: / cik: scope and reads up to 50 documents (scan reports the counts)
  • ticker: takes the spellings secedgar_company_search resolves, and effectiveQuery names the CIK it scoped to and how a market-data spelling was read (CIK 0001334933, UEC.N read as UEC (URANIUM ENERGY CORP))
  • One row per filing, tagged with source (efts, submissions, full-index); full-text rows list matched_documents (filenames for secedgar_get_filing); the response carries total, form_distribution, total_is_exact, and total_documents for full-text searches

secedgar_get_filing tool

  • accession_number in dash or 18-digit form, optional cik to speed the lookup, document for an exhibit, include_xbrl for XBRL artifacts; content_limit 1,000–200,000 characters per page (default 50,000; up to 1,000,000 is served at 200,000)
  • Page with offset / next_offset until content_truncated is false, jump with section (a heading such as item 1 or part i), or open at a phrase with find (net revenue retention), which lists up to 20 occurrences with context and counts them all in occurrences_total; a phrase with no occurrence at or after offset fails as phrase_not_found. Drop section or find to page on: section outranks offset, and under find, offset is where the search starts. The first page of a truncated document carries an outline of up to 50 headings with offsets
  • documents splits the filing into primary, exhibits, and auxiliary; binary entries (scans, PDFs, archives) fail as binary_document, and a section miss returns section_not_found with the outline
  • A structured XML form the filer's submissions feed records through SEC's stylesheet (a recent Form 4, SCHEDULE 13D, or NPORT-P) reads as SEC renders it, with its labels and line breaks, so section reaches its Items; documents still lists the raw XML, which document returns as filed. A holdings report whose raw file passes 600 KB reads as filed
  • A 2000–2001 document the archive doesn't serve under its listed name (0001.htm) is read under its accession-prefixed name, and document takes either spelling; if neither is served, the full submission <accession>.txt is read instead and the notice says so
  • Without cik, the filer is found through EDGAR full-text search and the accession number's prefix, then, when none of those directories serves the filing, through the filers on the filing's index page — so a pre-2001 filing made through a filing agent resolves on its own, and a full-text search outage falls back instead of failing the call

secedgar_get_financials tool

  • company (ticker or CIK) plus concept as a friendly name or raw XBRL tag; taxonomy us-gaap (default), ifrs-full, or dei; period_type annual, quarterly, or all; unit picks one SEC unit key (ZAR, USD, USD/EUR) when a concept is reported in several; limit 1–100 trims the inline series
  • Returns a deduplicated series, newest first, one value per calendar period with form, filed, accession_number, and tag, all in one unit (other units are named in caveats); tags_tried lists the tags checked, and an empty result fails as no_concept_data, no_frame_data, no_period_data, or no_unit_data
  • A friendly name matches in any case or separator form, in lowerCamelCase (operatingIncome), or spelled from its label (capital_expenditures for capex); a concept that is neither a friendly name nor an UpperCamelCase tag fails as unknown_concept, with a formula for standard combinations (free_cash_flow, ebitda, working_capital) or up to three closest friendly names

secedgar_get_snapshot tool

  • company, taxonomy us-gaap (default) or ifrs-full, and period_type annual, quarterly, or both (default); one companyfacts read covers every supported concept, and nothing is staged as a dataframe
  • Each lines entry reports the latest annual and quarterly value for a duration concept, or the latest instant value for balance-sheet and entity-info concepts, each with the tag it came from, under the line's taxonomy; concepts the filer doesn't report land in gaps with tags_tried

secedgar_get_material_events tool

  • company plus up to 20 items codes, dotted (2.02) since 2004-08-23 and single integers (12) before; the two regimes don't overlap, so pair them across the changeover; filed_after / filed_before work alone and reach into the archive; limit 1–1,000, served at 100 (default 20)
  • Each filing decodes its items to code, label, and regime (current / legacy); item_distribution counts every code in the window, and total_8k_scanned against total_matched shows what the filter removed
  • A date window reads up to 10 archive pages; history_scanned_through and dataset.truncated report what went unread

secedgar_get_insider_transactions tool

  • company is the issuer, as a ticker, CIK, or current or former name; a name matching several companies fails as ambiguous_company, listing up to 10 by CIK, name, and ticker to retry with, plus the full count in total_matches; transaction_type purchase (code P), sale (code S), or all (default); limit 1–1,000, served at 100 (default 20); does not cover Forms 3 or 5
  • Without a date window it scans up to 100 of the newest Form 4 / 4-A filings; filed_after / filed_before (inclusive, either alone) read any period since mid-2003, up to 100 filings; history_scanned_through names the oldest filing parsed
  • Each transaction carries the reporting person, relationship, transaction_code and transaction_type, is_derivative, unsigned shares_traded with direction (acquire / dispose), price per share, and shares owned after; dataset.truncated flags filings beyond those parsed, and filings_other_issuer counts Form 4s the company filed as a reporting owner of another issuer, which add no rows. Price text preserves the numeric digits in fixed-point notation, with at least two decimal places.

secedgar_get_institutional_holdings tool

  • company is the 13F filer (a CIK is most reliable), not a portfolio company, which is secedgar_find_holders' job; quarter as YYYY-QN, defaulting to the newest filing; limit 1–500 (default 20; up to 1,000 is served at 500) with offset / next_offset; consolidate (default true) merges sub-lines into positions sorted by value
  • Older quarters are found in the archive (up to 10 pages); a quarter covered only by a 13F-NT notice fails as no_filings_found naming the notice's accession number and period
  • Holdings, paging, consolidation, and the dataframe cover the quarter composed from the original 13F-HR and its same-period 13F-HR/A amendments, applied in acceptanceDateTime order: a RESTATEMENT replaces everything composed so far (earlier NEW HOLDINGS included); a NEW HOLDINGS amendment appends its rows, unless its table repeats every composed row (CUSIP, class, put/call, discretion, shares, share type), in which case it applies as a restatement. Values normalize by each accession's own filing date. Only tables from the last readable restatement on are read
  • amendments (newest filed first) discloses each accession, filing date, and cover-page type (UNAVAILABLE with a reason when unreadable), plus applied_as: restatement, new_holdings, superseded, or not_applied (type or table unreadable, named in the notice); inspect any with secedgar_get_filing. composed_accessions lists the filings the rows come from, in application order. amendment_search_complete=false warns that bounded or unavailable archive discovery may have missed amendments
  • Holdings carry issuer, CUSIP, market_value_usd in whole USD, shares or principal, put_call, and source_accession_numbers (a consolidated position lists each filing it came from; also a dataframe column); total_holdings_in_filing counts the original 13F-HR's raw rows, total_holdings_composed the composed raw rows, and total_positions distinct composed positions; accession_number and filing_date name the original 13F-HR; a shared legal name fails as ambiguous_entity, listing up to 10 by CIK and name plus the full count in total_matches (EDGAR's own count for a name found by entity search, a floor when total_matches_is_lower_bound is true)

secedgar_find_holders tool

  • issuer as a ticker, CIK, or name, plus an optional 9-character cusip, the precise match key (a name phrase-match both over- and under-matches); quarter as YYYY-QN, defaulting to the newest quarter past its 45-day filing deadline; limit 1–100 (default 20; up to 1,000 is served at 100) from up to 500 fetched filings
  • Without cusip, the phrase is the issuer's registry name minus a trailing qualifier such as \DE\ or /OH/; when another registrant's name reduces to the same phrase (FIRST BANCORP /PR/ and /NC/), the holders can include that company's, and the notice names it with CIK and ticker and points to cusip
  • Rows carry filer_cik, accession_number, and form, while search_mode (cusip / name), total_filings, fetched, and holders_in_quarter size the result; the list is unranked, so pass a filer_cik to secedgar_get_institutional_holdings to read the position
  • When matching documents exceed the fetch budget, the notice gives an exact secedgar_search_filings continuation with the query, dates and document offset. Filter results.period_ending to the quarter end, then deduplicate across the sample's filer_cik and search results' cik, keeping the latest filing_date. Advance by 100 documents per full page up to offset 9,900, whose page ends at EDGAR's 10,000-document paging ceiling; lower-bound totals may hide more beyond it

secedgar_get_beneficial_owners tool

  • issuer is the company being held; form_kind all (default), 13D, or 13G; include_amendments (default true); limit 1–20 matching parsed filings (default 10; up to 1,000 is served at 20). The newest-first scan examines at most 50 documents, excluding schedules naming another issuer; exclusions and failed documents do not consume limit
  • Each filing lists reporting_persons with voting power, dispositive power, and percent_of_class per person, which joint filers report for the same shares, so they don't sum; a 13D carries purpose_of_transaction, a 13G has none
  • purpose_of_transaction and each person's notes come back as filed, line breaks included, up to 5,000 and 2,000 characters; a longer value keeps its first characters and sets purpose_truncated or notes_truncated, and the notice points to the whole text in the dataframe's purpose_of_transaction and notes columns or through secedgar_get_filing
  • Coverage starts 2024-12-18 with the structured XML schedules; legacy_filings_before_coverage counts the issuer's older SC 13D / SC 13G text filings
  • total_structured_filings partitions into filings_examined + filings_not_examined; examined documents partition into filings_parsed + filings_excluded_other_issuer + filings_failed.length. Failed accessions carry document_not_found (404) or unparseable (including missing issuer identity), and set partial. truncated means indexed schedules remain unexamined after the result limit or scan ceiling, independently of failures

secedgar_get_fund_holdings tool

  • fund as a ticker (VOO), series ID (S000002839), or CIK; a multi-series trust fails as series_required with the series listed, so pass series_id; report_date picks a period from available_report_periods; limit 1–100 (default 20; up to 1,000 is served at 100) with offset / next_offset
  • Positions come largest first by percent_of_net_assets, with name, CUSIP / ISIN / LEI, balance and units, value_usd, and asset and issuer category, alongside fund net assets, total assets, and total liabilities. Position currency is its denomination; valuations stay in USD. Percentage text preserves the numeric digits in fixed-point notation.
  • Holdings are as of report_period_date, roughly two months before filing_date; publication_lag_days states the gap

secedgar_fetch_frames tool

  • concept as a friendly name or raw tag, period as CY2023, CY2024Q2, or CY2023Q4I, taxonomy us-gaap (default) or dei, unit (default USD), sort desc / asc; limit 1–100 (default 25; up to 1,000 is served at 100) with offset / next_offset
  • One call queries one tag: unqueried_tags and related_tags list variants to fetch separately; value_distribution.max_to_p95_ratio flags scale outliers, period_end_range shows fiscal-year mixing, and caveats flags fiscal-Q4 gaps
  • A concept that is neither a friendly name nor an UpperCamelCase tag fails as unknown_concept; one whose tag has no frame for the period is no_data, which names the tag read and lists a friendly name's other tags in unqueried_tags (older periods often sit under an older tag: revenue before CY2014 is under Revenues or SalesRevenueNet)

secedgar_compare_companies tool

  • 2–10 companies × 1–8 concepts (up to 100 of each are accepted: the first 10 companies and first 8 distinct concepts are compared, and the rest come back unread in deferred_companies / deferred_concepts, with a notice naming the re-calls that compare them); taxonomy us-gaap (default) or ifrs-full; period_type annual (default) or quarterly; periods 1–12 (default 4; up to 1,000 is served at 12), trimmed further when the inline matrix gets too large
  • cells align each value on a calendar period and keep its frame, period_end, and source tag; a call with no comparable annual data fails no_comparable_data
  • failed_companies (reason not_found, ambiguous, or no_company_facts) and gaps report what's missing, and caveats flag differing period ends and unit mismatches between companies and say how a ticker spelling EDGAR doesn't list was read (UEC.N read as UEC (URANIUM ENERGY CORP)); a company named twice (a ticker and its CIK) is read once, under the first input
  • An unrecognized concept is listed in unknown_concepts with a hint; the call fails as unknown_concept only when every concept is unrecognized

secedgar_search_concepts tool

  • search is a substring over friendly name, aliases, label, and tags, so a raw tag like NetIncomeLoss reverse-maps to its friendly name; group and taxonomy filter; no arguments returns the full catalog
  • Each concept lists tags, ifrs_tags (only where an IFRS element was confirmed in live 20-F filings), related_tags, unit, and group

secedgar_dataframe_describe tool

  • Optional name for one dataframe (the dataset name a data tool returned); omit it to list the tenant's active dataframes, newest first, except over HTTP with auth none, where that listing is refused
  • Each entry carries source_tool, query_params, created_at / expires_at, row_count, truncated, and the column_schema that SQL for secedgar_dataframe_query has to match

secedgar_dataframe_query tool

  • One DuckDB SELECT in sql (joins, aggregates, window functions, CTEs); row_limit 1–10,000 (default 1,000) and preview for fewer inline rows, each served at 10,000 up to 100,000, and register_as (df_XXXXX_XXXXX) to save the result as a new dataframe
  • Returns columns, rows, row_count, and row_count_capped, which when true means row_count is the cap, not a total; BIGINT columns serialize as strings
  • Writes, DDL, file-reading functions, multiple statements, and system catalogs are rejected with typed reasons (non_select_statement, denied_function, multi_statement, system_catalog_access, and others); an unqualified current_schema is refused as denied_function even when it names a column, so read such a column as <table>.current_schema

secedgar_dataframe_drop tool

  • name of the dataframe to drop; idempotent, returning dropped: false when nothing matched
  • Off unless EDGAR_DATAFRAME_DROP_ENABLED=true; when disabled it is absent from tools/list

secedgar://concepts resource

  • The friendly-name catalog grouped by statement, as text/markdown, with the us-gaap, IFRS, and alternate-definition tags for each concept
  • The names are what secedgar_get_financials, secedgar_compare_companies, and secedgar_fetch_frames accept as concepts

secedgar://filing-types resource

  • Common SEC forms with cadence and use cases, as text/markdown
  • Includes the 8-K item-code tables for both numbering regimes, the vocabulary of secedgar_get_material_events' items filter

secedgar_company_analysis prompt

  • Arguments: company required; focus_areas optional free text
  • Returns one user message with a numbered workflow (company search, a financial profile via secedgar_get_snapshot with trends via secedgar_get_financials, filing review, material events, and a peer comparison via secedgar_compare_companies with secedgar_fetch_frames for a market-wide ranking) and a findings template; insider, institutional, or blockholder terms in focus_areas add those ownership steps, and "ownership" adds all three

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.

EDGAR-specific:

  • Requests are paced under SEC's 10 req/s limit; after a 429, calls fail locally as rate_limited with a retryAfter countdown for EDGAR_RATE_LIMIT_COOLDOWN_SECONDS, then one probe goes out
  • CIK resolution from tickers (fund tickers included), current and former company names, or raw CIKs, with near-match suggestions on a miss
  • Friendly XBRL concept names that handle historical tag changes; secedgar_get_financials, secedgar_get_snapshot, and secedgar_compare_companies share the same dedup and tag priority, so their numbers agree, and caveats flag gaps in the series
  • Filing documents converted from HTML to text, with heading detection and offset paging for oversized filings
  • Opt-in local SQLite mirror of company tickers and XBRL company-facts (EDGAR_MIRROR_ENABLED) that serves CIK resolution and financials from disk

Agent-friendly output:

  • In-conversation SQL: any tool whose response carries a dataset field has staged its full result as a DuckDB dataframe (df_<id>), while the inline list stays capped at limit; inspect it with secedgar_dataframe_describe, then query it with secedgar_dataframe_query
  • Discriminated outputs and explicit gaps: source on filing-search rows, search_mode, 8-K item regime, typed failed_companies reasons, and gaps with tags_tried in place of zero-filled values
  • Completeness disclosure: history_scanned_through, total_is_exact, publication_lag_days, and dataset.truncated tell agents how deep a scan went and what it left out
  • One parameter name per concept: company, filed_after / filed_before, and forms mean the same thing on every tool, and common alternate spellings (ticker, cik, start_date, end_date, form_types, and others) are accepted as aliases, as is filing_limit for limit on secedgar_search_filings, secedgar_get_material_events, and secedgar_get_beneficial_owners, where limit counts filings

Getting started

Connect to the hosted instance, no install:

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

Or run it locally:

claude mcp add secedgar-mcp-server -e EDGAR_USER_AGENT="YourAppName your-email@example.com" -- npx -y @cyanheads/secedgar-mcp-server

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

{
  "mcpServers": {
    "secedgar-mcp-server": {
      "command": "npx",
      "args": ["-y", "@cyanheads/secedgar-mcp-server"],
      "env": { "EDGAR_USER_AGENT": "YourAppName your-email@example.com" }
    }
  }
}

SEC requires a User-Agent in "AppName contact@email.com" form on every request; no account or key is needed. For Docker or a source build, see Running the server.

Configuration

VariableDescriptionDefault
EDGAR_USER_AGENTRequired. User-Agent sent to SEC, as "AppName contact@email.com". SEC blocks IPs without one. A value that can't be sent as an HTTP header (an em dash or curly quote, an inner line break) stops the server at startup with an error naming this variable.—
EDGAR_RATE_LIMIT_RPSMax requests per second to SEC (1–10).10
EDGAR_RATE_LIMIT_COOLDOWN_SECONDSSeconds to refuse calls locally after a 429 before one probe goes out.600
EDGAR_TICKER_CACHE_TTLSeconds to cache the company and fund ticker files.3600
EDGAR_DATASET_TTL_SECONDSSeconds a canvas dataframe lives, counted from when it is staged; queries do not extend it.86400
EDGAR_DATAFRAME_DROP_ENABLEDSet true to expose secedgar_dataframe_drop, the only destructive tool.false
EDGAR_CLAMP_OVERSIZED_LIMITSServe an over-cap limit, content_limit, periods, preview, or row_limit at its cap, and answer an over-cap companies or concepts list up to its cap with the rest returned unread, instead of rejecting it. Set false to reject above the cap.true
EDGAR_MIRROR_ENABLEDEnable the local SQLite mirror of company tickers and XBRL company-facts. Node/Bun only; bootstrap once with bun run mirror:init.false
EDGAR_MIRROR_PATHDirectory holding the mirror databases../data/edgar-mirror
EDGAR_MIRROR_REFRESH_CRONIn-process refresh cron (HTTP transport only), e.g. 0 9 * * *. Omit to refresh with bun run mirror:refresh.—
EDGAR_MIRROR_FALLBACK_LIVERead the live SEC API wherever SEC may hold something newer than the mirror: the ticker index every cache TTL, a company's XBRL facts once it has filed XBRL since the mirror's companyfacts archive was compiled, a frames period still open for filing, and anything the mirror lacks. The mirror answers when that read fails. Set false for mirror-only reads.true
CANVAS_PROVIDER_TYPECanvas engine; none disables dataframes.duckdb
MCP_TRANSPORT_TYPETransport: stdio or http.stdio
MCP_HTTP_PORTHTTP server port.3010
MCP_AUTH_MODEAuthentication: none, jwt, or oauth. With HTTP and none, every caller shares one canvas, so secedgar_dataframe_describe needs a name.none
MCP_LOG_LEVELLog level (debug, info, warning, error, etc.).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 (spans, metrics, completion logs).false
OTEL_EXPORTER_OTLP_ENDPOINTOTLP base URL for traces and metrics.—
OTEL_EXPORTER_OTLP_LOGS_ENDPOINTOTLP log export endpoint (e.g. http://localhost:4318/v1/logs).—

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

Running the server

Local development

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

  • Clone and install:

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

    bun run rebuild
    bun run start:http   # or start:stdio; HTTP listens at http://localhost:3010/mcp
    
  • 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 run --rm -e EDGAR_USER_AGENT="YourAppName your-email@example.com" -p 3010:3010 ghcr.io/cyanheads/secedgar-mcp-server:latest

The image defaults to HTTP transport on port 3010, stateless session mode, and logs to /var/log/secedgar-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", "EDGAR_USER_AGENT=YourAppName your-email@example.com", "ghcr.io/cyanheads/secedgar-mcp-server:latest"]. To build locally, docker build -t secedgar-mcp-server .; OpenTelemetry peer dependencies are installed by default — build with --build-arg OTEL_ENABLED=false to omit them.

The image ships the mirror CLI, so a running container can bootstrap and refresh its own mirror:

docker exec <container> bun run mirror:verify    # sync status + sample reads
docker exec <container> bun run mirror:init      # one-time bootstrap from the SEC bulk archive
docker exec <container> bun run mirror:refresh   # re-ingest after SEC rebuilds the archive

Project structure

DirectoryPurpose
src/index.tscreateApp() entry point: registers resources and prompts, starts the SEC client, canvas, and optional mirror.
src/configServer environment variable parsing and validation with Zod.
src/mcp-server/tools/definitionsTool definitions (*.tool.ts) and the buildToolDefinitions() registration list.
src/mcp-server/resources/definitionsResource definitions: XBRL concepts and filing types.
src/mcp-server/prompts/definitionsPrompt definitions: company analysis.
src/services/edgarPaced SEC client, CIK resolution, XBRL concept mapping and series dedup, ownership / 13D / 13G / NPORT-P parsers, 8-K item tables, HTML-to-text.
src/services/edgar/mirrorOpt-in local SQLite mirror of company tickers and XBRL company-facts.
src/services/canvas-bridgeAdapter over the framework DataCanvas: df_<id> naming, per-table TTL, system-catalog SQL deny.
scriptsBuild, devcheck, and lint tooling, plus the mirror:* commands.
testsUnit and integration tests, mirroring the src/ structure.

Development guide

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

  • Handlers throw, framework catches — no try/catch in tool logic
  • Use ctx.log for logging, ctx.state for storage
  • Register new tools in buildToolDefinitions() (src/mcp-server/tools/definitions/index.ts), and resources and prompts in the createApp() arrays in src/index.ts
  • Wrap external SEC EDGAR calls: validate the raw response → normalize to a domain type → return the output schema; never fabricate a missing XBRL field — report it under gaps instead

Contributing

Issues are welcome. Run checks and tests before submitting:

bun run devcheck
bun run test

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.