Skip to main content
Glama

Start consolidated query

metriport_start_consolidated_query
Destructive

Starts a consolidated-data (FHIR) query for the patient. Returns a requestId; the bundle is delivered asynchronously (webhook). Medical API: POST /medical/v1/patient/{id}/consolidated/query.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe Metriport Patient ID.
dateToNoInclusive end date yyyy-mm-dd.
dateFromNoInclusive start date yyyy-mm-dd.
metadataNoOptional custom string key-value pairs returned in the webhook.
resourcesNoComma-separated, case-sensitive list of FHIR resource types. Omit for all.
conversionTypeNoOutput format: json, pdf, or html.

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?

Behavioral traits are disclosed: asynchronous, returns requestId, uses webhook. The annotation (destructiveHint: true) is consistent and the description adds context (POST endpoint, async nature). No contradiction, but lacks details on idempotency or side effects.

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 sentences, includes the endpoint path, no redundant words. 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 6 params and no output schema, the description covers key behavioral aspects (async, requestId) necessary for use. However, it doesn't explain how to retrieve the query results or what 'consolidated' means, which could be useful for completeness.

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 baseline is 3. The description adds no extra parameter meaning beyond what the schema already provides. For example, it doesn't explain the purpose of 'resources' or 'metadata' further.

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 action ('Starts'), the resource ('consolidated-data (FHIR) query'), and the target (patient). It distinguishes from sibling tools like 'metriport_start_document_query' by specifying it's a consolidated query and mentioning asynchronous delivery.

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 hints at when to use this tool (for consolidated FHIR queries) and that it's async with webhook delivery, but does not explicitly state alternatives or when not to use it versus something like 'metriport_list_consolidated_queries'.

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.