Skip to main content
Glama

get_users_segment

Read-onlyIdempotent

Retrieves users belonging to a specific segment, sorted newest first, with 20 users per page.

Instructions

🟢 READ-ONLY · Users · GET /v2/users/by-segment

Get all users by segment

Retrieves all the users in the segment specified by the provided segment id. The users are in sorted order, with the most recently created user appearing first, and the list is paginated, with a limit of 20 user per page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoFilter by the page number. In case page number is higher than the maximum one, no results will be returned
segment_idYesFilter by segment id
Behavior4/5

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

Annotations already provide readOnly, idempotent, and non-destructive hints. The description adds behavioral details: users are sorted by most recent first and paginated with a limit of 20 per page. This adds value beyond annotations.

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 extremely concise: three sentences including an emoji and API path. It front-loads the read-only indicator and provides all necessary information without fluff. Every sentence earns its place.

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?

Given no output schema, the description adequately explains the return format (sorted, paginated, 20 per page). It covers pagination behavior and sorting order. Missing details on user fields but acceptable for a retrieval tool with good annotations.

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 coverage is 100%, with descriptions for both parameters (page and segment_id). The description mentions 'provided segment id' but adds no extra meaning beyond the schema. Baseline 3 is appropriate as the schema already does the heavy lifting.

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?

The description clearly states it retrieves all users by segment with sorting and pagination details. The verb 'Retrieves' and resource 'users in the segment' are specific, and the tool name aligns perfectly with the function. It distinguishes from siblings like get_users by its segment filter.

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?

The description implies usage for segment-based user retrieval but does not explicitly contrast with alternatives like get_users (which fetches all users) or other segment-related tools. No guidance on when not to use is provided.

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/ohneben/Learnworlds-MCP'

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