Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Canvas LMS

Scalekit connector
Open markdown

The Canvas LMS connector lets your AI agent act in each user's Canvas LMS account. Each user connects their own Canvas LMS access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.

Tools
30
What they doRead · write · destructive
20 · 10 · 020 read10 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Canvas LMS connection

    In AgentKit > Connections, create a Canvas LMS connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'canvaslms'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Canvas LMS:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'canvaslms_calendar_event_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Canvas LMS credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • canvaslms_announcement_listList announcements from one or more Canvas courses within a date range.Read-only

    List Announcements

    List announcements from one or more Canvas courses within a date range. Returns an array of announcements with id, title, message, posted_at, context_code, author and html_url. Use canvaslms_announcement_list for recent announcements across courses. Use canvaslms_discussion_topic_list with only_announcements for one course without a date window.

    Inputs

    context_codesarrayrequired
    Courses to read, as course_<id> codes. Example: ["course_1234", "course_5678"].
    active_onlyboolean
    Only published, active announcements. Example: true.
    end_datestring
    Latest posted date, yyyy-mm-dd or ISO 8601. Defaults to 28 days after start_date. Example: 2026-11-30.
    latest_onlyboolean
    Return at most one (the latest) announcement per course. Example: true.
    pagestring
    Page of results to return, starting at 1. Request the next page while a full page comes back. Example: 2.
    per_pageinteger
    Number of results per page (Canvas default 10, max usually 100). Example: 50.
    start_datestring
    Earliest posted date, yyyy-mm-dd or ISO 8601. Defaults to 14 days ago. Example: 2026-11-01.
  • canvaslms_assignment_getGet one assignment in a Canvas course.Read-only

    Get Assignment

    Get one assignment in a Canvas course. Returns id, name, description, due_at, unlock_at, lock_at, points_possible, grading_type, submission_types, rubric, published and html_url. Use canvaslms_assignment_get when you have an assignment ID. Use canvaslms_assignment_list to find it.

    Inputs

    assignment_idstringrequired
    ID of the assignment, from canvaslms_assignment_list. Example: 9012.
    course_idstringrequired
    ID of the course. Get it from canvaslms_course_list (the id field) or from the course URL /courses/<id>. You can also pass an SIS ID as sis_course_id:<id>. Example: 1234.
    includearray
    Extra data. Allowed: submission, assignment_visibility, overrides, observed_users, can_edit, score_statistics. Example: ["submission"].
  • canvaslms_assignment_listList the assignments in a Canvas course, optionally filtered by a title search or a due-date bucket.Read-only

    List Assignments

    List the assignments in a Canvas course, optionally filtered by a title search or a due-date bucket. Returns an array of assignments with id, name, description, due_at, points_possible, submission_types, published, html_url and, when requested, the caller's submission. Use canvaslms_assignment_list to browse or find assignment IDs. Use canvaslms_assignment_get for one assignment.

    Inputs

    course_idstringrequired
    ID of the course. Get it from canvaslms_course_list (the id field) or from the course URL /courses/<id>. You can also pass an SIS ID as sis_course_id:<id>. Example: 1234.
    bucketstring
    Only return assignments in this due-date bucket, relative to the calling user. Allowed: past, overdue, undated, ungraded, unsubmitted, upcoming, future. Example: upcoming.one of pastoverdueundatedungradedunsubmittedupcomingfuture
    includearray
    Extra data. Allowed: submission, assignment_visibility, all_dates, overrides, observed_users, can_edit, score_statistics. Example: ["submission"].
    order_bystring
    Sort order. Allowed: position (default), name, due_at. Example: due_at.one of positionnamedue_at
    pagestring
    Page of results to return, starting at 1. Request the next page while a full page comes back. Example: 2.
    per_pageinteger
    Number of results per page (Canvas default 10, max usually 100). Example: 50.
    search_termstring
    Partial assignment title to match. Example: essay.
  • canvaslms_calendar_event_listList calendar events or assignment due dates for the user or for given courses within a date range.Read-only

    List Calendar Events

    List calendar events or assignment due dates for the user or for given courses within a date range. Returns an array of events with id, title, description, start_at, end_at, location_name, context_code, html_url and, for assignments, the nested assignment. Use canvaslms_calendar_event_list for a schedule of what is coming up. Use canvaslms_assignment_list for one course's assignments.

    Inputs

    all_eventsboolean
    Return all events and ignore the date range. Example: false.
    context_codesarray
    Calendars to read, up to 10, such as course_1234 or user_5678. Defaults to the user's own calendar. Example: ["course_1234"].
    end_datestring
    End of the range, yyyy-mm-dd or ISO 8601. Defaults to start_date. Example: 2026-11-30.
    pagestring
    Page of results to return, starting at 1. Request the next page while a full page comes back. Example: 2.
    per_pageinteger
    Number of results per page (Canvas default 10, max usually 100). Example: 50.
    start_datestring
    Start of the range, yyyy-mm-dd or ISO 8601. Defaults to today. Example: 2026-11-15.
    typestring
    event (default) for calendar events or assignment for assignment due dates. Example: assignment.one of eventassignmentsub_assignment
    undatedboolean
    Return only undated events. Example: false.
  • canvaslms_conversation_getGet one Canvas inbox conversation with all its messages.Read-only

    Get Conversation

    Get one Canvas inbox conversation with all its messages. Returns id, subject, participants and a messages array with id, author_id, body, created_at and attachments. Use canvaslms_conversation_get to read a thread. Use canvaslms_conversation_message_add to reply.

    Inputs

    conversation_idstringrequired
    ID of the conversation, from canvaslms_conversation_list. Example: 2468.
    auto_mark_as_readboolean
    Mark the conversation as read. Defaults to true. Example: false.default true
  • canvaslms_conversation_listList the authenticated user's Canvas inbox conversations, optionally limited to unread, starred, archived or sent.Read-only

    List Conversations

    List the authenticated user's Canvas inbox conversations, optionally limited to unread, starred, archived or sent. Returns an array of conversations with id, subject, workflow_state, last_message, last_message_at, message_count, participants and context_name. Use canvaslms_conversation_list to browse the inbox. Use canvaslms_conversation_get to read a conversation's messages.

    Inputs

    filterarray
    Only conversations with these users or courses, as user_<id> or course_<id>. Example: ["course_1234"].
    pagestring
    Page of results to return, starting at 1. Request the next page while a full page comes back. Example: 2.
    per_pageinteger
    Number of results per page (Canvas default 10, max usually 100). Example: 50.
    scopestring
    Which conversations. Allowed: unread, starred, archived, sent. Omit for the inbox. Example: unread.one of unreadstarredarchivedsent
  • canvaslms_course_getGet one Canvas course by ID.Read-only

    Get Course

    Get one Canvas course by ID. Returns id, name, course_code, workflow_state, start_at, end_at, default_view, time_zone and any requested include fields such as syllabus_body, term or teachers. Use canvaslms_course_get when you already have a course ID. Use canvaslms_course_list to find it.

    Inputs

    course_idstringrequired
    ID of the course. Get it from canvaslms_course_list (the id field) or from the course URL /courses/<id>. You can also pass an SIS ID as sis_course_id:<id>. Example: 1234.
    includearray
    Extra data to add, such as syllabus_body, term, teachers, total_students, sections, permissions or course_progress. Example: ["syllabus_body", "term"].
  • canvaslms_course_listList the courses the authenticated user is enrolled in, optionally filtered by enrollment type, enrollment state or course state.Read-only

    List Courses

    List the courses the authenticated user is enrolled in, optionally filtered by enrollment type, enrollment state or course state. Returns an array of courses with id, name, course_code, workflow_state, start_at, end_at, enrollments and any requested include fields. Use canvaslms_course_list to find course IDs for every other tool. Use canvaslms_course_get for one course's full details.

    Inputs

    enrollment_statestring
    Only return courses where the user's enrollment is in this state. Allowed: active, invited_or_pending, completed. Example: active.one of activeinvited_or_pendingcompleted
    enrollment_typestring
    Only return courses where the user has this enrollment type. Allowed: teacher, student, ta, observer, designer. Example: teacher.one of teacherstudenttaobserverdesigner
    includearray
    Extra data to add to each course, such as term, teachers, total_students, syllabus_body, total_scores, needs_grading_count, course_progress, sections or favorites. Example: ["term", "total_students"].
    pagestring
    Page of results to return, starting at 1. Request the next page while a full page comes back. Example: 2.
    per_pageinteger
    Number of results per page (Canvas default 10, max usually 100). Example: 50.
    statearray
    Only return courses in these states. Allowed: unpublished, available, completed, deleted. Example: ["available"].