Connects Claude to Halal Terminal's Islamic finance API with 22 tools spanning stock and ETF screening, zakat calculation, dividend purification, and portfolio audits. Covers five methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P) so you can surface verdicts across standards in a single call. Screen individual tickers, bulk scan indices like the S&P 500, or walk ETF holdings to compute weighted compliance and purification rates. Includes live quotes, SEC filings, and news. Free tier gives you 50 tokens per month (roughly 5–10 full screens) with no credit card. Reach for this when building investment tools for Muslim users or when you need programmatic access to Shariah screening logic without rolling your own ratio and business activity checks.
The official Model Context Protocol server for Halal Terminal. Give your AI agent 22 tools to answer Islamic-finance questions: screen any stock or ETF across 5 methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P), audit portfolios, calculate zakat and dividend purification, and pull live market data, news and SEC filings. Works inside Claude Desktop, Claude Code, Cursor, Windsurf, Cline, Continue, Zed, Goose, and any other MCP client.
"Is AAPL halal?" · "Audit my portfolio: AAPL 30%, MSFT 20%, JNJ 50%" · "Calculate zakat on my holdings."
"Is AAPL halal?" → the agent calls screen_stock and returns verdicts across all 5 methodologies.# Recommended — no install needed
npx -y @halalterminal/mcp
# Or pin globally
npm install -g @halalterminal/mcp
{
"mcpServers": {
"halalterminal": {
"command": "npx",
"args": ["-y", "@halalterminal/mcp"],
"env": { "HALALTERMINAL_API_KEY": "ht_yourkey" }
}
}
}
claude mcp add --transport sse halalterminal \
https://mcp.halalterminal.com/sse \
--header "X-API-Key: ht_yourkey"
https://mcp.halalterminal.com/sse?api_key=ht_yourkey
Full setup guide for all clients: CONNECT.md.
| Category | Tools |
|---|---|
| Screening | screen_stock, screen_etf, bulk_screen, get_screening_result, get_all_screening_results |
| Market data | get_quote, get_stock_info, get_price_history, get_trending_stocks, search_stocks |
| ETF analysis | get_etf_info, etf_purification, compare_etfs |
| Portfolio & watchlist | scan_portfolio, manage_watchlist |
| Comparison | compare_stocks |
| Income & zakat | get_dividends, calculate_zakat |
| News & filings | get_news, get_sec_filings |
| Reports & education | generate_report, islamic_finance_education |
Full input/output reference in TOOLS.md. End-to-end prompt walkthroughs in EXAMPLES.md.
SSE: https://mcp.halalterminal.com/sse
Auth: X-API-Key: <your_key> (or ?api_key=<your_key>)
Transports supported: SSE (recommended), stdio (via this @halalterminal/mcp bridge for clients that need it).
The Halal Terminal API is token-metered, not request-metered.
| Plan | Monthly tokens | Price | Notes |
|---|---|---|---|
| Free | 50 | $0 | ~5–10 full screenings · email signup, no credit card |
| Starter | 2,500 | $19 | Individual investors |
| Pro | 15,000 | $49 | Webhooks, bulk priority |
| Enterprise | Unlimited | $199+ | Custom methodologies, SLA |
Sign up: api.halalterminal.com · Pricing: halalterminal.com/pricing
Yes. The @halalterminal/mcp package is Apache-2.0 and free. The Halal Terminal API has a free tier (50 tokens / month, no credit card) that covers ~5–10 full stock screenings — enough to evaluate it before upgrading.
Any client that supports the Model Context Protocol over SSE or stdio — Claude Desktop, Claude Code, Cursor, Windsurf, Cline, Continue, Zed, Goose, and more. SSE is recommended; the @halalterminal/mcp package wraps it as stdio for clients that don't yet support SSE.
Each verdict applies the published rules of the chosen methodology — AAOIFI, Dow Jones Islamic Market (DJIM), FTSE Shariah, MSCI Islamic, and S&P Shariah. Two layers: (1) a business-activity screen (no alcohol, gambling, conventional finance, adult content, weapons, pork, …), then (2) financial-ratio thresholds (e.g. interest-bearing debt over market cap, illiquid assets, interest income share). The MCP exposes all five verdicts so the user — or scholar — can pick the standard they follow.
When you hold a stock with a small share of non-compliant revenue, scholars require donating the non-compliant fraction of any dividend received. calculate_zakat(calculation_type="purification", …) and get_dividends(include_purification=True) compute that amount automatically.
Yes — screen_etf walks every underlying holding, applies the methodology to each, and returns an overall verdict, compliant percentage, and aggregate purification rate. Sukuk ETFs are handled separately (asset-based methodologies).
Yes — bulk_screen triggers an asynchronous run on indices like S&P 500, NASDAQ-100, FTSE 100, and lets you poll for status, filter results by methodology / sector / compliant-only, and diff two runs.
Webhooks are a Pro-plan feature on the API roadmap; v1 of this MCP is request-response only.
github.com/goww7/halalterminal-mcp/issues or email yassir@halalterminal.com.
Website · API · Python SDK · JS SDK · Claude plugin · Discord bot · TradingView indicator · Portfolio tracker
Open-source tools that share the same Halal Terminal API — different surfaces, same data:
| Project | What it is | License |
|---|---|---|
| halalterminal-claude-skills | Claude Code plugin — curated skills, slash commands, and a portfolio-builder subagent on top of this MCP server. | Apache-2.0 |
| yassir-oss | Open-source ReAct agent for halal finance research — CLI + web UI; supports OpenAI / Anthropic / local LLMs. | Apache-2.0 |
| halal-discord-bot | Discord bot — /halal AAPL, /portfolio, /trending slash commands. | MIT |
| halal-portfolio-tracker | Next.js 14 app — enter holdings, get per-stock compliance + portfolio halal % + purification owed. One-click Vercel deploy. | MIT |
| halal-pine | TradingView Pine Script v5 indicator that overlays compliance status on charts. Refreshed daily from this API. | MIT |
Apache-2.0 — see LICENSE.
"Halal Terminal", "HalalTerminal", and the Halal Terminal logo are reserved trademarks — see TRADEMARKS.md.
Powered by Halal Terminal — halalterminal.com
HALALTERMINAL_API_KEY*secretHalal Terminal API key (prefix ht_). Free tier available at https://api.halalterminal.com — email-only signup, no credit card.