Gauntlet-Incept

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

项目描述

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

文档

• 项目概述 - 详细描述了项目目标和需求
• 实施检查表 - 项目实施的全面检查表
• 原始项目简报 - 包含详细要求的原始项目简报
• MCP服务器指南 - 使用Model Context Protocol服务器与Claude Desktop的指南

项目结构

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 file

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能够直接生成、标记并评估教育内容。

请参阅MCP服务器指南，了解如何设置和使用MCP服务器与Claude Desktop配合工作。

入门指南

前提条件

• Git
• Node.js（版本14或更高）
• 访问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

项目清单

• 初始化 Git 仓库
• 创建基本的项目结构
• 添加 .gitignore 文件
• 创建初始提交
• 设置项目文档
• 创建实施清单
• 设置 API 路由和服务结构
• 为核心服务实现占位符功能
• 设置 Docker 容器化
• 为 Claude Desktop 集成实现 MCP 服务器
• 配置与 RDS PostgreSQL 数据库的连接
• 实现与 LLM 集成的实际功能
• 添加测试
• 审核并最终确定

许可证

MIT

联系方式

[您的联系信息]