Skip to main content
Glama

canvas_get_user_profile

Retrieve the current user's profile details directly from the Canvas Learning Management System API using this tool. Streamline profile data access for managing courses, enrollments, and grades efficiently.

Instructions

Get current user's profile

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Core implementation of the user profile retrieval via Canvas API GET /users/self/profile
    async getUserProfile(): Promise<CanvasUserProfile> {
      const response = await this.client.get('/users/self/profile');
      return response.data;
    }
  • MCP server tool handler that calls CanvasClient.getUserProfile() and returns JSON-formatted response
    case "canvas_get_user_profile": {
      const profile = await this.client.getUserProfile();
      return {
        content: [{ type: "text", text: JSON.stringify(profile, null, 2) }]
      };
    }
  • src/index.ts:412-419 (registration)
    Tool registration entry in TOOLS array defining name, description, and empty input schema
      name: "canvas_get_user_profile",
      description: "Get current user's profile",
      inputSchema: {
        type: "object",
        properties: {},
        required: []
      }
    },
  • TypeScript interface defining the structure of the Canvas user profile response
    export interface CanvasUserProfile {
      id: number;
      name: string;
      sortable_name: string;
      short_name: string;
      sis_user_id: string | null;
      login_id: string;
      avatar_url: string;
      primary_email: string;
      locale: string;
      bio: string | null;
      title?: string;
      time_zone?: string;
      calendar?: any;
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states 'Get' implies a read operation but doesn't disclose behavioral traits such as authentication requirements, rate limits, or what data is returned. This is inadequate for a tool with zero annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It's appropriately sized for a simple tool and front-loaded with the core action, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and a simple tool with 0 parameters, the description is incomplete. It lacks details on what the profile includes, error conditions, or behavioral context, which are necessary for effective use by an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0 parameters and 100% schema description coverage, the baseline is 4. The description doesn't need to add parameter details, and it correctly implies no inputs are required, which aligns with the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Get') and resource ('current user's profile'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'canvas_get_user_grades' or 'canvas_update_user_profile', which would require specifying this is for profile information only.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. With siblings like 'canvas_get_user_grades' and 'canvas_update_user_profile', the description lacks context on whether this is for authentication, basic user info, or other purposes, leaving usage unclear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DMontgomery40/mcp-canvas-lms'

If you have feedback or need assistance with the MCP directory API, please join our Discord server