使用说明
项目简介
Gauntlet Incept 是一个旨在为K-8年级学生生成高质量教育内容的系统。除了提供RESTful API服务外,该项目还实现了 Model Context Protocol (MCP) 服务器,允许LLM客户端(如 Claude Desktop)通过标准化的MCP协议与系统进行交互,实现教育内容的生成、标注和质量评估等功能。
主要功能点
- 资源管理 (Resources): 虽然文档中没有明确列出 MCP Server 提供的资源,但根据项目描述和代码结构,推测可能将生成的教育内容(题目、文章、课程)作为资源进行管理和提供。
- 工具注册和执行 (Tools): 实现了用于教育内容处理的工具,包括:
- 'tagQuestion': 为题目添加标签(科目、年级、标准、课程、难度)。
- 'gradeQuestion': 根据质量标准评估已标注题目的质量。
- 'generateQuestion': 根据标签或示例题目生成新的题目。
- 'tagArticle': 为文章添加标签(科目、年级、标准、课程)。
- 'gradeArticle': 根据质量标准评估已标注文章的质量。
- 'generateArticle': 根据标签或示例文章生成新的文章。
- 'searchExamples': 在数据库中搜索示例教育内容(题目或文章)。
- 'getCourseStructure': 获取课程结构信息。
- 'getQuestion': 获取题目资源
- 'getArticle': 获取文章资源
- 'getCourse': 获取课程资源
- Prompt 模板 (Prompts): 仓库中包含 Prompt 模板定义,虽然具体模板内容未在仓库信息中展示,但根据MCP服务器的定义,推测可能包含用于引导 LLM 进行内容生成和交互的 Prompt 模板。
- REST API 接口: 除了MCP Server外,还提供了基于RESTful API的'/api/question'和'/api/article'接口,用于Web应用或其他系统集成。
安装步骤
-
克隆仓库:
git clone https://github.com/Birdsmith/Gauntlet-Incept-MCP.git cd Gauntlet-Incept-MCP -
安装依赖: 确保已安装 Node.js (v14 或更高版本) 和 npm。
npm install -
配置环境变量: 复制 '.env.example' 文件并重命名为 '.env',根据需要修改其中的数据库连接信息和其他配置项,特别是需要配置 PostgreSQL 数据库的连接信息('DB_HOST', 'DB_PORT', 'DB_NAME', 'DB_USER', 'DB_PASSWORD')。
cp .env.example .env # 编辑 .env 文件,填入数据库连接信息 nano .env -
启动服务器: 使用 npm 命令启动项目,包括 REST API 服务器和 MCP 服务器。
npm start或者只运行 MCP Server:
npm run mcp
服务器配置 (MCP客户端配置)
以下 JSON 配置信息可用于配置 MCP 客户端以连接到 Gauntlet Incept MCP 服务器。请注意,您需要根据实际情况修改 'command' 和 'args' 字段,确保命令能够正确启动您的 MCP 服务器。
{ "serverName": "Gauntlet Incept MCP Server", "command": "npm", "args": [ "run", "mcp" ], "protocol": "stdio", "description": "Gauntlet Incept 教育内容生成 MCP 服务器" }
配置说明:
- 'serverName': MCP 服务器的名称,可以自定义,用于在 MCP 客户端中识别和显示。
- 'command': 启动 MCP 服务器的命令,这里使用 'npm',假设您已通过 'npm install' 安装了项目依赖并在项目根目录下运行。
- 'args': 传递给 'command' 的参数数组,这里使用 'run mcp' 来执行 'package.json' 中定义的 'mcp' 脚本,该脚本应该启动 'src/mcp-server.js' 文件。
- 'protocol': 指定 MCP 客户端与服务器通信的协议,这里使用 'stdio',即标准输入输出流协议。
- 'description': MCP 服务器的描述信息,用于在 MCP 客户端界面上提供更多信息。
注意: 请确保您的 Node.js 环境配置正确,并且在 MCP 客户端配置的 'command' 和 'args' 能够成功启动 Gauntlet Incept MCP 服务器。您可能需要根据您的具体环境和 'package.json' 中的 scripts 配置调整 'command' 和 'args'。
基本使用方法
- 启动 MCP 服务器: 按照上述安装步骤启动 Gauntlet Incept MCP 服务器。
- 配置 MCP 客户端: 在支持 MCP 协议的 LLM 客户端(如 Claude Desktop)中,导入上述提供的服务器配置信息。
- 连接服务器: 在 MCP 客户端中选择 "Gauntlet Incept MCP Server" 并建立连接。
- 使用工具和资源: 连接成功后,您应该可以在 MCP 客户端中看到 Gauntlet Incept MCP 服务器提供的工具和资源。您可以调用这些工具来生成、标注和评估教育内容,并访问服务器提供的教育资源。 例如,您可以调用 'generateQuestion' 工具来生成题目,或使用 'searchExamples' 工具来搜索数据库中的示例内容。
信息
分类
AI与计算