MCP Canvas Lms

🚀 Canvas MCP サーバー

このサーバーは、Canvas API とのやり取りを行うためのモデルコンテキストプロトコル (MCP) サーバーです。コース、課題、選択科目、成績の管理を行うことができます。

🚀 クイックスタート

✨ 主な機能

• コースの管理（作成、更新）
• 課題の管理（作成、更新）
• 学生の成績の提出
• ユーザーのコースへの登録

📦 インストール

前提条件

• Node.js: バージョン 18 以上
• Canvas APIトークン: Canvas アカウントから取得
• Canvas ドメイン名: 通常は canvas.instructure.com

セットアップ手順

1. リポジトリをクローンする

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

2. 依存関係をインストールする

npm install

3. 環境変数を設定する サンプル環境ファイルをコピーします。

cp .env.example .env

.env ファイルを編集し、実際の Canvas API トークンとドメイン名でプレースホルダーを置き換えます。 プロジェクトをビルドします。

npm run build

4. サーバーを起動する

npm start

サーバーが起動し、標準入出力を通じて MCP リクエストを待ち受けます。

Claude Desktop への接続

1. Claude の設定を更新する claude_desktop_config.json に MCP サーバーの設定を追加します。

  "canvas-mcp-server": {
      "command": "npx",
      "args": ["-y", "canvas-mcp-server"]
    },

2. Claude Desktop を再起動する Claude Desktop を完全に終了し、再度起動します。 🔌 メニューから Canvas MCP サーバーを見つけて接続します。

💻 使用例

利用可能なツール（学生向けの機能が今後追加予定）

• canvas_create_course: Canvas で新しいコースを作成します。
• canvas_update_course: 既存のコースを更新します。
• canvas_create_assignment: Canvas コースで新しい課題を作成します。
• canvas_update_assignment: 既存の課題を更新します。
• canvas_submit_grade: 学生の課題の成績を提出します。
• canvas_enroll_user: ユーザーをコースに登録します。

エラー処理

ツールは isError: true を含むエラーメッセージを返すことで問題を示します。 実行時エラーを避けるために、すべての必須環境変数が設定されていることを確認してください。

トラブルシューティング

• ビルドエラー TypeScript のバージョンを確認します。npx tsc --version ビルドをクリーンアップして再実行します。rm -rf build/ && npm run build
• 実行時エラー ログを確認して詳細なエラーメッセージを取得します。 環境変数が正しく設定されていることを確認します。
• 型エラー TypeScript の型チェックを使用して型を検証します。npx tsc --noEmit

貢献

貢献を歓迎します！改善点やエラー修正に関する問題を開くか、プルリクエストを送信してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。

追加説明

• 型安全: types.ts ファイルにより、Canvas API とのすべてのやり取りが型安全になり、実行時エラーを減らし、コードの保守性を向上させます。
• エラー処理: サーバーは意味のあるメッセージを返し、isError フラグを設定することでエラーを適切に処理し、クライアント（例: Claude Desktop）が理解しやすくなります。
• 環境変数: 環境変数を使用して機密情報（API トークンなど）を管理することで、セキュリティを強化し、異なる環境間での柔軟性を高めます。
• モジュール化: types.ts、client.ts、index.ts などの異なるファイルに関心事を分割することで、コードベースのナビゲーションと保守が容易になります。

プロジェクトの具体的な要件に応じて、ファイルパスや設定を自由に調整してください。ご質問があれば、お気軽にお問い合わせください！