Skip to main content
Glama

List documents

healthie_list_documents
Read-only

List documents, optionally scoped to a patient (viewable_user_id) or by keyword. Read-only. GraphQL: query documents(viewable_user_id, keywords, offset, page_size, should_paginate).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNoPagination offset. Default 0.
keywordsNoFree-text search over document names.
page_sizeNoResults per page. Default 25.
viewable_user_idNoPatient id whose documents to list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces 'Read-only.' It adds behavioral context about optional filtering and provides the underlying GraphQL query signature, which gives the agent insight into the API mapping beyond the annotation.

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, front-loaded with the core purpose, and contains no redundant information. The GraphQL signature is compact and adds value without bloat.

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 simple list tool with all-optional parameters, the description covers the essential behavior: listing documents with optional filters. The read-only annotation and schema fill in remaining details. The GraphQL signature adds extra context, though the unexplained 'should_paginate' is a minor omission.

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 the schema fully documents all four parameters. The description lists the same parameter names in the GraphQL signature but does not add new semantic detail. The mention of 'should_paginate' in the GraphQL is extraneous and could be confusing since it's not in the input schema.

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 'List documents' with optional scoping by patient or keyword. The verb 'list' and resource 'documents' are specific, and the scoping options distinguish it from sibling list tools for other resources.

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 provides clear context on when to use: when listing documents, optionally filtered by viewable_user_id or keyword. It does not explicitly mention alternatives or exclusions, but the resource-specific nature makes the intended use apparent.

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.