Skip to main content
Glama

edubase_get_user

Read-onlyIdempotent

Retrieve a user's name, account status, and exam account flag by user ID. Use search tool when only email or username is known.

Instructions

Get a user: name, whether the account is enabled and whether it is a generated exam account. Use edubase_get_user_search if only the email address or username is known.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
userYesUser identification string. Use 'me' to get the current user, but prefer /user:me endpoint instead.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
examYes
nameYes
userYes
statusYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.0.0
    • removedOutput schema / properties / exam / description
      Removed value: -"exam (generated) account"
    • removedOutput schema / properties / name / description
      Removed value: -"full name"
    • removedOutput schema / properties / status / description
      Removed value: -"user is enabled"
    • removedOutput schema / properties / user / description
      Removed value: -"user identification string"
  2. Changed3 schema fields changedv1.1.2
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / user / description
      Previous value: -"User identification string.\n- Use 'me' to get the current user, but prefer /user:me endpoint instead."New value: +"User identification string. Use 'me' to get the current user, but prefer /user:me endpoint instead."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "exam": {
      +      "description": "exam (generated) account",
      +      "type": "boolean"
      +    },
      +    "name": {
      +      "description": "full name",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "user is enabled",
      +      "type": "boolean"
      +    },
      +    "user": {
      +      "description": "user identification string",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "user",
      +    "name",
      +    "status",
      +    "exam"
      +  ],
      +  "type": "object"
      +}
  3. First observedv1.0.22

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the read-only, non-destructive nature is covered without needing description repetition. The description adds useful context by listing the specific data returned (name, enabled status, generated exam account flag) and by introducing the domain concept of a 'generated exam account'. It does not disclose additional behaviors like authorization requirements or error conditions, but with annotations covering the safety profile, a score of 3 is appropriate.

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 two sentences with zero waste. The first sentence states the purpose and output data fields; the second sentence gives a clear routing rule for an alternative tool. It is front-loaded with the core action and follows with the most relevant usage caveat, making it easy to scan and act on.

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

Completeness4/5

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

For a read-only, single-parameter tool with an existing output schema, the description covers the essential information: what the tool returns and when to use the search sibling instead. The /user:me special case is handled in the parameter schema, and the dedicated sibling edubase_get_user_me exists for current-user retrieval, so the description does not need to restate it. The only minor omission is an explicit statement about required identifier format, but the schema fills that gap.

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 description coverage is 100%, with the 'user' parameter fully documented as a user identification string, including the special 'me' value and the advice to prefer the /user:me endpoint. The description itself adds no further parameter semantics, so it does not go beyond what the schema already provides. This matches the baseline 3 for a fully documented 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 uses the specific verb 'Get' and clearly identifies the resource (a user) plus the three fields returned: name, enabled status, and generated exam account flag. It differentiates from edubase_get_user_search by naming it explicitly in the second sentence, but it does not distinguish itself from edubase_get_user_me, a close sibling for retrieving the current user. This is a clear purpose with only a minor gap in sibling separation.

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

Usage Guidelines4/5

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

The description explicitly states when to use an alternative: 'Use edubase_get_user_search if only the email address or username is known.' This provides a clear when-not condition. However, it omits guidance about when to prefer edubase_get_user_me for the current user, and it does not specify what form of identifier the tool expects beyond what the schema says. Guidance is present but incomplete.

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

Deploy Server

Other Tools