Skip to main content
Glama
partymola
by partymola

withings_get_sleep

Retrieve sleep data from Withings devices, including nightly summaries with duration, sleep score, and metrics, or detailed minute-by-minute sleep phase analysis for comprehensive sleep tracking.

Instructions

Get sleep data (summaries or detailed phases).

Summary mode (default): nightly totals with duration, sleep score, HR, respiratory rate, and snoring. From local cache unless live=True.

Detail mode (detail=True): minute-by-minute sleep phases (awake, light, deep, REM) with HR and respiratory rate. Always fetched live. Maximum 7 days per request (Withings API limit).

Args: start_date: Start date as "YYYY-MM-DD", "YYYY-MM", or "7d". Default: last 7 days (detail) or last 30 days (summary). end_date: End date as "YYYY-MM-DD". Default: today. detail: If true, return minute-by-minute sleep phases instead of nightly summaries. Always live, max 7 days. live: If true, fetch summaries from API instead of cache. Ignored when detail=True (always live).

Returns nightly sleep data sorted by date. Not for body composition -- use withings_get_body instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
start_dateNo
end_dateNo
detailNo
liveNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: caching behavior (local cache unless live=True), API limitations (max 7 days for detail mode), data sources (API vs cache), and operational constraints (detail=True always fetches live). It doesn't mention error conditions or rate limits, but provides substantial behavioral context for a read-only data retrieval tool.

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 well-structured and appropriately sized. It begins with the core purpose, then explains the two operational modes, documents parameters with clear explanations, mentions return behavior, and ends with a sibling tool distinction. Every sentence adds value, with no redundant information. The parameter documentation is particularly efficient in explaining interactions between parameters.

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

Completeness5/5

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

Given the tool's complexity (two operational modes, caching behavior, parameter interactions) and the presence of an output schema (which handles return value documentation), the description is complete. It covers purpose, usage guidelines, behavioral traits, parameter semantics, and sibling differentiation. The output schema existence means the description doesn't need to explain return values, allowing it to focus on operational context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully compensates by providing comprehensive parameter semantics. It explains all four parameters: start_date (formats and defaults), end_date (format and default), detail (effect on data type and fetching behavior), and live (interaction with detail mode). The description adds crucial meaning beyond the bare schema, including format examples, defaults, and parameter interactions.

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's purpose: 'Get sleep data (summaries or detailed phases).' It specifies the exact resource (sleep data) and distinguishes between two operational modes. It also explicitly differentiates from sibling tools by stating 'Not for body composition -- use withings_get_body instead,' making it clear how this tool differs from alternatives.

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use different modes: summary mode for nightly totals (default) and detail mode for minute-by-minute phases. It specifies when live fetching occurs (always for detail, optional for summary) and mentions API limitations (max 7 days for detail). It also directs users to alternative tools for related but different data ('Not for body composition -- use withings_get_body instead').

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/partymola/withings-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server