Skip to main content

An MCP (Model Context Protocol) server that exposes the Alfanous Quranic search engine as tools and resources for AI assistants.

Project description

Alfanous MCP Server

An MCP (Model Context Protocol) server that exposes the Alfanous Quranic search engine as a set of tools and resources for AI assistants, enabling them to search, explore, and retrieve information from the Holy Qur'an.

Features

  • Search Quranic verses with full support for Arabic text, Buckwalter transliteration, boolean operators, phrase search, wildcards, fuzzy matching, field filters, and facets.
  • Search translations across many languages (English, French, Urdu, and more).
  • Retrieve metadata – chapter names, available translations, recitations, search field descriptions, and API defaults.
  • Query auto-completion – get suggestions while typing a search query.
  • AI query-translation guide as an MCP resource (quran://ai-rules) that helps AI assistants convert natural-language questions into Alfanous query syntax.

Installation

Prerequisites

  1. Install the Alfanous core library and build the indexes:

    pip install alfanous3 pystemmer
    # or from source:
    pip install pyparsing whoosh pystemmer
    cd /path/to/alfanous && make build
    
  2. Install the MCP Python SDK:

    pip install mcp
    

Running the Server

stdio transport (default – works with Claude Desktop and most MCP clients)

python -m alfanous_mcp.mcp_server

Streamable-HTTP transport (for testing/development)

python -m alfanous_mcp.mcp_server --transport streamable-http

Configuring Claude Desktop

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "alfanous": {
      "type": "stdio",
      "command": "python",
      "args": ["-m", "alfanous_mcp.mcp_server"],
      "tools": [
        "search_quran",
        "search_translations",
        "get_quran_info",
        "search_quran_by_themes",
        "search_quran_by_stats",
        "search_quran_by_position",
        "suggest_query",
        "correct_query",
        "search_by_word_linguistics"
      ]
    }
  }
}

Tools

search_quran

Search for verses in the Holy Qur'an.

Parameter Type Default Description
query string (required) Arabic text or Buckwalter transliteration
unit string "aya" "aya", "word", or "translation"
page int 1 Page number
perpage int 10 Results per page (1–100)
sortedby string "relevance" "relevance", "score", "mushaf", "tanzil", "ayalength"
fuzzy bool false Enable fuzzy search (see Fuzzy Search)
fuzzy_maxdist int 1 Levenshtein edit distance — 1, 2, or 3 (only used when fuzzy=true)
view string "normal" "minimal", "normal", "full", "statistic", "linguistic"
highlight string "bold" "bold", "css", "html", "bbcode"
translation string null Translation identifier to include alongside each verse
facets string null Comma-separated facet fields
field_filter string null Field filter expression (e.g. "sura_number:2")

search_translations

Search within Quranic translation texts (English, French, Urdu, etc.).

Parameter Type Default Description
query string (required) Query in any language
translation string null Translation ID (e.g. "en.pickthall"); omit to search all
page int 1 Page number
perpage int 10 Results per page (1–100)
sortedby string "relevance" "relevance", "score", "mushaf", "tanzil", "ayalength"
fuzzy bool false Enable fuzzy search (see Fuzzy Search)
fuzzy_maxdist int 1 Levenshtein edit distance — 1, 2, or 3 (only used when fuzzy=true)
highlight string "bold" "bold", "css", "html", "bbcode"
facets string null Comma-separated facet fields
field_filter string null Field filter expression

get_quran_info

Retrieve Qur'an metadata.

category value Description
"chapters" / "surates" Chapter names and numbers
"translations" Available translation identifiers
"recitations" Available recitation identifiers
"defaults" Default search parameter values
"domains" Valid values for each parameter
"fields" Available search fields
"flags" All supported API flags
"help_messages" Human-readable help for parameters
"hints" Search tips and examples
"ai_query_translation_rules" Full query-syntax guide for AI
"all" Everything at once

suggest_query

Get auto-completion suggestions for a partial query.

Parameter Type Default Description
query string (required) Partial search string
unit string "aya" "aya", "word", or "translation"

Fuzzy Search

When fuzzy=true the engine uses three complementary strategies simultaneously:

# Strategy Field Description
1 Exact aya_ Fully-vocalized Quranic text — precise, statistical matching
2 Normalised / stemmed aya Text indexed with stop-word removal, synonym expansion (index time), and Arabic stemming via Snowball / pystemmer. Handles morphological variants (كَتَبَ / كِتَاب / مَكْتُوب).
3 Levenshtein distance aya_ac Finds indexed terms within fuzzy_maxdist edit operations of each query term. Handles typos and minor spelling variants.

Results from all three strategies are OR-combined, so the result set is always a superset of the exact-only results.

Choosing fuzzy_maxdist

Value Typical use
1 (default) Single-character typos (insertion / deletion / substitution)
2 Longer words or noisier input
3 Maximum tolerance — recall increases significantly

Example (via an AI assistant prompt):

"Search for verses about رحمن with fuzzy matching and edit distance 1"

search_quran(query="رحمن", fuzzy=True, fuzzy_maxdist=1)

Resources

quran://ai-rules

A plain-text guide that teaches AI assistants how to translate natural-language questions about the Qur'an into Alfanous query syntax. Covers all operators, field names, Arabic-specific features (synonyms, antonyms, root derivations), and over 100 practical examples.

Query Syntax Quick Reference

Pattern Example Meaning
Arabic word الله Verses containing "الله"
Buckwalter Allh Same, using transliteration
AND الله رحمة Both words present
OR الله OR رحمن Either word
NOT الله NOT عذاب First without second
Phrase "بسم الله" Exact phrase
Wildcard رحم* Words starting with رحم
Field filter sura_number:2 Surah 2 only
Fuzzy fuzzy=true parameter Broad approximate match

License

LGPL v3 or later – see the root LICENSE file.

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

alfanous3_mcp-1.8.7.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

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

alfanous3_mcp-1.8.7-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file alfanous3_mcp-1.8.7.tar.gz.

File metadata

  • Download URL: alfanous3_mcp-1.8.7.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for alfanous3_mcp-1.8.7.tar.gz
Algorithm Hash digest
SHA256 f8c86b2ac0f475699e68665f55068535c49911ef583cddcb3a9abf6d9be35a81
MD5 6cdc8bc96ceafb86535dc1959977e843
BLAKE2b-256 444778631e3b6137eb52ead204a2f4de8c16629bf81ccbd85a2634812cceab72

See more details on using hashes here.

File details

Details for the file alfanous3_mcp-1.8.7-py3-none-any.whl.

File metadata

  • Download URL: alfanous3_mcp-1.8.7-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for alfanous3_mcp-1.8.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b81121ed42be674c22a13d2d66aefa3d6f90849be476eedfb31278e25cf0f098
MD5 55ba2dfb798d9dc8e55d38833458ea0c
BLAKE2b-256 d39d81c47a6c2e441b63972c5e8d541486efc64195fa2e6b97de10a6c598c41b

See more details on using hashes here.

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