canvas_get_dashboard
Retrieve user dashboard details from the Canvas Learning Management System to manage courses, assignments, enrollments, and grades efficiently using the MCP server.
Instructions
Get user's dashboard information
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:1309-1314 (handler)MCP tool handler implementation that executes the canvas_get_dashboard tool by calling CanvasClient.getDashboard() and formatting the response as JSON text.
// Dashboard case "canvas_get_dashboard": { const dashboard = await this.client.getDashboard(); return { content: [{ type: "text", text: JSON.stringify(dashboard, null, 2) }] }; - src/index.ts:369-377 (schema)Tool schema definition including name, description, and empty input schema (no parameters required). Part of the TOOLS array used for registration.
{ name: "canvas_get_dashboard", description: "Get user's dashboard information", inputSchema: { type: "object", properties: {}, required: [] } }, - src/client.ts:477-480 (helper)CanvasClient helper method that makes the API call to /users/self/dashboard and returns the dashboard data.
async getDashboard(): Promise<CanvasDashboard> { const response = await this.client.get('/users/self/dashboard'); return response.data; } - src/types.ts:506-510 (schema)TypeScript interface defining the structure of the Canvas dashboard response (CanvasDashboard).
export interface CanvasDashboard { dashboard_cards: CanvasDashboardCard[]; planner_items: CanvasPlannerItem[]; } - src/index.ts:1071-1073 (registration)Registration of the list tools handler that returns the full TOOLS array including canvas_get_dashboard.
this.server.setRequestHandler(ListToolsRequestSchema, async () => ({ tools: TOOLS }));