项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在连接人工智能助手（如 Cursor）与 Canvas 学习管理系统（LMS）。它允许 AI 方便地访问您的 Canvas 数据，例如课程、作业、测验等，从而增强 AI 助手在教育领域的实用性。

主要功能点

该服务器提供了以下核心功能，允许连接的 AI 助手获取 Canvas LMS 中的教育信息：

• 获取您当前课程的列表及详细信息。
• 获取特定课程的教学大纲。
• 获取特定课程的模块列表。
• 列出特定课程或文件夹下的文件。
• 获取特定课程的作业列表及详细信息。
• 获取特定课程的测验列表及详细信息。
• 获取您个人的日程或计划项列表。

安装步骤

安装 Canvas LMS MCP 服务器的推荐方法是使用 'uvx' 工具，它能在一个隔离的环境中运行应用。

1. 安装前提:

   • 需要安装 Python 3.13 或更高版本。
   • 您需要一个 Canvas LMS API Token 来授权访问您的数据。请在您的 Canvas 账户设置中生成。
   • 推荐安装 'uv' 包管理器（如果未安装 'uv'，'uvx' 会自动下载）。

2. 使用 uvx 运行（推荐）:

   • 打开终端并运行以下命令：

     uvx canvas-lms-mcp
     

   • 这将自动下载并运行服务器，无需永久安装到您的系统环境中。

3. 作为 uv 工具安装:

   • 如果您希望将其永久安装到 'uv' 的工具环境中，运行：

     uv tool install canvas-lms-mcp
     

   • 安装后，可以直接通过命令 'canvas-lms-mcp' 启动服务器。

4. 从源代码安装:

   • 如果您需要从源代码进行开发或有特定需求，可以克隆仓库并使用 'uv' 或 'pip' 进行安装。详细步骤请参考项目 README。

服务器配置

此 MCP 服务器需要连接到您的 Canvas LMS 账户。关键的配置信息需要通过环境变量提供给服务器进程：

• 'CANVAS_API_TOKEN': 设置您的 Canvas API Token。这是服务器连接到 Canvas API 的凭证。
• 'CANVAS_BASE_URL': 设置您的 Canvas 机构的网址，例如 'https://your-institution.instructure.com'。如果未设置，默认为 'https://canvas.instructure.com'。

对于连接此服务器的 MCP 客户端（例如 Cursor），您需要在客户端的配置中指定如何启动这个服务器进程，并确保能将上述环境变量传递给它。通常这包括指定服务器的启动命令（例如 'uvx canvas-lms-mcp' 或 'canvas-lms-mcp'）以及传递环境变量的方式。具体的客户端配置细节请查阅您所使用 MCP 客户端的文档。

基本使用方法

一旦 Canvas LMS MCP 服务器成功启动并连接到您的 MCP 客户端（例如 AI 助手应用），您就可以通过与 AI 的自然语言对话来获取 Canvas 数据。AI 助手会识别您的意图，并通过 MCP 协议调用此服务器提供的相应工具来执行查询。

例如，您可以向 AI 助手提问：

• “我最近有什么到期的作业？”
• “请告诉我我的微积分课（或者提供课程ID）的教学大纲。”
• “列出我下周（或者指定日期范围）的全部计划项。”
• “显示我所有活跃的课程列表。”

AI 助手会利用服务器提供的工具来获取 Canvas 中的实时信息，并以友好的方式呈现给您。