Gauntlet-Incept

一个为学生知识水平和兴趣量身定制，生成高质量教育内容的系统。

项目描述

此仓库包含 Gauntlet-Incept 项目的代码和资源，该项目旨在构建一个为 K-8 学生生成高质量教育内容的系统。初始范围侧重于开发特定学科领域的文章和题库形式的教育内容。

文档

• 项目概述 - 项目目标和要求的详细描述
• 实施清单 - 项目实施的综合清单
• 原始项目简报 - 包含详细要求的原始项目简报
• MCP 服务器指南 - 使用 Claude Desktop 的 Model Context Protocol 服务器指南

项目结构

gauntlet-incept/
├── docs/                  # 文档文件
├── src/                   # 源代码
│   ├── api/               # API 路由
│   ├── models/            # 数据模型
│   ├── services/          # 业务逻辑
│   ├── utils/             # 实用函数
│   ├── data/              # 数据文件
│   ├── tests/             # 测试文件
│   ├── index.js           # REST API 的入口点
│   └── mcp-server.js      # Model Context Protocol 服务器
├── services/              # 微服务
│   ├── qti-service/       # 用于内容存储的 QTI 服务
│   └── llm-service/       # 用于内容生成的 LLM 服务
├── .env.example           # 示例环境变量
├── .gitignore           # Git 忽略文件
├── package.json           # Node.js 包文件
├── docker-compose.yml     # Docker Compose 配置
├── Dockerfile             # Docker 配置
└── README.md              # 此文件

API 接口

该项目实现了六个核心 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 - 根据标签或示例文章生成文章

Model Context Protocol (MCP) 服务器

除了 REST API 之外，该项目还包括一个 MCP 服务器，允许 Claude Desktop 与 Gauntlet Incept 系统交互。这使 Claude 能够直接生成、标记和评分教育内容。

有关如何设置和使用 Claude Desktop 的 MCP 服务器的详细信息，请参阅 MCP 服务器指南。

快速开始

前提条件

• Git
• Node.js (v14 或更高版本)
• 访问 RDS PostgreSQL 数据库（凭据由管理员提供）
• 用于数据库连接的 SSH 密钥（如果通过 SSH 隧道连接）
• Docker 和 Docker Compose（可选，用于容器化部署）

安装

1. 克隆仓库

   git clone https://github.com/yourusername/Gauntlet-Incept.git
   

2. 导航到项目目录

   cd Gauntlet-Incept
   

3. 安装依赖项

   npm install
   

4. 复制示例环境文件并使用您的值更新它

   cp .env.example .env
   

5. 运行项目

   npm start
   

使用 Docker 运行

1. 构建并启动容器

   docker-compose up -d
   

2. 通过 http://localhost:3000 访问 API
3. 通过 http://localhost:3001 访问 MCP 服务器

数据库连接

该项目连接到具有以下详细信息的 Amazon RDS PostgreSQL 实例：

• 主机: alphacommoncrawl-core-reboot.cluster-caeuiwckzo1a.us-east-1.rds.amazonaws.com
• 端口: 5432
• 数据库: core
• 用户名: 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 集成实现实际功能
• [ ] 添加测试
• [ ] 审查并最终确定

许可证

MIT

联系方式

[您的联系方式]