Skip to main content
Glama

insync_list_documents

Read-only

Lists documents filed to a patient's InSync portal account so you can identify available records. Use the download tools to retrieve a selected document's contents.

Instructions

List documents filed to the patient’s portal account. Use the download tools to retrieve a document’s contents.

Input Schema

NameRequiredDescriptionDefault
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands; "raw" returns the upstream payload unprojected. compact projects each record to the fields a caller acts on; "full" keeps every field this server understands; "raw" returns the portal payload untouched.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered elsewhere. The description's real contribution is the behavioral hint that listing yields metadata only and contents require a separate download call, which is useful. It says nothing about ordering, pagination, or return shape, which are the remaining behavioral unknowns for a list endpoint.

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?

Two short sentences, purpose first, follow-up action second. No filler, no restating the tool name, every clause carries information.

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 one-parameter read-only list tool with full schema coverage and complete annotations, the description covers the essential contract: what it returns at a high level and where the actual file contents live. The only shortfall is that an agent gets no sense of result ordering or whether the list is bounded, which matters for a document catalog.

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% and the single `view` enum is thoroughly documented in the schema itself, including what compact/full/raw each return. The description adds nothing about `view`, which is acceptable given the schema does the work, so the baseline 3 applies.

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?

Names a specific verb and resource ("List documents filed to the patient's portal account"), scoping the resource to one patient's account, which cleanly separates it from siblings like insync_list_attachments or insync_list_forms. It stops short of naming the download sibling by exact name, but "the download tools" is close enough to disambiguate.

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 second sentence explicitly routes the agent to the download tools when it needs file contents, which is the key decision point against insync_download_document. It gives no guidance on when this tool would be the wrong choice beyond that (e.g., form or attachment catalogs), so a small exclusion gap remains.

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