Skip to main content
Glama
ForexFactory MCP Server

ForexFactory MCP Server

by kjpou1

📅 ForexFactory MCP-Server

Python License MCP uv

Contributions welcome Status PRs Welcome Made with Love

Ein MCP-Server (Model Context Protocol), der ForexFactory-Wirtschaftskalenderdaten als Ressourcen und Tools bereitstellt.

Entwickelt für den Einsatz in agentenbasierten Workflows, LLMs und Trading-Assistenten.



🚀 Funktionen

  • ✅ Abrufen von Wirtschaftskalender-Ereignissen nach Zeitraum (today, this_week, custom usw.)

  • ✅ Zugriff über MCP-Ressourcen (für abonnementartigen Zugriff)

  • ✅ Zugriff über MCP-Tools (direkte Aufrufe von Clients/Agenten)

  • ✅ JSON-basierte Antworten für einfache Integration

  • ⚡ Integrierbar mit LangChain, n8n oder jedem MCP-kompatiblen Client


📌 Entwicklungsstatus

Dieses Projekt befindet sich in aktiver Entwicklung. Die Kernfunktionalität ist stabil (Abrufen von ForexFactory-Wirtschaftskalender-Ereignissen über MCP-Tools und -Ressourcen), aber wir arbeiten noch an:

  • Erweiterung der Funktionen (Prompts, Bereitstellungsoptionen)

  • Verbesserung der Dokumentation und Beispiele

Wir freuen uns über Feedback und Beiträge, während wir das Ökosystem weiter ausbauen.


forexfactory-mcp/
│── src/forexfactory_mcp/   # Main package
│   ├── models/             # Schemas & enums
│   ├── services/           # Scraper + data normalization
│   ├── tools/              # MCP tool definitions
│   ├── resources/          # MCP resource definitions
│   ├── prompts/            # Prompt templates (optional MCP prompts)
│   ├── utils/              # Shared helpers & config
│   └── server.py           # FastMCP server entrypoint
│
│── examples/               # Example clients
│── tests/                  # Unit tests
│── .env.example            # Copy to .env for config
│── pyproject.toml          # Dependencies & metadata
│── README.md               # Documentation
│── .python-version         # Python version pin (3.12)

(Siehe Repository für vollständige Details – dies ist ein grober Überblick für Mitwirkende.)


Related MCP server: MCP Financial Data Gateway

🔧 Installation

Anforderungen

  • Python 3.12+

  • uv oder pip

  • Ein modernes Terminal oder ein MCP-kompatibler Client

Einrichtung

# Clone repo
git clone https://github.com/kjpou1/forexfactory-mcp.git
cd forexfactory-mcp

# Install dependencies
uv sync   # or: pip install -e .

# Install Playwright browser binaries
uv run playwright install chromium
# or, if using pip/venv:
playwright install chromium

# Copy example environment and adjust if needed
cp .env.example .env

▶️ Verwendung

⚡ Schnellstart

Starten Sie den Server mit den Standardeinstellungen (stdio-Transport):

uv run ffcal-server

Ausführung mit HTTP-Transport:

uv run ffcal-server --transport http --host 0.0.0.0 --port 8080

SSE-Transport (⚠️ veraltet)

uv run ffcal-server --transport sse --host 127.0.0.1 --port 8001

Standardwerte für Umgebungsvariablen

MCP_TRANSPORT=http
MCP_HOST=0.0.0.0
MCP_PORT=8080

🏷️ Namespace

Standard-Namespace:

ffcal

Überschreiben via .env:

NAMESPACE=ffcal

📦 Ressourcen

Name

Pfad

Beschreibung

events_today

ffcal://events/today

Heutige Ereignisse

events_week

ffcal://events/week

Alle Ereignisse diese Woche

events_range

ffcal://events/range/{start}/{end}

Benutzerdefinierter Datumsbereich


🛠️ Tools

Name

Typ

Beschreibung

ffcal_get_calendar_events

Tool

Ereignisse für einen bestimmten Zeitraum abrufen

Unterstützte Werte:

today, tomorrow, yesterday, this_week, next_week, last_week, this_month, next_month, last_month, custom

📝 Prompts

Name

Beschreibung

ffcal_daily_prep

Vorbereitungsnotiz für Trader für heute

ffcal_weekly_outlook

Wöchentliche Zusammenfassung der Makro-Ereignisse

ffcal_volatility_grid

Wöchentliche Heatmap für Ereignisrisiken

ffcal_trade_map_scenarios

Szenario-Karte für spezifische Ereignisse


🧩 Prompt-Stile

Alle Prompts unterstützen einen style-Parameter zur Steuerung der Formatierung. Standard:

style: str = "bullet points"

Siehe die Output Style Reference für verfügbare Formate.


💻 Client-Beispiele

Beispiel: Verwendung der MCP-CLI

mcp call ffcal:get_calendar_events time_period=this_week

Beispiel: Verwendung in Python

from mcp.client.session import Session
async with Session("ws://localhost:8000") as session:
    result = await session.call_tool("ffcal:get_calendar_events", {"time_period": "today"})
    print(result)

Beispiel: LangChain-Integration

from langchain.agents import initialize_agent
from langchain_mcp import MCPToolkit

toolkit = MCPToolkit.from_server_url("ws://localhost:8000", namespace="ffcal")
agent = initialize_agent(toolkit.tools)
response = agent.run("What are today's USD-related high impact events?")
print(response)

📘 Referenz zur Client-Konfiguration

📖 docs/CLIENT_CONFIG_REFERENCE.md

Beinhaltet:

  • ✅ Beispielkonfigurationen für Claude Desktop (lokal + Docker)

  • 🐳 Docker-Build und -Einrichtung

  • 🧩 VS Code MCP-Integration (zukünftig)

  • 🧪 Test- und Fehlerbehebungs-Checkliste

  • 🔍 Inspector-Einrichtung für visuelles Debugging


⚙️ Konfiguration

Variable

Standard

Beschreibung

NAMESPACE

ffcal

Namespace-Präfix

MCP_TRANSPORT

stdio

Transporttyp (stdio, http, sse)

MCP_HOST

127.0.0.1

Host für HTTP/SSE

MCP_PORT

8000

Port für HTTP/SSE

SCRAPER_TIMEOUT_MS

5000

Playwright-Timeout

LOCAL_TIMEZONE

System-Lokal

Zeitzonen-Überschreibung


Beispiel .env

MCP_TRANSPORT=http
MCP_HOST=0.0.0.0
MCP_PORT=8080
NAMESPACE=ffcal

🐳 Docker-Integration

Unterstützt sowohl stdio (Standard) als auch HTTP/SSE.

docker compose build
docker compose up forexfactory_mcp

Führt den MCP-Server aus und stellt ihn auf Port 8000 bereit.


Ziel

Beschreibung

make build

Docker-Image bauen

make run-http

Server im HTTP-Modus ausführen

make run-stdio

Im stdio-Modus ausführen

make dev-http

Über MCP Inspector untersuchen

make stop

Container stoppen


🐍 1. uv oder Abhängigkeitsinstallation schlägt fehl

Ausführen:

docker compose build --no-cache forexfactory_mcp

⚡ 2. Server beendet sich sofort

Wechseln zu:

make run-http

🌐 3. Port wird bereits verwendet

Port ändern:

docker compose run --rm -e MCP_PORT=8080 forexfactory_mcp

🔐 4. Browser schlägt fehl

Chromium installieren:

docker compose run forexfactory_mcp playwright install chromium

🧪 Tests

pytest -v

📊 Roadmap

  • [ ] Ereignisfilter nach Währung und Auswirkung

  • [ ] Historische Daten nachladen

  • [ ] MCP-Prompt-Erweiterungen

  • [ ] Cloud-fähige Bereitstellung


🤝 Mitwirken

  1. Forke das Repo

  2. Erstelle einen Feature-Branch

  3. Committe mit einer klaren Nachricht

  4. Pushe und öffne einen PR


📜 Lizenz

MIT-Lizenz – siehe LICENSE für Details.

Available Tools

1 tool
my-ffcal_get_calendar_eventsC

Retrieve ForexFactory calendar events for a given time period or custom date range.Valid time_period values include: today, tomorrow, yesterday, this_week, next_week, last_week, this_month, next_month, last_month, custom.

NameRequiredDescriptionDefault
time_periodNo
start_dateNo
end_dateNo

Output Schema

NameRequiredDescription
resultYes

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions retrieval but lacks details on permissions, rate limits, error handling, or response format. For a read operation with zero annotation coverage, this is insufficient to inform the agent adequately.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence, followed by parameter details. It is efficient with minimal waste, though it could be slightly more structured by separating usage notes from parameter lists.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema, the description does not need to explain return values. However, with no annotations, 3 parameters, and 0% schema coverage, the description partially compensates by detailing one parameter but leaves gaps in behavioral transparency and parameter semantics, making it minimally adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It explains the 'time_period' parameter by listing valid values, which adds meaning beyond the schema. However, it does not cover 'start_date' or 'end_date' parameters, leaving two of three parameters undocumented, resulting in a baseline score due to partial compensation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Retrieve') and resource ('ForexFactory calendar events') with scope ('for a given time period or custom date range'), making the purpose specific and understandable. However, since there are no sibling tools mentioned, it cannot demonstrate differentiation from alternatives, which prevents a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, prerequisites, or exclusions. It only lists valid values for one parameter without explaining usage context or trade-offs, leaving the agent with minimal direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev1.0.0
    • Changedmy-ffcal_get_calendar_events1 field changed
      • addedInput schema / title
        Added value: +"get_calendar_eventsArguments"
  2. 1 tool update
    • First observedmy-ffcal_get_calendar_events

TDQS

B3.1/5.0

Scored across 1 tool

Disambiguation5/5

With only one tool, there is no possibility of ambiguity or overlap between tools. The single tool has a clear and distinct purpose: retrieving ForexFactory calendar events.

Naming Consistency5/5

Since there is only one tool, naming consistency is inherently perfect. The tool name 'my-ffcal_get_calendar_events' follows a verb_noun pattern, which is consistent with itself.

Tool Count2/5

A single tool is generally too few for a server's purpose, as it limits functionality and scope. For a ForexFactory calendar server, one might expect additional tools for filtering, sorting, or managing events, making this count feel thin and under-scoped.

Completeness2/5

The server only provides retrieval of calendar events, with no tools for creating, updating, deleting, or otherwise managing events. This is a significant gap, as it lacks basic CRUD operations and limits the server's utility to read-only access.

Maintenance

ActivityInactive
ResponsivenessSyncing

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    D
    maintenance
    Provides 10 financial data tools (market data, economic indicators, news, insider trades, and calendars) via a single MCP layer, enabling any MCP-compatible LLM to access diverse financial data through a unified interface.
    1
    MIT
  • A
    license
    Not graded
    quality
    F
    maintenance
    Provides macro-economic event data, earnings reports, and market overviews as MCP tools, enabling AI agents to query calendars, check event proximity, and assess trade safety.
    31 PyPI
    2
    MIT
  • F
    license
    Not graded
    quality
    C
    maintenance
    Enables AI agents to access and analyze Forex Factory economic calendar data, including enriched event details and summary statistics, through MCP tools and resources.
    -