MCP Server for Quran.com API

MCP Server for Quran.com API

site icon
2025.04.04 0
TypeScript宗教服务语言学习API 集成内容生成
djalal_quran-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务器,用于通过 Quran.com 的 REST API v4 与古兰经语料库进行交互。该服务器提供了丰富的 API 端点,允许 LLMs(大型语言模型)通过兼容的客户端访问古兰经的章节、经文、翻译、注释等信息。
View on GitHub

Overview

基本能力

产品定位

djalal_quran-mcp-server 是一个专门用于访问和查询古兰经内容的 MCP 服务器,旨在为开发者和研究人员提供一个便捷的接口来获取古兰经的相关数据。

核心功能

  • 章节管理:获取古兰经的章节列表、特定章节的详细信息。
  • 经文查询:通过章节、页码、Juz 号、Hizb 号等多种方式查询经文。
  • 搜索功能:支持在古兰经中搜索特定术语。
  • 翻译和注释:获取可用的翻译和注释列表,以及特定翻译或注释的详细信息。
  • 音频资源:获取章节朗诵者和朗诵风格的信息。
  • 语言支持:获取支持的语言列表。

适用场景

  • 宗教研究:用于学术研究或宗教学习,快速获取古兰经的相关内容。
  • 语言学习:支持多语言翻译,适合语言学习者使用。
  • 开发集成:开发者可以将其集成到自己的应用中,提供古兰经查询功能。

工具列表

  • GET /chapters:列出所有章节。
  • GET /chapters/{id}:获取特定章节的详细信息。
  • GET /verses/by_chapter/{chapter_number}:通过章节号获取经文。
  • GET /search:搜索古兰经中的特定术语。
  • GET /resources/translations:获取可用的翻译列表。
  • GET /resources/languages:获取支持的语言列表。

常见问题解答

  • API 密钥:某些功能可能需要 API 密钥,需在环境变量中设置 API_KEY
  • 详细日志:设置 VERBOSE_MODE=true 可以启用详细日志,便于调试。

使用教程

使用依赖

  • Node.js 22+
  • Docker

安装教程

  1. 构建 Docker 镜像
docker build -t quran-mcp-server .
  1. 运行服务器
docker run -i --rm --init -e API_KEY=your_api_key_if_needed -e VERBOSE_MODE=true quran-mcp-server

调试方式

  1. 启用详细日志
export VERBOSE_MODE=true
  1. 运行测试
npm test

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。