Skip to main content
Glama

Sleep

vital_get_sleep
Read-only

Get sleep summaries for a user over a date range. Vital API: GET /v2/summary/sleep/{user_id}.

Input Schema

NameRequiredDescriptionDefault
user_idYesThe Vital user id (UUID).
end_dateNoEnd date yyyy-mm-dd (inclusive). Defaults to today upstream.
providerNoFilter to a single provider slug (e.g. oura, fitbit).
start_dateYesStart date yyyy-mm-dd (inclusive, required).

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

B3.2/5.0
Behavior3/5

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

The readOnlyHint=true annotation already establishes this is a safe read. The description adds the upstream API route (GET /v2/summary/sleep/{user_id}), which is useful for documentation cross-referencing, but says nothing about pagination, data latency, empty-result behavior, or the shape of a 'summary'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short, front-loaded sentences with no redundancy — purpose first, API route second. The route sentence is marginally useful rather than filler, though a dangling NoSuchMethod-style detail like this could be trimmed in favor of usage guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the burden of explaining what a 'sleep summary' contains, and it does not — no field list, no note on whether results are per-day records. Annotations cover the safety profile and the schema covers inputs, so the definition is callable but leaves the return contract unspecified.

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 user_id, start_date, end_date, and provider are all fully documented in the schema itself, including the absolute date pattern and the upstream default for end_date. The description only restates that a date range applies, adding no meaning beyond the schema. Baseline 3 is appropriate.

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?

States a specific verb and resource ('Get sleep summaries for a user over a date range') plus the underlying API route, so the agent knows exactly what data class this returns. It does not explicitly contrast itself with sibling retrieval tools like vital_get_activity or vital_get_timeseries, but the 'sleep' resource is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no when-to-use guidance, no mention of when to prefer vital_get_timeseries or vital_get_user_latest_info instead, and no note on how to choose dates or the provider filter. Without this, the agent must infer selection from the tool name alone.

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.