View as Markdown
Canvas icon

Canvas ACTION

Search Course Content

Search for content in a course. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Canvas account once, then configure and run Search Course Content from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "canvas-search-course-content",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    canvas: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    userId: "User ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Course Content inputs
Property Type Description
accountId Account ID string
The ID of an account
Required Dynamic
userId User ID string
The ID of a user
Required Dynamic
courseId Course ID string
The ID of a course
Required Dynamic
query Query string
The query to search for
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
canvas-search-course-content
Version
0.0.1
App
Canvas
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes