Skip to main content

Official MCP server for Sahmk — use Saudi market data inside AI agents like Cursor and Claude.

Project description

sahmk-mcp

Official Source

Official distribution: GitHub (sahmk-sa) and PyPI only. Do not download binaries from third-party forks.

Official MCP server for Sahmk — use Saudi market data inside AI agents such as Cursor and Claude Desktop.

This MCP exposes a curated set of Sahmk tools for AI agents, so assistants can query the Saudi market in natural language.

Tools

Tool Use it for
get_quote Snapshot for one stock identifier (symbol, name, or alias)
get_quotes Compare multiple stock identifiers in one call
companies_list Company directory/symbol discovery with pagination
get_market_summary Summary for TASI or NOMU
get_market_movers Top movers by gainers, losers, volume, or value
get_sectors Sector performance snapshot
get_company Company profile and fundamentals
get_financials Financial statements (Starter+ plan)
get_ratios Calculated financial ratios (Starter/Pro features vary)
compare_symbols Multi-symbol normalized ratio/metrics comparison (Starter/Pro limits vary)
get_dividends Dividend history and yield data (Starter+ plan)
get_historical Historical OHLCV data

Identifier-First Contract

  • Canonical inputs for quote tools are identifier and identifiers.
  • Legacy aliases symbol and symbols are still accepted for compatibility.
  • Prefer canonical keys in prompts, tool calls, and client templates.
  • Resolution is backend/SDK-backed (names, aliases, and symbols); MCP does not maintain its own symbol map.

When to Use MCP vs SDK

  • Use MCP for interactive agent workflows in tools like Cursor and Claude Desktop.
  • Use the Python SDK for scripts, automation, dashboards, alerts, backtests, and application code.

SDK repo: sahmk-sa/sahmk-python

Get Your API Key

  1. Sign up at sahmk.sa/developers
  2. Go to Dashboard → API Keys → Create Key
  3. Copy your key (starts with shmk_live_ or shmk_test_)

Installation

pip install sahmk-mcp

Requires sahmk>=0.9.2 for symbol discovery (companies_list) and identifier-aware quote resolution (identifier/identifiers).

Security

  • Set API keys via environment variables (SAHMK_API_KEY).
  • Never commit keys to source control or share them in logs.
  • Rotate exposed keys immediately from your Sahmk dashboard.

Configuration

Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "sahmk": {
      "command": "sahmk-mcp",
      "env": {
        "SAHMK_API_KEY": "your_api_key"
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "sahmk": {
      "command": "sahmk-mcp",
      "env": {
        "SAHMK_API_KEY": "your_api_key"
      }
    }
  }
}

Run Directly

export SAHMK_API_KEY="your_api_key"
sahmk-mcp

Tool Input Constraints

  • get_market_summary.index: TASI or NOMU (NOMUC alias is accepted and normalized).
  • get_market_movers.type: gainers, losers, volume, or value.
  • get_market_movers.limit: integer from 1 to 50.
  • get_quote.identifier (preferred): accepts numeric symbol, Arabic/English company name, or known alias.
  • get_quote.symbol (legacy alias): accepted for backward compatibility.
  • get_quotes.identifiers (preferred): maximum 50 identifiers per request.
  • get_quotes.symbols (legacy alias): accepted for backward compatibility.
  • get_financials.symbol: requires exact exchange symbol.
  • get_financials.period and get_financials.statement_period: if both are provided, period takes precedence.
  • get_financials supports optional passthrough params: type, period, statement_period, history, metrics, result, include_quality, and include_partial.
  • get_financials response is statement-block focused and does not include meta.
  • get_ratios.symbol: requires exact exchange symbol.
  • get_ratios.history: defaults to latest.
  • get_ratios.period: defaults to annual.
  • get_ratios.metrics: defaults to core.
  • compare_symbols.symbols: list of symbols (preferred) or comma-separated string.
  • compare_symbols.metrics: defaults to core.
  • get_ratios and compare_symbols include minimal meta only: period, metrics, warnings.
  • Analytics tools do not expose backend/internal fields such as applied_profile, plan, or source diagnostics.
  • get_dividends.symbol: requires exact exchange symbol.
  • get_historical.symbol: requires exact exchange symbol.
  • companies_list.market: TASI or NOMU (NOMUC alias is accepted and normalized).
  • companies_list.limit: integer greater than 0.
  • companies_list.offset: integer greater than or equal to 0.
  • get_historical.interval: 1d, 1w, or 1m.
  • Ambiguous identifiers raise AMBIGUOUS_IDENTIFIER with retry guidance and candidates when available.
  • Invalid identifiers and plan-gated requests return the underlying API error.

Tool Call Examples

  • Company directory search: companies_list(search="aramco")
  • Company directory by market alias normalization: companies_list(search="acwa", market="NOMUC")
  • Company directory pagination: companies_list(search="bank", limit=50, offset=100)
  • Preferred single quote call: get_quote(identifier="أرامكو")
  • Legacy single quote call: get_quote(symbol="2222")
  • Preferred batch quote call: get_quotes(identifiers=["سبكيم", "كيان"])
  • Legacy batch quote call: get_quotes(symbols=["2222", "1120"])
  • Financials by exact symbol: get_financials(symbol="1120")
  • Financial ratios defaults: get_ratios(symbol="1120")
  • Financial ratios advanced: get_ratios(symbol="1120", history="5y", period="quarterly", metrics="extended")
  • Compare symbols defaults: compare_symbols(symbols=["1120", "1180", "1010"])
  • Compare symbols extended: compare_symbols(symbols=["1120", "1180", "1010", "2222"], metrics="extended")
  • Dividends by exact symbol: get_dividends(symbol="1120")
  • Historical by exact symbol: get_historical(symbol="1120", interval="1d")

Company Directory / Symbol Discovery

Use companies_list first to reduce invalid-symbol 404s before symbol-only tools.

  1. Discover candidates by name or symbol fragment:
    • companies_list(search="aramco")
    • companies_list(search="2222")
  2. Optionally scope discovery by market:
    • companies_list(search="acwa", market="NOMUC") (NOMUC is normalized to NOMU)
  3. Pick a symbol from results, then call:
    • get_quote(identifier="<symbol>")
    • get_financials(symbol="<symbol>")
    • get_dividends(symbol="<symbol>")
    • get_historical(symbol="<symbol>")
  4. For pagination loops, increment offset by limit until you reach total:
    • companies_list(search="bank", limit=100, offset=0)
    • companies_list(search="bank", limit=100, offset=100)
    • continue until offset >= total

MCP Guidance Examples

  • User: "سعر الراجحي" -> call get_quote(identifier="الراجحي").
  • Follow-up: "قوائم الشركة" -> if previous result includes resolved_instrument.symbol = "1120", reuse it and call get_financials(symbol="1120").

Example Prompts

  • "Give me a TASI summary and market mood."
  • "Give me TASI market movers by gainers."
  • "Give me NOMU market movers by value."
  • "Show me sector performance."
  • "Compare سابك, سبكيم, and 2222 by price change and net liquidity."
  • "Show me NOMU summary for today."
  • "Get financials for 2222."
  • "Get dividends for 2222."
  • "Get 1d historical data for 1120 from 2026-01-01 to 2026-03-31."
  • "Tell me about الراجحي and its sector."

Note: get_financials and get_dividends require Sahmk API access on Starter or higher. If unavailable for the current key, the MCP returns the underlying API error.

Release Notes

  • 0.4.4: docs: clarify official distribution channels (GitHub + PyPI only)
  • 0.4.3: Align MCP output contract: no financials meta; analytics meta is limited to period, metrics, and warnings.
  • 0.4.2: Add SDK method-name compatibility fallback for analytics (get_ratios/ratios, compare_symbols/compare).
  • 0.4.1: Require sahmk>=0.9.1 in package dependency and runtime version guard.
  • 0.4.0: Add analytics ratios and compare tools; enhance financials optional parameters.

License

MIT — see LICENSE

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

sahmk_mcp-0.4.4.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

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

sahmk_mcp-0.4.4-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file sahmk_mcp-0.4.4.tar.gz.

File metadata

  • Download URL: sahmk_mcp-0.4.4.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sahmk_mcp-0.4.4.tar.gz
Algorithm Hash digest
SHA256 24eafc6a68bc0b882e37d7ba5f1031072da7229d1b7baa047a84278cad3f2511
MD5 0734bbd5f4d1c04cb58130aeb87f1e92
BLAKE2b-256 dc34d9753d3fafa58d84f6223265b62957f70b892d2c220b5216d81105a39d9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sahmk_mcp-0.4.4.tar.gz:

Publisher: publish-pypi.yml on sahmk-sa/sahmk-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 sahmk_mcp-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: sahmk_mcp-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sahmk_mcp-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 020817cb0a5183ff65b9ea177dc3cc913259a48a6c74a1ac904d7919c5220ea4
MD5 04add325b58cae949424e035f9c4298f
BLAKE2b-256 489eb415f7807272fb17ee7027d9cc83fd1afedb341007d6af9f55f74bf286fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for sahmk_mcp-0.4.4-py3-none-any.whl:

Publisher: publish-pypi.yml on sahmk-sa/sahmk-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