MCP Server Canvas

🚀 キャンバス MCP サーバー

Canvas LMS API の Model Context Protocol (MCP) サーバーの実装です。このサーバーは、Canvas LMS ユーティリティとのインタラクション機能を提供します。

✨ 主な機能

• Canvas LMS 内のコースを一覧表示し、enrollment_type でのフィルタリングが可能
• ツールの使用に関するインタラクティブなヘルプヒントを提供

📦 インストール

前提条件

• Node.js 18 以上
• Canvas LMS インスタンス
• Canvas API アクセストークン
• Cursor（クライアント統合に使用）

セットアップ手順

1. このリポジトリをクローンします。
2. 依存関係をインストールします。

   npm install
   

3. 環境変数を設定します。

   export CANVAS_BASE_URL="https://your-canvas-instance.com"
   export CANVAS_ACCESS_TOKEN="your-api-token"
   

4. プロジェクトをビルドします。

   npm run build
   

5. サーバーを起動します。

   npm start
   

💻 使用例

Cursor との接続

この MCP サーバーを Cursor で使用するには、以下の手順を実行します。

1. Cursor の設定を開きます。
2. MCP 設定セクションに移動します。
3. 新しいサーバー設定を追加します。

   {
     "mcpServers": {
       "canvas": {
         "command": "npm",
         "args": [
           "start"
         ],
         "cwd": "/path/to/mcp-server-canvas"
       }
     }
   }
   

4. 設定を保存し、Cursor を再起動します。
5. これで、Canvas ツールが Cursor の MCP ツールパネルで使用可能になります。

利用可能なツール

list_courses

Canvas LMS 内のすべてのコースを一覧表示します。

パラメーター：

• enrollment_type（オプション）：選択した登録タイプ（教師、学生、TA）でコースをフィルタリングします。

応答例：

{
  "content": [
    {
      "type": "text",
      "text": [
        {
          "id": 1234,
          "name": "示例课程",
          "code": "EX101",
          "state": "可用",
          "startDate": "2024-01-01T00:00:00Z",
          "endDate": "2024-12-31T23:59:59Z"
        }
      ]
    }
  ]
}

list-courses-help

list_courses ツールの使用を支援するためのインタラクティブなヒントを提供します。

🔧 技術詳細

このサーバーは TypeScript と MCP SDK を使用して構築されています。新しい機能を追加するには、以下の手順を実行します。

1. CanvasAPI クラスに新しい API メソッドを追加します。
2. server.tool() を使用して新しいツールを登録します。
3. server.prompt() を使用してインタラクティブなヒントを登録します。
4. 変更をビルドしてテストします。

📚 ドキュメント

トラブルシューティング

問題が発生した場合は、以下の手順を試してください。

1. 環境変数が正しく設定されていることを確認します。
2. Canvas API トークンが必要なアクセス許可を持っていることを確認します。
3. Cursor の MCP サーバーログにエラーメッセージがあるか確認します。
4. Cursor 設定内のサーバーパスが正しいことを確認します。

📄 ライセンス

MIT