eClass MCP服务器使用说明

项目简介

eClass MCP服务器是一个基于Model Context Protocol (MCP) 构建的后端应用,旨在为AI助手提供与Open eClass (特别是雅典大学的eClass平台) 交互的能力。通过此服务器,AI助手可以安全地访问eClass平台的功能,例如获取课程信息,而无需直接处理用户的敏感凭据。

主要功能点

  • SSO身份验证: 通过雅典大学的统一身份认证系统 (SSO) 登录 eClass 平台。
  • 课程管理: 获取用户在 eClass 平台上注册的课程列表。
  • 会话管理: 在多次工具调用之间保持用户的登录会话状态。
  • 身份状态检查: 验证当前服务器的身份验证状态。

安装步骤

  1. 克隆仓库

    git clone https://github.com/sdi2200262/eclass-mcp-server.git
    cd eclass-mcp-server
  2. 安装依赖 推荐使用 'uv' (如果已安装):

    uv sync --dev --all-extras

    或者使用 'pip':

    pip install -e .
  3. 配置服务器 在项目根目录下创建 '.env' 文件,并根据 'example.env' 文件的示例进行配置。你需要设置以下环境变量:

    ECLASS_URL=你的eClass平台URL (例如: https://eclass.uoa.gr)
    ECLASS_USERNAME=你的eClass用户名
    ECLASS_PASSWORD=你的eClass密码

    注意: 凭据信息必须配置在 '.env' 文件中,服务器不会接受作为参数传递的凭据。

服务器配置 (MCP客户端)

在你的MCP客户端 (例如 Cursor, Claude Desktop) 中添加新的MCP服务器配置。以下是配置信息示例 (JSON 格式,但你通常只需要在客户端界面中填写):

{
  "server name": "eClass Server",
  "type": "command",
  "command": "python /path/to/eclass-mcp-server/run_server.py"
}
  • server name: 为你的服务器指定一个易于识别的名称,例如 "eClass Server"。这将帮助AI助手理解服务器的用途。
  • type: 选择 "command" 类型,表明服务器通过命令行启动。
  • command: 这是启动 eClass MCP 服务器的关键命令。你需要将 '/path/to/eclass-mcp-server/run_server.py' 替换为 'run_server.py' 脚本在你本地文件系统中的绝对路径。例如,如果你的 'eclass-mcp-server' 仓库克隆在用户主目录下的 'projects' 文件夹中,那么路径可能类似于 '/home/用户名/projects/eclass-mcp-server/run_server.py'。

重要: 你无需配置 'args' (参数),因为此服务器的启动脚本不需要额外的命令行参数。

基本使用方法

  1. 启动服务器: 按照上述 "服务器配置 (MCP客户端)" 中的 'command' 配置,MCP客户端将负责启动服务器。或者,你也可以在终端中手动运行 'python run_server.py' 或 'python -m src.eclass_mcp_server.server' 来启动服务器。

  2. 在AI助手中使用: 在支持MCP协议的AI助手 (例如 Cursor, Claude Desktop) 中,选择你配置的 "eClass Server",即可调用服务器提供的工具。

    服务器提供了以下工具 (Tools):

    • 'login': 登录 eClass 平台。
    • 'get_courses': 获取已注册课程列表。
    • 'logout': 退出登录。
    • 'authstatus': 检查身份验证状态。

    这些工具可以通过MCP客户端以标准化的方式调用,从而让AI助手能够理解和操作 eClass 平台的相关功能。

安全性说明: 此服务器设计注重安全性,凭据仅存储在本地 '.env' 文件中,不会通过参数传递给AI客户端,从而保护用户敏感信息。

信息

分类

生产力应用