圣经项目制作
一个上下文感知的项目需求提示(PRP)系统,由LangChain、PostgreSQL和MCP服务器构建,用于圣经文本分析和项目管理。
概述
BibleProjectProduction是一个综合系统,通过集成以下内容生成上下文感知的项目需求提示:
- LangChain 用于人工智能驱动的查询处理
- PostgreSQL 包含圣经文本数据的数据库
- MCP(模型上下文协议) 用于工具集成的服务器
- GitHub MCP服务器 用于存储库上下文
- 希伯来语分析 用于圣经文本处理
- 模块化架构 包含6个专业模块
特性
- 上下文感知PRP生成:使用项目数据、服务器日志和GitHub问题
- MCP服务器集成:7个可通过API端点访问的核心工具
- 希伯来语文本分析:查询希伯来语术语和斯特朗数
- 模块化系统:6个模块(核心、hebrew分析、向量搜索、webui、mcpserver、cli)
- 全面合规:自动规则检查和验证
- 非程序员可访问:批处理脚本和Jupyter笔记本
- 双接口:针对不同用户偏好的CLI和web UI
快速开始
先决条件
- Python 3.11+
- PostgreSQL数据库
- LM Studio(用于本地LLM处理)
- Docker(适用于GitHub MCP服务器)
安装
- 设置环境:
# Double-click setup.bat or run:
python -m venv C:/Users/mccoy/BibleProjectProduction/venv_new
C:/Users/mccoy/BibleProjectProduction/venv_new/Scripts/activate
pip install langchain langchain-community langchain-experimental psycopg flask python-dotenv pytest ruff mypy black isort- 启动服务器:
# Double-click manage_servers.bat or run:
python src/mcp/bible_scholar_api_server.py
python src/search/vector_search_server.py
python scripts/modules/web_ui/web_ui_setup.py- 验证设置:
- MCP服务器:http://127.0.0.1:5200/health - 矢量搜索:http://127.0.0.1:5150/health - Web用户界面:http://127.0.0.1:5300
Docker和容器化工作流
BibleProjectProduction使用Docker使运行和管理所有服务器变得简单一致,特别是对于非程序员。所有主要服务都是集装箱化的:
- MCP服务器 (API服务器,端口5200)
- 矢量搜索服务器 (端口5150)
- Web UI服务器 (端口5300)
- GitHub MCP服务器 (端口8080)
为什么选择Docker?
- 没有手动设置或依赖关系问题
- 所有服务都从一个命令开始
- 为每个人提供一致的环境
- 易于停止、重启或检查状态
如何使用Docker Compose
- 构建所有容器:
- 双击或运行:
docker compose build- 这为所有服务的使用做好了准备。
- 启动所有服务器:
- 双击或运行:
docker compose up -d- 所有四台服务器都将在后台启动。
- 检查服务器状态:
- 双击或运行:
docker compose ps- 显示正在运行的服务器及其运行状况。
- 停止所有服务器:
- 双击或运行:
docker compose down- 这将停止并删除所有容器。
健康检查
- 每个服务器都有一个
/health端点:
- MCP服务器:http://127.0.0.1:5200/health - 矢量搜索:http://127.0.0.1:5150/health - Web用户界面:http://127.0.0.1:5300/health - GitHub MCP:http://127.0.0.1:8080/health
环境变量
- 所有敏感设置都存储在
.env(未共享) - 使用
example.env作为安全共享的模板 - Docker Compose自动加载
.env所有服务
故障排除
- 如果服务器不健康,请在
logs/文件夹或运行:
docker compose logs - 对于大多数问题,请重新启动
docker compose down和docker compose up -d解决它们。
______________________________________________________________________
用法
CLI接口
# Generate PRP
python scripts/modules/cli/cli_setup.py prp --query "What are the requirements for the web UI module?"
# Check compliance
python scripts/modules/cli/cli_setup.py complianceWeb用户界面
- 打开http://127.0.0.1:5300
- 在文本区域输入您的查询
- 点击“生成PRP”以获取结果
API终点
# Generate PRP via API
curl -X POST http://127.0.0.1:5200/api/prp \
-H "Content-Type: application/json" \
-d '{"query": "What are the requirements?", "output_format": "json"}'
# Execute MCP tool
curl -X POST http://127.0.0.1:5200/api/execute-operation \
-H "Content-Type: application/json" \
-d '{"tool": "quick_prp", "params": {"query": "test query"}}'项目结构
BibleProjectProduction/
├── .cursor/rules/ # Cursor rules for compliance
├── .cursor/commands/ # Command templates
├── config/ # Configuration files
├── context_portal/ # Database schema and context
├── docs/guides/ # User documentation
├── examples/ # Example implementations
├── logs/ # Application logs
├── scripts/ # Development and module scripts
│ ├── dev/ # Development tools
│ └── modules/ # Module-specific scripts
├── src/ # Source code
│ ├── api/ # API implementations
│ ├── mcp/ # MCP server code
│ ├── search/ # Vector search implementation
│ └── utils/ # Utility functions
├── tests/ # Test suites
├── setup.bat # Environment setup script
├── manage_servers.bat # Server management script
└── README.md # This file模块
核心模块
- 数据库初始化和管理
- 核心功能和实用程序
希伯来语分析模块
- 希伯来语查询
- Strong的数字查找
- 圣经文本分析
矢量搜索模块
- 矢量搜索服务器
- 语义搜索功能
Web UI模块
- 基于Web的界面
- PRP生成仪表板
MCP服务器模块
- MCP服务器实现
- 7核心工具注册
- API端点管理
CLI模块
- 命令行界面
- 脚本执行工具
合规
该项目遵循严格的合规规则:
- 编码标准:拉夫,我的,黑色,伊索特
- 模块化系统:所有模块所需的文件结构
- MCP服务器:7个核心工具和所需端点
- 日志记录:带时间戳的结构化日志记录
- 非程序员可访问性:批处理脚本和笔记本
运行合规性检查:
python scripts/cursor_rules_compliance_checker.py测试
运行全面测试:
# All tests
python tests/test_comprehensive_system.py
# PRP system tests
python scripts/dev/tests/test_prp_system.py
# Pytest suite
pytest tests/ -v配置
所有配置均通过以下方式管理 config/config.json:
- 服务器设置(主机、端口)
- 模型配置
- API端点
- 数据库连接
环境变量从以下位置加载 .env 并与config合并。
日志记录
所有日志都将写入 logs/ 目录:
- 带有时间戳的应用程序日志
- 任务同步日志
- 合规性检查结果
- 错误跟踪和调试
故障排除
- 检查服务器状态:
manage_servers.bat status- 验证合规性:
python scripts/cursor_rules_compliance_checker.py- 检查日志:
- 审查 logs/ 错误消息目录 - 检查 logs/task_sync.json 任务状态
- 模块特定问题:
- 打开 scripts/modules/[module]/setup.ipynb 用于模块设置 - 遵循笔记本电脑中的非程序员说明
贡献
- 遵循中的所有光标规则
.cursor/rules/ - 确保符合
scripts/cursor_rules_compliance_checker.py - 采用模块化系统结构
- 保持非程序员可访问性
- 更新文档和更改日志
许可证
这个项目是BibleProjectProduction系统的一部分。
支持
有关支持和文档:
- 用户指南:
docs/guides/user_guide_2025-07-04.md - 变更日志:
CHANGELOG.md - 顺从:
scripts/cursor_rules_compliance_checker.py
______________________________________________________________________
最后更新: 2025-07-04 版本: 1.0.0 合规状态:符合要求
