Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| PORT | No | Server port (default: 8000 or 3000 depending on language) | |
| API_KEY | No | API key for authentication | |
| VERBOSE_MODE | No | Set to 'true' to enable verbose logging of API requests and responses | false |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list-chapters | List Chapters |
| GET-chapter | Get Chapter |
| info | Get Chapter Info |
| verses-by_chapter_number | Get verses by Chapter / Surah number |
| verses-by_page_number | Get all verses of a specific Madani Mushaf page |
| verses-by_juz_number | Get verses by Juz number |
| verses-by_hizb_number | Get verses by Hizb number |
| verses-by_rub_el_hizb_number | Get verses by Rub el Hizb number |
| verses-by_verse_key | Get verse by key |
| random_verse | Get a random verse |
| juzs | Get list of all juzs |
| search | Search the Quran for specific terms |
| translations | Get list of available translations |
| translation-info | Get information of a specific translation |
| tafsirs | Get list of available tafsirs |
| tafsir-info | Get the information of a specific tafsir |
| tafsir | Get a single tafsir |
| chapter-reciters | List of Chapter Reciters |
| recitation-styles | Get the available recitation styles |
| languages | Get all languages |