盔甲燃烧
一个根据学生的知识水平和兴趣生成高质量教育内容的系统。
项目描述
该存储库包含“Gauntlet Incept”项目的代码和资源,该项目旨在构建一个为K-8学生生成高质量教育内容的系统。最初的范围侧重于以文章和题库的形式为特定学科领域开发教育内容。
文档
项目结构
gauntlet-incept/
├── docs/ # Documentation files
├── src/ # Source code
│ ├── api/ # API routes
│ ├── models/ # Data models
│ ├── services/ # Business logic
│ ├── utils/ # Utility functions
│ ├── data/ # Data files
│ ├── tests/ # Test files
│ ├── index.js # Entry point for REST API
│ └── mcp-server.js # Model Context Protocol server
├── services/ # Microservices
│ ├── qti-service/ # QTI service for content storage
│ └── llm-service/ # LLM service for content generation
├── .env.example # Example environment variables
├── .gitignore # Git ignore file
├── package.json # Node.js package file
├── docker-compose.yml # Docker Compose configuration
├── Dockerfile # Docker configuration
└── README.md # This fileAPI终点
该项目实现了六个核心API端点:
问题端点
POST /api/question/tag-用主题、等级、标准、课程和难度标记一个问题POST /api/question/grade-根据质量标准对标记问题进行评分POST /api/question/generate-根据标签或示例问题生成问题
文章终点
POST /api/article/tag-用主题、等级、标准和课程标记文章POST /api/article/grade-根据质量标准对标记物品进行评级POST /api/article/generate-基于标签或示例文章生成文章
模型上下文协议(MCP)服务器
除了REST API之外,该项目还包括一个MCP服务器,该服务器允许Claude Desktop与Gauntlet Incept系统进行交互。这使Claude能够直接生成、标记和分级教育内容。
请参阅 MCP服务器指南 有关如何在Claude Desktop中设置和使用MCP服务器的详细信息。
入门指南
先决条件
- Git
- Node.js(v14或更高版本)
- 访问RDS PostgreSQL数据库(管理员提供的凭据)
- 数据库连接的SSH密钥(如果通过SSH隧道连接)
- Docker和Docker Compose(可选,用于容器化部署)
安装
- 克隆存储库
git clone https://github.com/yourusername/Gauntlet-Incept.git- 导航到项目目录
cd Gauntlet-Incept- 安装依赖项
npm install- 复制示例环境文件并用您的值更新它
cp .env.example .env- 运行项目
npm start使用Docker运行
- 构建并启动容器
docker-compose up -d- 访问APIhttp://localhost:3000
- 访问MCP服务器http://localhost:3001
数据库连接
此项目连接到具有以下详细信息的Amazon RDS PostgreSQL实例:
- 主机:alphacommoncrawl-core-reboot.cluster-caeuiwckzo1a.us-east-1.rds.amazonaws.com
- 端口: 5432
- 数据库:核心
- 用户名:postgres
注意:出于安全原因,密码存储在环境变量中,而不是直接存储在代码中。
如果需要通过SSH隧道连接,则需要在启动应用程序之前单独设置隧道。
发展
以开发模式运行
npm run dev运行MCP服务器
npm run mcp运行测试
npm test代码检查
npm run lint项目检查表
- \[x\] 初始化Git存储库
- \[x\] 创建基本项目结构
- \[x\] 添加.gitignore文件
- \[x\] 创建初始提交
- \[x\] 设置项目文档
- \[x\] 创建实施检查表
- \[x\] 建立API路由和服务结构
- \[x\] 为核心服务实现占位符功能
- \[x\] 设置Docker容器化
- \[x\] 实现用于Claude Desktop集成的MCP服务器
- \[x\] 配置与RDS PostgreSQL数据库的连接
- \[\]通过LLM集成实现实际功能
- \[\]添加测试
- \[\]审查并最终确定
许可证
麻省理工学院
联系
\[您的联系方式\]
