{"_id":"@iflow-mcp/mcp-canvas-lms","name":"@iflow-mcp/mcp-canvas-lms","dist-tags":{"latest":"2.2.3"},"versions":{"2.2.3":{"name":"@iflow-mcp/mcp-canvas-lms","version":"2.2.3","description":"A comprehensive Model Context Protocol (MCP) server for Canvas LMS with full student functionality and account management","type":"module","main":"build/index.js","bin":{"canvas-mcp-server":"build/index.js"},"mcp":{"server":{"command":"node","args":["./build/index.js"]}},"scripts":{"build":"tsc","build:watch":"tsc --watch","start":"node build/index.js","dev":"npm run build && npm run start","dev:watch":"concurrently \"npm run build:watch\" \"nodemon build/index.js\"","test":"vitest","test:unit":"vitest --run tests/","test:integration":"vitest --run tests/integration.test.ts","test:watch":"vitest --watch","coverage":"vitest --run --coverage","lint":"eslint src tests --ext .ts,.js","lint:fix":"eslint src tests --ext .ts,.js --fix","format":"prettier --write \"src/**/*.{ts,js,json}\" \"tests/**/*.{ts,js,json}\"","format:check":"prettier --check \"src/**/*.{ts,js,json}\" \"tests/**/*.{ts,js,json}\"","type-check":"tsc --noEmit","clean":"rimraf build coverage .nyc_output","docker:build":"docker build -t canvas-mcp:latest .","docker:run":"docker run --env-file .env canvas-mcp:latest","docker:compose:up":"docker-compose up -d","docker:compose:down":"docker-compose down","docker:compose:logs":"docker-compose logs -f","health-check":"./scripts/health-check.sh","deploy":"./scripts/deploy.sh","inspector":"npx @modelcontextprotocol/inspector build/index.js","publish":"npm run build","release":"./release.sh","release:dry-run":"echo 'Dry run mode - no actual publishing' && npm run build && npm run type-check","precommit":"npm run lint && npm run type-check && npm run test:unit"},"repository":{"type":"git","url":"git+https://github.com/DMontgomery40/mcp-canvas-lms.git"},"keywords":["canvas","lms","mcp","server","modelcontextprotocol","education","api","student","learning","assignments","courses"],"author":{"name":"David Montgomery","email":"dmontg@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/DMontgomery40/mcp-canvas-lms/issues"},"homepage":"https://github.com/DMontgomery40/mcp-canvas-lms#readme","engines":{"node":">=18.0.0","npm":">=8.0.0"},"dependencies":{"@modelcontextprotocol/sdk":"^1.20.2","axios":"^1.7.2","dotenv":"^16.4.7","zod":"^3.25.76"},"devDependencies":{"@types/node":"^20.11.24","@typescript-eslint/eslint-plugin":"^7.18.0","@typescript-eslint/parser":"^7.18.0","@vitest/coverage-v8":"^1.6.0","concurrently":"^8.2.2","eslint":"^8.57.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","husky":"^9.0.11","lint-staged":"^15.2.2","nodemon":"^3.1.0","prettier":"^3.2.5","rimraf":"^5.0.5","typescript":"^5.4.5","vitest":"^1.6.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@iflow-mcp/mcp-canvas-lms@2.2.3","gitHead":"b5ea6d100fe52ade0086f17a36827cad79fad20d","types":"./build/index.d.ts","_nodeVersion":"24.8.0","_npmVersion":"11.6.0","dist":{"integrity":"sha512-IUYWSJtsrSHMvyNzR185PZ1LmPx918ZQSodJiEVy2XM+iO4coyeCspRUyoGdacwFATjX65TOyJr7cfGa41/bQA==","shasum":"d68fbd72c5bfb5c199d2e2ac666c622f59e5f078","tarball":"https://registry.npmjs.org/@iflow-mcp/mcp-canvas-lms/-/mcp-canvas-lms-2.2.3.tgz","fileCount":8,"unpackedSize":126602,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIH543py1JTt7Ld8VO14y0nfnPsgY358xflCC6rF4ULlgAiEA41qsUXF9P8lkwU4DVShIb97scTHi+z9saYGxf2Xwz00="}]},"_npmUser":{"name":"chatflowdev","email":"chatflowdev@gmail.com"},"directories":{},"maintainers":[{"name":"chatflowdev","email":"chatflowdev@gmail.com"},{"name":"qystart","email":"987472953@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-canvas-lms_2.2.3_1761289889852_0.5971571154631048"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-24T07:11:29.780Z","2.2.3":"2025-10-24T07:11:30.033Z","modified":"2025-10-24T07:11:30.483Z"},"maintainers":[{"name":"chatflowdev","email":"chatflowdev@gmail.com"},{"name":"qystart","email":"987472953@qq.com"}],"description":"A comprehensive Model Context Protocol (MCP) server for Canvas LMS with full student functionality and account management","homepage":"https://github.com/DMontgomery40/mcp-canvas-lms#readme","keywords":["canvas","lms","mcp","server","modelcontextprotocol","education","api","student","learning","assignments","courses"],"repository":{"type":"git","url":"git+https://github.com/DMontgomery40/mcp-canvas-lms.git"},"author":{"name":"David Montgomery","email":"dmontg@gmail.com"},"bugs":{"url":"https://github.com/DMontgomery40/mcp-canvas-lms/issues"},"license":"MIT","readme":"# Canvas MCP Server v2.2.0\n\n> A comprehensive Model Context Protocol (MCP) server for Canvas LMS with complete student, instructor, and account administration functionality\n\n## 🚀 What's New in v2.2.0\n\n- **🔧 FIXED**: Course creation \"page not found\" error (missing `account_id` parameter)\n- **👨‍💼 Account Management**: Complete account-level administration tools\n- **📊 Reports & Analytics**: Generate and access Canvas account reports  \n- **👥 User Management**: Create and manage users at the account level\n- **🏢 Multi-Account Support**: Handle account hierarchies and sub-accounts\n- **✅ API Compliance**: All endpoints now follow proper Canvas API patterns\n\n## 🎯 Key Features\n\n### 🎓 For Students\n- **Course Management**: Access all courses, syllabi, and course materials\n- **Assignment Workflow**: View, submit (text/URL/files), and track assignments\n- **Communication**: Participate in discussions, read announcements, send messages\n- **Progress Tracking**: Monitor grades, module completion, and calendar events\n- **Quizzes**: Take quizzes, view results and feedback\n- **File Access**: Browse and download course files and resources\n\n### 👨‍🏫 For Instructors\n- **Course Creation**: Create and manage course structure *(now with proper account support)*\n- **Grading**: Grade submissions, provide feedback, manage rubrics\n- **User Management**: Enroll students, manage permissions\n- **Content Management**: Create assignments, quizzes, discussions\n\n### 👨‍💼 For Account Administrators (NEW!)\n- **Account Management**: Manage institutional Canvas accounts\n- **User Administration**: Create and manage users across accounts\n- **Course Oversight**: List and manage all courses within accounts\n- **Reporting**: Generate enrollment, grade, and activity reports\n- **Sub-Account Management**: Handle account hierarchies and structures\n\n### 🛠️ Technical Excellence\n- **Robust API**: Automatic retries, pagination, comprehensive error handling\n- **Cloud Ready**: Docker containers, Kubernetes manifests, health checks\n- **Well Tested**: Unit tests, integration tests, mocking, coverage reports\n- **Type Safe**: Full TypeScript implementation with strict types\n- **50+ Tools**: Comprehensive coverage of Canvas LMS functionality\n\n## Quick Start\n\n### Option 1: Claude Desktop Integration (Recommended MCP Setup)\n\nAdd to `claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"canvas-mcp-server\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"canvas-mcp-server\"],\n      \"env\": {\n        \"CANVAS_API_TOKEN\": \"your_token_here\",\n        \"CANVAS_DOMAIN\": \"your_school.instructure.com\"\n      }\n    }\n  }\n}\n```\n\n### Option 2: NPM Package\n\n```bash\n# Install globally\nnpm install -g canvas-mcp-server\n\n# Configure\nexport CANVAS_API_TOKEN=\"your_token_here\"\nexport CANVAS_DOMAIN=\"your_school.instructure.com\"\n\n# Run\ncanvas-mcp-server\n```\n\n### Option 3: Docker\n\n```bash\ndocker run -d \\\n  --name canvas-mcp \\\n  -e CANVAS_API_TOKEN=\"your_token\" \\\n  -e CANVAS_DOMAIN=\"school.instructure.com\" \\\n  ghcr.io/dmontgomery40/mcp-canvas-lms:latest\n```\n\n## 💼 Account Admin Workflow Examples\n\n### Create a New Course (FIXED!)\n```\n\"Create a new course called 'Advanced Biology' in account 123\"\n```\n**Now properly creates courses with required account_id parameter**\n\n### Manage Users\n```\n\"Create a new student user John Doe with email john.doe@school.edu in our main account\"\n```\n**Creates user accounts with proper pseudonym and enrollment setup**\n\n### Generate Reports\n```\n\"Generate an enrollment report for account 456 for the current term\"\n```\n**Initiates Canvas reporting system for institutional analytics**\n\n### List Account Courses\n```\n\"Show me all published Computer Science courses in our Engineering account\"\n```\n**Advanced filtering and searching across account course catalogs**\n\n## 🎓 Student Workflow Examples\n\n### Check Today's Assignments\n```\n\"What assignments do I have due this week?\"\n```\n**Lists upcoming assignments with due dates, points, and submission status**\n\n### Submit an Assignment\n```\n\"Help me submit my essay for English 101 Assignment 3\"\n```\n**Guides through text submission with formatting options**\n\n### Check Grades\n```\n\"What's my current grade in Biology?\"\n```\n**Shows current scores, grades, and assignment feedback**\n\n### Participate in Discussions\n```\n\"Show me the latest discussion posts in my Philosophy class\"\n```\n**Displays recent discussion topics and enables posting responses**\n\n### Track Progress\n```\n\"What modules do I need to complete in Math 200?\"\n```\n**Shows module completion status and next items to complete**\n\n## Getting Canvas API Token\n\n1. **Log into Canvas** → Account → Settings\n2. **Scroll to \"Approved Integrations\"**\n3. **Click \"+ New Access Token\"**\n4. **Enter description**: \"Claude MCP Integration\"\n5. **Copy the generated token** Save securely!\n\n⚠️ **Account Admin Note**: For account-level operations, ensure your API token has administrative privileges.\n\n## Production Deployment\n\n### Docker Compose\n```bash\ngit clone https://github.com/DMontgomery40/mcp-canvas-lms.git\ncd mcp-canvas-lms\ncp .env.example .env\n# Edit .env with your Canvas credentials\ndocker-compose up -d\n```\n\n### Kubernetes\n```bash\nkubectl create secret generic canvas-mcp-secrets \\\n  --from-literal=CANVAS_API_TOKEN=\"your_token\" \\\n  --from-literal=CANVAS_DOMAIN=\"school.instructure.com\"\n\nkubectl apply -f k8s/\n```\n\n### Health Monitoring\n```bash\n# Check application health\ncurl http://localhost:3000/health\n\n# Or use the built-in health check\nnpm run health-check\n```\n\n## Development\n\n```bash\n# Setup development environment\ngit clone https://github.com/DMontgomery40/mcp-canvas-lms.git\ncd mcp-canvas-lms\nnpm install\n\n# Start development with hot reload\nnpm run dev:watch\n\n# Run tests\nnpm run test\nnpm run coverage\n\n# Code quality\nnpm run lint\nnpm run type-check\n```\n\n## 📚 Available Tools (50+ Tools)\n\n<details>\n<summary><strong>🎓 Core Student Tools (Click to expand)</strong></summary>\n\n- `canvas_health_check` - Check API connectivity\n- `canvas_list_courses` - List all your courses\n- `canvas_get_course` - Get detailed course info\n- `canvas_list_assignments` - List course assignments\n- `canvas_get_assignment` - Get assignment details\n- `canvas_submit_assignment` - Submit assignment work\n- `canvas_get_submission` - Check submission status\n- `canvas_list_modules` - List course modules\n- `canvas_get_module` - Get module details\n- `canvas_list_module_items` - List items in a module\n- `canvas_mark_module_item_complete` - Mark items complete\n- `canvas_list_discussion_topics` - List discussion topics\n- `canvas_get_discussion_topic` - Get discussion details\n- `canvas_post_to_discussion` - Post to discussions\n- `canvas_list_announcements` - List course announcements\n- `canvas_get_user_grades` - Get your grades\n- `canvas_get_course_grades` - Get course-specific grades\n- `canvas_get_dashboard` - Get dashboard info\n- `canvas_get_dashboard_cards` - Get course cards\n- `canvas_get_upcoming_assignments` - Get due dates\n- `canvas_list_calendar_events` - List calendar events\n- `canvas_list_files` - List course files\n- `canvas_get_file` - Get file details\n- `canvas_list_folders` - List course folders\n- `canvas_list_pages` - List course pages\n- `canvas_get_page` - Get page content\n- `canvas_list_conversations` - List messages\n- `canvas_get_conversation` - Get conversation details\n- `canvas_create_conversation` - Send messages\n- `canvas_list_notifications` - List notifications\n- `canvas_get_syllabus` - Get course syllabus\n- `canvas_get_user_profile` - Get user profile\n- `canvas_update_user_profile` - Update profile\n\n</details>\n\n<details>\n<summary><strong>👨‍🏫 Instructor Tools (Click to expand)</strong></summary>\n\n- `canvas_create_course` - Create new courses *(FIXED: now requires account_id)*\n- `canvas_update_course` - Update course settings\n- `canvas_create_assignment` - Create assignments\n- `canvas_update_assignment` - Update assignments\n- `canvas_list_assignment_groups` - List assignment groups\n- `canvas_submit_grade` - Grade submissions\n- `canvas_enroll_user` - Enroll students\n- `canvas_list_quizzes` - List course quizzes\n- `canvas_get_quiz` - Get quiz details\n- `canvas_create_quiz` - Create quizzes\n- `canvas_start_quiz_attempt` - Start quiz attempts\n- `canvas_list_rubrics` - List course rubrics\n- `canvas_get_rubric` - Get rubric details\n\n</details>\n\n<details>\n<summary><strong>👨‍💼 Account Management Tools (NEW!)</strong></summary>\n\n- `canvas_get_account` - Get account details\n- `canvas_list_account_courses` - List courses in an account\n- `canvas_list_account_users` - List users in an account  \n- `canvas_create_user` - Create new users in accounts\n- `canvas_list_sub_accounts` - List sub-accounts\n- `canvas_get_account_reports` - List available reports\n- `canvas_create_account_report` - Generate account reports\n\n</details>\n\n## 🔧 Breaking Changes in v2.2.0\n\n### Course Creation Fix\n**BEFORE (Broken):**\n```javascript\n{\n  \"tool\": \"canvas_create_course\",\n  \"arguments\": {\n    \"name\": \"My Course\"  // ❌ Missing account_id - caused \"page not found\"\n  }\n}\n```\n\n**AFTER (Fixed):**\n```javascript\n{\n  \"tool\": \"canvas_create_course\", \n  \"arguments\": {\n    \"account_id\": 123,              // ✅ Required account_id\n    \"name\": \"My Course\",\n    \"course_code\": \"CS-101\"\n  }\n}\n```\n\n## 🌟 Example Claude Conversations\n\n**Student**: *\"I need to check my upcoming assignments and submit my English essay\"*\n\n**Claude**: *I'll help you check your upcoming assignments and then assist with submitting your English essay. Let me start by getting your upcoming assignments...*\n\n[Claude uses `canvas_get_upcoming_assignments` then helps with `canvas_submit_assignment`]\n\n---\n\n**Instructor**: *\"Create a new Advanced Physics course in the Science department and enroll my teaching assistant\"*\n\n**Claude**: *I'll help you create the Advanced Physics course in your Science department account and then enroll your TA...*\n\n[Claude uses `canvas_create_course` with proper account_id, then `canvas_enroll_user`]\n\n---\n\n**Administrator**: *\"Generate an enrollment report for all Computer Science courses this semester\"*\n\n**Claude**: *I'll generate a comprehensive enrollment report for your CS courses...*\n\n[Claude uses `canvas_list_account_courses` with filters, then `canvas_create_account_report`]\n\n## 🔍 Troubleshooting\n\n**Common Issues:**\n- ❌ **401 Unauthorized**: Check your API token and permissions\n- ❌ **404 Not Found**: Verify course/assignment IDs and access rights  \n- ❌ **\"Page not found\" on course creation**: Update to v2.2.0 for account_id fix\n- ❌ **Timeout**: Increase `CANVAS_TIMEOUT` or check network connectivity\n\n**Debug Mode:**\n```bash\nexport LOG_LEVEL=debug\nnpm start\n```\n\n**Health Check:**\n```bash\nnpm run health-check\n```\n\n## 🤝 Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n### Quick Contribution Setup\n```bash\ngit clone https://github.com/DMontgomery40/mcp-canvas-lms.git\ncd mcp-canvas-lms\nnpm install\nnpm run dev:watch\n# Make changes, add tests, submit PR\n```\n\n## 📈 Roadmap\n\n- **v2.3**: Enhanced reporting, bulk operations, advanced search\n- **v2.4**: Mobile support, offline capability, analytics dashboard  \n- **v3.0**: Multi-tenant, GraphQL API, AI-powered insights\n\n## 🙋 Support & Community\n\n- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/DMontgomery40/mcp-canvas-lms/issues)\n- 💬 **Questions**: [GitHub Discussions](https://github.com/DMontgomery40/mcp-canvas-lms/discussions)\n- 📖 **Documentation**: [Wiki](https://github.com/DMontgomery40/mcp-canvas-lms/wiki)\n\n## 📄 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n---\n\n<div align=\"center\">\n  <strong>Canvas MCP Server v2.2.0</strong><br>\n  <em>Empowering students, educators, and administrators with seamless Canvas integration</em><br><br>\n  \n  ⭐ **Star this repo if it helps you!** ⭐\n</div>\n","readmeFilename":"README.md","_rev":"1-98e7084e8fbc7d02dbb857cf25ac1901"}