Skip to main content
Glama

Polar PPI Samples

polar_list_ppi_samples
Read-onlyIdempotent

Retrieve pulse-to-pulse interval samples for a specific date range; requires ppi_data:read permission.

Instructions

List pulse-to-pulse interval samples in a date range. Requires ppi_data:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPolar page number.
afterNoInclusive start date. Serialized as a Polar date or date-time according to the endpoint contract.
limitNoLocal page-size hint used for pagination safety.
beforeNoExclusive end date. Serialized as a Polar date or date-time according to the endpoint contract.
featuresNoOptional Polar v4 feature flags. Values are validated per endpoint; feature ranges that require one day are hydrated safely.
all_pagesNoFetch multiple pages up to max_pages.
max_pagesNoMaximum pages to fetch when all_pages is true.
privacy_modeNoOptional per-call privacy override. Defaults to POLAR_PRIVACY_MODE or structured. raw returns upstream Polar JSON. summary removes GPS/map details.
response_formatNomarkdown
explicit_user_intentNoRequired true when privacy_mode=raw or include_gps=true (agent escalation of redaction).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countYes
recordsYes
endpointYes
has_moreYes
next_pageNo
privacy_modeYes
pages_fetchedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.5.4
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / after / description
      Previous value: -"Only return Polar records after this time. Converted to Polar's inclusive from query parameter."New value: +"Inclusive start date. Serialized as a Polar date or date-time according to the endpoint contract."
    • changedInput schema / properties / before / description
      Previous value: -"Only return Polar records before this time. Converted to Polar's exclusive to query parameter."New value: +"Exclusive end date. Serialized as a Polar date or date-time according to the endpoint contract."
    • addedInput schema / properties / explicit_user_intent
      Added value: +{
      +  "description": "Required true when privacy_mode=raw or include_gps=true (agent escalation of redaction).",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / features
      Added value: +{
      +  "description": "Optional Polar v4 feature flags. Values are validated per endpoint; feature ranges that require one day are hydrated safely.",
      +  "items": {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • changedInput schema / properties / privacy_mode / description
      Previous value: -"Optional per-call privacy override. Defaults to POLAR_PRIVACY_MODE or structured. raw returns upstream Polar JSON. summary minimizes sensitive health and profile details."New value: +"Optional per-call privacy override. Defaults to POLAR_PRIVACY_MODE or structured. raw returns upstream Polar JSON. summary removes GPS/map details."
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.3.6

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is fully covered by structured data. The description adds the scope requirement (ppi_data:read), which is genuine extra value, but says nothing about pagination behavior, rate limits, or the privacy/escalation mechanics (privacy_mode=raw requires explicit_user_intent=true) that govern actual calls.

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, zero filler, and the core capability is front-loaded before the permission constraint. Nothing in the text is redundant with the name or title.

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?

An output schema exists, so return values need not be explained, and annotations carry the safety profile. However, for a 10-parameter tool with privacy modes and redaction-escalation semantics, the description omits anything about the raw-privacy escalation path or pagination limits, leaving the agent to discover those entirely from the schema.

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 90%, so the schema already documents page, after, before, limit, features, all_pages, max_pages, privacy_mode, response_format, and explicit_user_intent in detail. The description adds no parameter-level information beyond the implicit date-range framing, so the baseline 3 for schema-driven documentation 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?

States a specific verb and resource ("List pulse-to-pulse interval samples") with a scoping qualifier ("in a date range"), which is enough to separate it from sibling list tools like polar_list_continuous_samples or polar_heart_series. It does not explicitly name or contrast those siblings, so it stops short of a 5.

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

Usage Guidelines3/5

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

The description implies when the tool is usable via the date-range scope and the "Requires ppi_data:read" prerequisite, which tells the agent whether it can be attempted at all. It offers no explicit routing advice though — nothing says when to prefer this over polar_list_continuous_samples or polar_heart_series, and no exclusions.

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