Canvas MCP Server V2.0

Instructions

Implementation Reference

• src/index.ts:797-807 (registration)

  Tool registration in TOOLS array defining name, description, and input schema

  {
    name: "canvas_get_account_reports",
    description: "List available reports for an account",
    inputSchema: {
      type: "object",
      properties: {
        account_id: { type: "number", description: "ID of the account" }
      },
      required: ["account_id"]
    }
  },

• src/index.ts:1429-1437 (handler)

  Tool handler dispatch in CallToolRequestSchema switch statement, validates args and calls client method

  case "canvas_get_account_reports": {
    const { account_id } = args as { account_id: number };
    if (!account_id) throw new Error("Missing required field: account_id");
    
    const reports = await this.client.getAccountReports(account_id);
    return {
      content: [{ type: "text", text: JSON.stringify(reports, null, 2) }]
    };
  }

• src/client.ts:785-788 (handler)

  Core handler implementation in CanvasClient - makes API call to /accounts/{accountId}/reports and returns data

  async getAccountReports(accountId: number): Promise<any[]> {
    const response = await this.client.get(`/accounts/${accountId}/reports`);
    return response.data;
  }

• src/types.ts:761-774 (schema)

  Type definition for CanvasAccountReport - output schema for account reports

  export interface CanvasAccountReport {
    id: number;
    report: string;
    file_url?: string;
    attachment?: CanvasFile;
    status: 'created' | 'running' | 'complete' | 'error';
    created_at: string;
    started_at?: string;
    ended_at?: string;
    parameters: Record<string, any>;
    progress: number;
    current_line?: number;
  }

• src/index.ts:800-806 (schema)

  Input schema definition for the tool - requires account_id as number

  inputSchema: {
    type: "object",
    properties: {
      account_id: { type: "number", description: "ID of the account" }
    },
    required: ["account_id"]
  }