Skip to main content
Glama

List patients / clients

healthie_list_patients
Read-only

List patients/clients, optionally filtered by keyword search or active status. Read-only. GraphQL: query users(keywords, offset, page_size, should_paginate, active_status).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNoPagination offset. Default 0.
keywordsNoFree-text search over name/email.
page_sizeNoResults per page (max 100). Default 25.
active_statusNoFilter by status: "active" or "archived".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

The description repeats 'Read-only' which is already disclosed by the readOnlyHint annotation, adding little new information. It does include the GraphQL query for transparency, but does not detail pagination behavior, return format, or any side effects beyond what annotations and schema provide.

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 concise with two sentences. The first states the core function, the second adds relevant technical context. No redundant words exist, and it is appropriately sized for the tool's simplicity.

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?

The description is mostly complete for a simple list tool with good schema coverage and annotations. It does not explain return values, but for a list operation that is not critical. It also omits pagination defaults, though those are in the schema. Overall, it provides sufficient context to use the tool correctly.

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%, so parameters are well-documented. The description adds only a grouped mention of 'keyword search or active status' which aligns with the schema, but does not add substantive meaning beyond it. Note: the GraphQL query mentions 'should_paginate' which is not in the schema, potentially causing confusion, but it does not directly affect parameter understanding.

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 the tool lists patients/clients with optional filtering by keyword or active status. It uses a specific verb ('List') and identifies the resource, distinguishing it from sibling tools like get_user or list_appointments.

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 implies it is for listing patients with optional filters, which provides clear context for when to use it. It does not explicitly mention alternatives or exclusions, but the context signals show sibling tools, and the description's scope is clear enough.

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.