Skip to main content
Glama

list_users

Retrieve all enrolled users in an Ed Discussion course using the course ID. This tool provides staff and administrators with access to course participant lists.

Instructions

List all users enrolled in a course (requires staff/admin)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
course_idYesCourse ID

Implementation Reference

  • The implementation of the listUsers API call which performs the actual data fetching.
    async listUsers(courseId: number): Promise<EdAnalyticsUser[]> {
      const res = await this.request<{ users: EdAnalyticsUser[] }>(
        "GET",
        `courses/${courseId}/analytics/users`
      );
      return res.users;
  • src/index.ts:409-419 (registration)
    The registration of the 'list_users' tool, including input validation and calling the API handler.
    server.tool(
      "list_users",
      "List all users enrolled in a course (requires staff/admin)",
      { course_id: z.number().describe("Course ID") },
      async ({ course_id }) => {
        try {
          return ok(await api.listUsers(course_id));
        } catch (err) {
          return fail(err);
        }
      }
Behavior3/5

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

No annotations provided, so description carries full burden. Adds critical auth requirement ('requires staff/admin') but omits whether operation is read-only, pagination behavior, or what user data is returned since no output schema exists.

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?

Single efficient sentence with zero waste. Parenthetical permission constraint is essential context. Front-loaded with action and resource; no filler words.

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

Completeness3/5

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

Adequate for a single-parameter list tool, but lacks details on return format, pagination, or whether 'users' includes students, staff, or both given no output schema or annotations to reference.

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

Parameters3/5

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

Schema has 100% description coverage ('Course ID'), so baseline 3 applies. Description does not mention 'course_id' parameter, but schema adequately documents it without needing redundancy.

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

Purpose5/5

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

Specific verb 'List' with clear resource 'users enrolled in a course' and scope. Distinguishes from sibling 'get_user' (singular) and 'list_user_activity' (different resource) by specifying course enrollment context.

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

Usage Guidelines3/5

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

Provides permission requirement '(requires staff/admin)' which constrains when to use it, but lacks explicit comparison to siblings like 'get_user' or guidance on when to prefer this over alternatives.

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

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/rob-9/edstem-mcp'

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