项目简介
本项目是一个 MCP (Model Context Protocol) 服务器,旨在帮助大型语言模型(LLM)客户端,如 Claude,便捷地访问 Google Classroom 中的数据。通过此服务器,LLM 可以获取课程信息、课程公告、以及学生的作业情况,从而实现更智能的教育辅助应用。
主要功能点
- 列出课程 (courses): 获取用户在 Google Classroom 中创建或加入的所有课程列表。
- 课程详情 (course-details): 查询特定课程的详细信息,包括课程公告。
- 作业列表 (assignments): 获取特定课程的作业列表以及学生的提交状态。
安装步骤
-
克隆仓库:
git clone https://github.com/faizan45640/google-classroom-mcp-server.git cd google-classroom-mcp-server -
安装依赖: 确保已安装 Node.js (v16 或更高版本) 和 npm。运行以下命令安装项目依赖:
npm install -
配置 Google OAuth 客户端凭据:
- 前往 Google Cloud Console 创建或选择一个项目。
- 启用 Google Classroom API。
- 创建 OAuth 2.0 客户端凭据,下载 'credentials.json' 文件,并将其放置在项目根目录下。
-
用户认证: 运行以下命令进行 Google 账号认证,并授权访问 Google Classroom 数据:
node index.js auth该命令将打开浏览器窗口,引导您完成 OAuth 认证流程。认证成功后,凭据信息将保存到 'tokens.json' 文件中。
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude),您需要提供服务器的启动命令和参数。以下是配置示例,请根据您的实际情况修改路径:
{ "mcpServers": { "classroom": { "command": "node", "args": [ "PATH_TO_YOUR_DIRECTORY/index.js" ] } } }
配置参数说明:
- 'server name': 'classroom' (服务器名称,可以自定义,客户端通过此名称识别服务器)
- 'command': 'node' (启动服务器的命令,通常为 Node.js 解释器)
- 'args':
- '"PATH_TO_YOUR_DIRECTORY/index.js"': 'index.js' 文件在您本地文件系统中的绝对路径。请将 'PATH_TO_YOUR_DIRECTORY' 替换为实际的目录路径。例如,如果您的项目放在 'C:\projects\google-classroom-mcp-server',则应修改为 '"C:\projects\google-classroom-mcp-server\index.js"' (注意Windows路径中的反斜杠需要转义)。
基本使用方法
配置完成后,在 MCP 客户端中,您可以使用以下工具与 Google Classroom 进行交互:
- 使用 'courses' 工具列出所有课程。
- 使用 'course-details' 工具并提供 'courseId' 参数查询课程详情。
- 使用 'assignments' 工具并提供 'courseId' 参数查询课程作业。
例如,在 Claude 中,您可以尝试以下 Prompt:
- 'Show me all my Google Classroom courses' (使用 'courses' 工具)
- 'Get details for course with ID 123456789' (使用 'course-details' 工具, 'courseId' 为 '123456789')
- 'Show me assignments for course ID 987654321' (使用 'assignments' 工具, 'courseId' 为 '987654321')
请确保在提问时使用正确的工具名称和参数,以便 LLM 客户端能够正确调用 MCP 服务器的功能。
信息
分类
生产力应用