Canvas Lms MCP

🚀 Canvas LMS MCP サーバー

Canvas LMS MCP サーバーは、Canvas LMS と連携するためのサーバーです。このサーバーを使用することで、Canvas LMS のコース情報や課題情報を取得することができます。

🚀 クイックスタート

Canvas LMS MCP サーバーを使用するには、まずサーバーをインストールして構成する必要があります。以下の手順に従って操作してください。

✨ 主な機能

• Unix-like システムでの動作が可能
• Python 3.8 以上で動作
• Canvas LMS のコース情報や課題情報を取得可能
• Cursor IDE との統合が可能

📦 インストール

環境要件

• オペレーティングシステム: 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

使用方法

一般的なコマンド

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 ファイルを参照してください。