Skip to main content
Glama

get_user_by_id

Read-only

Fetch a Remnawave user record by numeric ID to inspect account status, traffic, devices, and connections in read-only chat.

Instructions

Get user by ID [READ] GET /api/users/:userId

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
userIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description's '[READ] GET' tag is consistent with that. It adds the concrete endpoint mapping but says nothing about error behavior for a nonexistent ID or what the returned user object contains.

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

Conciseness4/5

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

Two short lines with the operation front-loaded and no filler. It is efficient, though arguably too terse for a tool whose parameter is undocumented.

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?

This is a simple single-parameter read whose safety profile is fully covered by annotations, so the description does not need to carry much. Still, with zero schema description coverage and no output schema, it leaves the agent without the ID semantics or any sense of the return payload.

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

Parameters2/5

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

Schema description coverage is 0%, so the schema documents only the numeric type and exclusiveMinimum constraint. The description adds essentially nothing beyond 'ID' — no format, no range, no indication that it must be a positive internal user ID rather than a UUID or username.

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?

States a specific verb and resource ('Get user by ID') and the REST route (GET /api/users/:userId) pins down the exact operation. The 'by ID' qualifier implicitly separates it from siblings like get_user_by_short_uuid and get_user_by_username, though those siblings are never named.

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 on when to choose this over find_user, resolve_user, get_users, or get_user_by_username. The only hint is the identifier implied by 'by ID', leaving the agent to infer the selection criteria from the name alone.

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