Canvas Lms MCP

🚀 Canvas LMS MCP Server

The Canvas LMS MCP Server is a tool designed to interact with the Canvas LMS platform, enabling users to perform various operations such as listing courses and retrieving course information.

🚀 Quick Start

This guide will walk you through the steps to install, configure, and run the Canvas LMS MCP Server.

📦 Installation

Environment Requirements

• Operating System: Unix-like systems (e.g., Linux or macOS) are supported.
• Python Version: Python 3.8 or higher is required.
• Dependencies: The requests and canvasapi libraries must be installed.

Installation Steps

1. Clone this repository to your local machine:

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

2. Install the dependencies:

   pip install requests canvasapi
   

🛠️ Configuration

Environment Variable Setup

Create a .env file in the root directory of the project and add the following content, replacing the values with your actual information:

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

▶️ Running the Server

Start the MCP server:

python mcp_server.py

💻 Usage Examples

Common Commands

1. List Courses:

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

2. Get Information for a Specific Course:

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

🔌 Integration with Cursor

Quick Start

1. Install and launch Cursor IDE.
2. Create a .cursor/mcp.json file in the project directory and add the following content:

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

Example Usage

• Query upcoming assignments:

  What assignments are due soon?
  

• View detailed information for a specific course:

  Show me the detailed information for course CS101.
  

🛠️ Development Guide

Contribution Process

1. Clone the Repository:

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

2. Create a Feature Branch:

   git checkout -b feature/new-feature
   

3. Commit Your Changes:

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

Code Style

• Follow the PEP8 coding style.
• Provide detailed docstrings and comments.

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.