Skip to main content

The definitive MCP server for XBRL processing, validation, and financial analysis — powered by Arelle

Project description

arelle-mcp

The definitive MCP server for XBRL processing, validation, and financial analysis.

PyPI Python License

Built by King Hippopotamus.
Uses Arelle — the world's only free, open-source XBRL-certified processor — as its core engine. No other XBRL MCP server exists. This is the first.


What it does

arelle-mcp gives LLMs (Claude, GPT, etc.) full access to XBRL financial data through 17 tools:

Category Tools Description
Filing Ops xbrl_load_filing, xbrl_filing_summary, xbrl_compare_filings, xbrl_close_filing, xbrl_list_filings Load, inspect, compare, and manage XBRL/iXBRL filings
Validation xbrl_validate Validate against SEC EFM, EU ESEF, UK HMRC, or generic rules
Fact Extraction xbrl_extract_facts, xbrl_fact_details Query financial data points with filtering by concept, period, dimension, unit
Taxonomy xbrl_browse_taxonomy, xbrl_concept_details Search and explore the taxonomy (standard + company extensions)
Relationships xbrl_presentation_tree, xbrl_calculation_tree, xbrl_dimension_structure Navigate financial statement hierarchies, calculation trees, and dimensional breakdowns
SEC EDGAR xbrl_fetch_sec_filing, xbrl_search_sec_concept, xbrl_company_facts Fetch SEC filings by ticker/CIK, search historical concept data
Rendering xbrl_render_statement Reconstruct financial statements (Balance Sheet, Income Statement, Cash Flow)

Plus 5 resources (reference data) and 5 prompt templates (guided analysis workflows).


Quick Start

Install

pip install arelle-mcp

Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "arelle-mcp": {
      "command": "arelle-mcp",
      "env": {
        "ARELLE_MCP_MAX_FILINGS": "5"
      }
    }
  }
}

Claude Code

claude mcp add arelle-mcp -- arelle-mcp

Cursor / Other MCP Clients

{
  "arelle-mcp": {
    "command": "python",
    "args": ["-m", "arelle_mcp"]
  }
}

HTTP Mode (Remote)

ARELLE_MCP_TRANSPORT=streamable-http ARELLE_MCP_PORT=8000 arelle-mcp

Usage Examples

Analyze Apple's Latest 10-K

"Fetch Apple's latest 10-K and give me a financial summary"

The LLM will:

  1. Call xbrl_fetch_sec_filing(ticker="AAPL", filing_type="10-K")
  2. Extract key metrics with xbrl_extract_facts
  3. Render financial statements with xbrl_render_statement

Validate a Filing

"Validate this SEC filing: https://www.sec.gov/Archives/edgar/data/..."

Compare Two Quarters

"Compare Apple's Q2 and Q3 2024 10-Q filings"

Historical Revenue Trend

"Show me Microsoft's revenue history from SEC EDGAR"

The LLM calls xbrl_search_sec_concept(cik="789019", concept="Revenues") — no filing load needed.


Architecture

Core Design Decisions

1. Single-Session Lock — Arelle uses global state that isn't thread-safe. All operations are serialized via asyncio.Lock and offloaded to a ThreadPoolExecutor to avoid blocking the MCP event loop.

2. LRU Filing Cache — Each loaded filing consumes 30-60MB. An OrderedDict-based LRU cache (default: 5 filings) automatically evicts the oldest filing when capacity is reached, calling model.close() to free memory.

3. Lazy Imports — Arelle is heavy (~200MB with taxonomies). All Arelle imports happen lazily inside tool functions, keeping server startup fast.

Project Structure

src/arelle_mcp/
├── server.py            # FastMCP instance, lifespan, registration
├── arelle_wrapper.py    # ArelleManager — session lifecycle, concurrency, caching
├── serializers.py       # Arelle objects → JSON/markdown
├── constants.py         # Arcroles, disclosure systems, SEC config
├── tools/
│   ├── filing.py        # Load, summary, compare, close, list
│   ├── validation.py    # Validate against disclosure systems
│   ├── facts.py         # Extract and filter facts
│   ├── taxonomy.py      # Browse concepts, get details
│   ├── relationships.py # Presentation, calculation, dimension trees
│   ├── edgar.py         # SEC EDGAR API integration
│   └── rendering.py     # Financial statement rendering
├── resources/           # Reference data (disclosure systems, common concepts)
└── prompts/             # Guided analysis workflow templates

Configuration

Environment Variable Default Description
ARELLE_MCP_MAX_FILINGS 5 Max filings cached in memory
ARELLE_MCP_CACHE_DIR (none) Directory for taxonomy cache
ARELLE_MCP_TRANSPORT stdio Transport: stdio or streamable-http
ARELLE_MCP_PORT 8000 HTTP port (when using streamable-http)
ARELLE_MCP_LOG_LEVEL INFO Logging level

Development

git clone https://github.com/TheKingHippopotamus/Arelle-MCP.git
cd Arelle-MCP
pip install -e ".[dev]"

# Run tests
pytest

# Type check
mypy src/arelle_mcp

# Lint
ruff check src/

# Test with MCP Inspector
npx @modelcontextprotocol/inspector arelle-mcp

Supported File Formats

  • XBRL Instance Documents (.xbrl, .xml)
  • Inline XBRL (.htm, .html) — SEC mandated since June 2021
  • iXBRL Document Sets
  • ZIP archives containing XBRL
  • SEC EDGAR URLs (auto-fetched)
  • Taxonomy Packages (.zip)

Supported Disclosure Systems

  • SEC EFM — US Securities and Exchange Commission
  • ESEF — European Single Electronic Format (EU/ESMA)
  • HMRC — UK HM Revenue & Customs
  • GFM — Global Filing Manual

License

Apache 2.0 — same as Arelle itself.


Built by King Hippopotamus — with zero compromises.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arelle_mcp-1.0.0.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arelle_mcp-1.0.0-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

Details for the file arelle_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: arelle_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 54.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for arelle_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fae7bf490c3106088b318ddc68c13a25aac114e7d787b0a370be31b3331ca6b3
MD5 ac405ee4c15c30a05d2249d82e7cef33
BLAKE2b-256 971eb8d1f88758222ecbfbad7a876d8738ed9b402253b2587e4a45174d5b83fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for arelle_mcp-1.0.0.tar.gz:

Publisher: publish.yml on TheKingHippopotamus/Arelle-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file arelle_mcp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: arelle_mcp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 41.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for arelle_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41fe2dde125834025c343eb86fc7bdf4333d2927d58b20564c5fd69a291bee47
MD5 8226316d71b945e057fc73fae90ade96
BLAKE2b-256 4a1c5cb0466c384ad73d65f98cb1ddc669b41101a402430e07aeb2d34733ed45

See more details on using hashes here.

Provenance

The following attestation bundles were made for arelle_mcp-1.0.0-py3-none-any.whl:

Publisher: publish.yml on TheKingHippopotamus/Arelle-MCP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page