使用说明

项目简介

Canvas MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为 LLM (大型语言模型) 应用提供与 Canvas LMS (学习管理系统) 交互的能力。通过此服务器，LLM 应用可以安全、便捷地访问和操作 Canvas LMS 中的数据和功能，例如课程信息、作业管理、学生成绩等。

主要功能点

资源访问: 以标准化的 MCP 方式向 LLM 客户端提供 Canvas LMS 平台上的各类资源，包括课程列表、课程详情、作业列表、学生列表、成绩信息、测验、模块、讨论主题和公告等。LLM 客户端可以通过资源 URI 轻松获取所需信息。
工具调用: 注册并提供一系列实用工具，允许 LLM 客户端调用以执行 Canvas LMS 平台上的操作，例如：
- 创建和更新课程
- 创建和更新作业
- 提交学生成绩
- 学生注册课程
- 管理测验、模块、讨论和公告等
易于集成: 遵循 MCP 协议标准，使用 JSON-RPC 通信，可以通过 Stdio 标准输入输出流与 MCP 客户端连接，方便集成到各种支持 MCP 协议的 LLM 应用中，如 Claude Desktop。

安装步骤

克隆仓库

git clone https://github.com/DMontgomery40/mcp-canvas-lms.git
cd mcp-canvas-lms

安装依赖
```
npm install
```

配置环境变量 复制 '.env.example' 文件并重命名为 '.env'，然后编辑 '.env' 文件，根据您的 Canvas LMS 平台信息填写以下变量：

CANVAS_API_TOKEN=YOUR_CANVAS_API_TOKEN  # 您的 Canvas API 访问令牌
CANVAS_DOMAIN=YOUR_CANVAS_DOMAIN       # 您的 Canvas LMS 域名，例如 canvas.instructure.com

注意: 'CANVAS_API_TOKEN' 需要您在 Canvas LMS 平台上创建并获取。'CANVAS_DOMAIN' 通常是您的机构或学校的 Canvas LMS 域名。

构建项目
```
npm run build
```
启动服务器
```
npm start
```
服务器启动后，将通过标准输入输出流 (stdio) 监听 MCP 请求。

服务器配置

要将 Canvas MCP Server 连接到 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件中添加以下服务器配置信息。这通常是一个 JSON 格式的配置文件（例如 'claude_desktop_config.json'）：

{
  "canvas-mcp-server": {  // 服务器名称，可以自定义
    "command": "npx",    // 启动服务器的命令，这里使用 npx 执行 node_modules/.bin 目录下的 canvas-mcp-server 脚本
    "args": ["-y", "canvas-mcp-server"] // 命令参数，-y 参数用于自动确认 npx 的安装提示，canvas-mcp-server 是 package.json 中定义的启动脚本名称
  }
}

'server name': '"canvas-mcp-server"' - 您可以自定义此名称，用于在 MCP 客户端中标识和管理此服务器连接。
'command': '"npx"' - 指定用于启动服务器的命令。'npx' 是 npm 包执行器，可以方便地运行本地安装的 npm 包的可执行文件。
'args': '["-y", "canvas-mcp-server"]' - 传递给 'command' 的参数列表。
- '"-y"': 'npx' 的参数，用于跳过安装包时的确认提示。
- '"canvas-mcp-server"': 在 'package.json' 文件中定义的启动脚本名称，'npm start' 命令实际执行的就是这个脚本。

基本使用方法

确保 Canvas MCP Server 已经成功启动并运行。
打开您的 MCP 客户端（如 Claude Desktop），进入服务器配置页面。
根据上述 “服务器配置” 部分提供的信息，在客户端中添加并配置 Canvas MCP Server 连接。
连接成功后，您可以在客户端的界面中：
- 浏览资源: 在资源管理或类似菜单中，您应该能看到 Canvas LMS 平台提供的各种资源，例如课程列表、作业列表等。选择资源即可查看详细信息。
- 调用工具: 在工具调用或类似菜单中，您可以使用 Canvas MCP Server 提供的各种工具，例如创建课程、提交成绩等。根据工具的参数提示填写必要信息并执行工具。

注意: 首次使用前请务必仔细阅读仓库的 README.md 文件，以获取更详细的安装和配置指南，以及最新的工具列表和使用说明。

关键词