Canvas Lms MCP

🚀 Canvas LMS MCP 服务器

Canvas LMS MCP 服务器是一个用于与 Canvas LMS 系统交互的工具，它可以帮助用户方便地获取课程信息、作业信息等。通过简单的配置和操作，就能快速集成到开发环境中。

🚀 快速开始

环境要求

• 操作系统：支持 Unix-like 系统（如 Linux 或 macOS）
• Python 版本：Python 3.8 或更高版本
• 依赖项：必须安装 requests 和 canvasapi 库

安装步骤

1. 克隆此仓库到本地：

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

2. 安装依赖项：

   pip install requests canvasapi
   

配置

环境变量设置

在项目的根目录下创建一个 .env 文件，添加以下内容并替换为实际值：

CANVAS_API_TOKEN=your_api_token_here
CANVAS_BASE_URL=https://yourinstitution.canvaslms.com

运行服务器

启动 MCP 服务器：

python mcp_server.py

✨ 主要特性

• 支持列出课程和获取特定课程信息。
• 可与 Cursor IDE 集成，方便开发。
• 遵循标准的 Python 编码规范，便于贡献和维护。

📦 安装指南

环境要求

• 操作系统：支持 Unix-like 系统（如 Linux 或 macOS）
• Python 版本：Python 3.8 或更高版本
• 依赖项：必须安装 requests 和 canvasapi 库

安装步骤

1. 克隆此仓库到本地：

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

2. 安装依赖项：

   pip install requests canvasapi
   

💻 使用示例

基础用法

常用命令

1. 列出课程：

   curl http://localhost:8000/api/courses
   

2. 获取特定课程信息：

   curl http://localhost:8000/api/courses/12345
   

高级用法

与 Cursor 集成

快速开始

1. 安装并启动 Cursor IDE
2. 在项目目录下创建 .cursor/mcp.json 文件，添加以下内容：

   {
       "mcpServers": {
           "canvas": {
               "command": "python",
               "args": ["mcp_server.py"],
               "env": {
                   "CANVAS_API_TOKEN": "your_api_token",
                   "CANVAS_BASE_URL": "https://yourinstitution.canvaslms.com"
               }
           }
       }
   }
   

示例用法

• 查询即将到期的作业：

  What assignments are due soon?
  

• 查看特定课程的详细信息：

  Show me the detailed information for course CS101.
  

📚 详细文档

开发指南

贡献流程

1. 克隆仓库：

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

2. 创建功能分支：

   git checkout -b feature/new-feature
   

3. 提交更改：

   git add .
   git commit -m "Add new functionality"
   git push origin feature/new-feature
   

代码规范

• 遵循 PEP8 编码规范。
• 提供详细的文档字符串和注释。

📄 许可证

此项目遵循 MIT 协议。更多细节请查阅 LICENSE 文件。