Excalidraw ACTION
List Scenes
Returns scenes (whiteboards) in the Excalidraw Plus workspace. Optionally filter by collection ID or apply a name substring filter (applied client-side, since the API has no server-side search). When the user says 'scenes in [collection]', use List Collections first to get the collection ID, then pass it as
collectionId here. Use nameFilter (and limit) to narrow results when the user asks for a scene by name — the tool fetches up to limit scenes and returns only those whose name contains the filter string. See the documentation- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Excalidraw account once, then configure and run List Scenes 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: "excalidraw-list-scenes",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
excalidraw: { authProvisionId: "apn_xxxxxxx" },
collectionId: "Collection ID",
nameFilter: "Name Filter",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "excalidraw-list-scenes",
"configured_props": {
"excalidraw": { "authProvisionId": "apn_xxxxxxx" },
"collectionId": "Collection ID",
"nameFilter": "Name Filter"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "excalidraw",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "excalidraw-list-scenes",
arguments: {
collectionId: "Collection ID",
nameFilter: "Name Filter",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
collectionId Collection ID | string | The unique identifier of the collection. Use List Collections to find collection IDs. Example: 77i8dL6qc5t. Optional |
nameFilter Name Filter | string | Filter scenes by name (case-insensitive substring match, applied client-side). Optional |
limit Limit | integer | Maximum number of results to return. Optional |
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
- excalidraw-list-scenes
- Version
- 0.0.2
- App
- Excalidraw
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗