io.github.ikop32-code/edgaralert

السجل الرسمي البحث والويب

SEC insider trading alerts, Form 4 signals, 8-K events, and company research via EDGAR Alert API.

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package @edgaralert/mcp-server
Claude Code
claude mcp add edgaralert -e 'EDGARALERT_API_KEY=<your edgaralert_api_key>' -- npx -y @edgaralert/mcp-server@1.0.1
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "edgaralert": {
            "command": "npx",
            "args": [
                "-y",
                "@edgaralert/mcp-server@1.0.1"
            ],
            "env": {
                "EDGARALERT_API_KEY": "<your edgaralert_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • EDGARALERT_API_KEY إلزامي سري Your EDGAR Alert API key (find it at edgaralert.com/account/api-keys).

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. EDGAR Alert MCP Server
  2. What this is (and isn't)
  3. Requirements
  4. Install
  5. Example Claude Desktop config
  6. Environment variables
  7. Tools
  8. Errors you might see
  9. Security notes
  10. Development

EDGAR Alert MCP Server

Connect Claude Desktop (or any MCP-compatible client) directly to your EDGAR Alert account. Ask live questions about SEC insider trading signals, Form 4 activity, 8-K officer/director changes, and company research context — without leaving your conversation.

Works on any paid EDGAR Alert plan. Most tools (latest alerts, search, company profiles, fundamentals, price windows) work on STARTER and PRO. One tool — edgaralert_get_company_agent_context, the bundled AI research-context payload — requires Enterprise; on a lower plan it returns a clear upgrade message instead of failing silently. See Tools below for the full breakdown, and edgaralert.com/pricing to upgrade.

What this is (and isn't)

  • A thin wrapper around the existing public https://api.edgaralert.com/api/v1 REST API. Every tool maps to exactly one v1 endpoint.
  • No direct database access. No scoring or signal logic is duplicated here — all of that lives in the API, same as it does for every other v1 API consumer.
  • No billing, no account management, no trading. This server cannot place orders, change your subscription, or alter account settings.
  • Two tools write, and only to your own watchlists. edgaralert_add_ticker_to_list and edgaralert_remove_ticker_from_list POST and DELETE against /ticker-lists. Everything else is a GET.
  • Your API key is yours — you provide it, it is sent only to api.edgaralert.com as the X-API-Key header, and this server never writes it to disk or logs it.

Requirements

  • Node.js 18.17 or later
  • An EDGAR Alert API key on any paid plan (get one here) — STARTER and PRO both work for most tools; Enterprise unlocks all 8.

Install

  1. Download edgaralert-mcp.mcpb from the latest release.
  2. Open Claude Desktop → Settings → Extensions → Advanced settings → Install Extension, and select the downloaded file (or just drag the file onto the Claude Desktop window).
  3. When prompted, paste your EDGAR Alert API key. Claude Desktop stores it securely in your OS keychain — this project never sees or stores it outside that prompt.
  4. Restart Claude Desktop if prompted.
Option B: Manual install via claude_desktop_config.json
  1. Clone or download this folder (mcp-server/) somewhere on your machine.
  2. Install dependencies and build:
     cd mcp-server
     npm install
     npm run build
  3. Open your Claude Desktop config file:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  4. Add an entry under mcpServers (see example below).
  5. Restart Claude Desktop.
Option C: Run locally for development
cd mcp-server
npm install
EDGARALERT_API_KEY=EA_your_key_here npm run dev

This runs the server on stdio using tsx, without a build step. Useful when iterating on tool definitions.

Example Claude Desktop config

{
  "mcpServers": {
    "edgaralert": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-server/dist/index.js"],
      "env": {
        "EDGARALERT_API_KEY": "EA_your_key_here"
      }
    }
  }
}

Replace /absolute/path/to/mcp-server/dist/index.js with the real path on your machine, and EA_your_key_here with your actual EDGAR Alert API key. Never commit this file with a real key in it.

Environment variables

VariableRequiredDefaultDescription
EDGARALERT_API_KEYYes—Your EDGAR Alert v1 API key. Sent as X-API-Key on every request.
EDGARALERT_BASE_URLNohttps://api.edgaralert.com/api/v1Override for staging/local development. Most users should not set this.

Tools

Ten of the twelve tools are read-only; the two watchlist mutations are marked write below. See docs/tools.md for full input schemas, endpoint mappings, and error behavior.

ToolEndpointMin. plan
edgaralert_get_latest_alertsGET /alerts/latestSTARTER
edgaralert_search_alertsGET /alertsPRO
edgaralert_get_alert_price_windowGET /alerts/{id}/price-windowPRO
edgaralert_search_companiesGET /companies/searchPRO
edgaralert_get_company_profileGET /companies/{tickerOrCik}/profileAll paid
edgaralert_get_company_fundamentalsGET /companies/{tickerOrCik}/fundamentalsPRO
edgaralert_get_company_agent_contextGET /companies/{tickerOrCik}/agent-contextENTERPRISE
edgaralert_get_weekly_insightsGET /insights/weekly (public)None
edgaralert_get_industry_capital_flowGET /insights/capital-flow (public)None
edgaralert_get_ticker_listsGET /ticker-listsSTARTER
edgaralert_add_ticker_to_listPOST /ticker-lists/{listId}/items (write)STARTER
edgaralert_remove_ticker_from_listDELETE /ticker-lists/{listId}/items/{ticker} (write)STARTER

"Min. plan" reflects what the underlying API enforces today — STARTER and PRO keys can use 11 of 12 tools. Only edgaralert_get_company_agent_context requires Enterprise; on a lower-tier key it returns a clean 403 with an upgrade message (see below) rather than failing silently or crashing. The two /insights/* tools are public and need no plan at all.

Errors you might see

  • "Your EDGAR Alert API key was rejected" — check EDGARALERT_API_KEY is set and correct.
  • "This action requires a higher EDGAR Alert plan" — expected on edgaralert_get_company_agent_context for STARTER/PRO keys; every other tool should work normally on those plans. If you see this on a different tool, double check your plan tier in the EDGAR Alert dashboard.
  • "rate or daily quota exceeded" — you've hit your plan's API limits. Wait, or check usage in your EDGAR Alert dashboard.
  • "Could not reach the EDGAR Alert API" — a network/connectivity issue, not an account issue. Run node -e "fetch('https://api.edgaralert.com/api/v1/alerts/latest').then(r=>r.text()).then(console.log)" — you should see a JSON error like {"message":"Missing X-API-Key header."} (that's expected and means the API is reachable). If you get a DNS error (ENOTFOUND/ENODATA) or no response, the problem is local network/DNS, not this server or your account.
  • "Unexpected token '<', is not valid JSON" — the request reached a server, but got back an HTML page instead of API data. This happens if EDGARALERT_BASE_URL is ever pointed at edgaralert.com or www.edgaralert.com instead of api.edgaralert.com — the bare and www hosts serve the marketing website (an Azure Static Web App), not the API. The default in this package is already set to api.edgaralert.com; if you see this error, check whether EDGARALERT_BASE_URL has been overridden somewhere in your config.

Security notes

  • This server has no admin, billing, or order-management capability of any kind — those endpoints are not implemented here, by design.
  • No secrets are hardcoded anywhere in this package. The only credential used is the one you supply via environment variable / Claude Desktop config.
  • No data is cached or persisted to disk between tool calls.
  • Network access is limited to EDGARALERT_BASE_URL (defaults to api.edgaralert.com) — no other outbound calls are made.

Development

npm run typecheck   # type-check without emitting
npm run build        # compile to dist/
npm run dev           # run with tsx, no build step

To add a new tool: copy the pattern in src/tools/getWeeklyInsights.ts (for a no-input tool) or src/tools/searchAlerts.ts (for a filtered tool), register it in src/tools/index.ts, and only ever call api/v1/* or other already-public endpoints. Do not add database clients, Stripe/order clients, or any write-capable tool to this package.

الأسئلة الشائعة

ما هو io.github.ikop32-code/edgaralert؟

SEC insider trading alerts, Form 4 signals, 8-K events, and company research via EDGAR Alert API.

كيف أثبّت io.github.ikop32-code/edgaralert؟

يعمل على جهازك. في Claude Code: claude mcp add edgaralert -e 'EDGARALERT_API_KEY=<your edgaralert_api_key>' -- npx -y @edgaralert/mcp-server@1.0.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.ikop32-code/edgaralert إلى مفتاح API؟

نعم. يتطلب EDGARALERT_API_KEY، وتضبطها في إعداداته.

هل io.github.ikop32-code/edgaralert مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.ikop32-code/edgaralert؟

ينشره ikop32-code. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.