Skip to main content
Glama

List users

kayako_list_users
Read-only

List users (customers, collaborators, agents, admins), newest first, optionally by role type or specific ids. To find a user by email or name use kayako_search. Kayako: GET /api/v1/users.json.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoFetch these user ids.
roleNoOnly users of this role type.
limitNoItems per page, 1-100. Kayako's default is 10.
offsetNoOffset into the collection (0-based). Default 0.
includeNoComma-separated resource types to expand instead of returning {id, resource_type} references, e.g. 'user,case_status,case_priority,team', or '*' for all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, carrying the safety profile, so the bar is lower. The description adds two real behavioral facts not in structured data: results are ordered newest-first and the upstream endpoint is GET /api/v1/users.json. It says nothing about pagination behavior, though the schema covers limit/offset.

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?

A single front-loaded sentence followed by a short routing clause and the endpoint. There is no filler; the scope and ordering come before the alternative-tool pointer.

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?

No output schema exists, but the list semantics, ordering, filters, and routing to kayako_search cover what an agent needs to call it correctly, and pagination/expansion details live in the schema. The one gap is that return shape for a list response is not hinted at.

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%, so every parameter (ids, role, limit, offset, include) is already documented in the schema with enums and defaults. The description only restates the role-type and ids filters, adding no syntax or format detail beyond what the schema provides. Baseline 3 is correct here.

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?

States a specific verb and resource ('List users') plus the exact population covered (customers, collaborators, agents, admins) and the default ordering ('newest first'). It also names the sibling it is not (kayako_search), so an agent can distinguish it without opening either schema.

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?

Explicitly routes lookup-by-email-or-name to kayako_search, which is a concrete when-not rule. However it does not clarify when to use this list tool versus the single-record kayako_get_user sibling, so one obvious boundary is left implicit.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.