Skip to main content
Glama
trenerok

oura-mcp-server

by trenerok

get_rest_mode_period_by_id

Retrieve a single Oura rest mode period by its unique document ID to review rest mode details and timelines.

Instructions

Get a single rest mode period document by its unique ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYesThe unique document ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. 'Get' implies a read-only single-record retrieval, but it does not disclose error behavior, auth requirements, or return format. Basic read semantics are present, but further behavioral traits are absent.

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?

One sentence, front-loaded with the verb and resource, with no redundant or filler text. Every word supports the purpose.

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 simple one-parameter read tool, the description identifies the resource and the retrieval key. Missing output schema and not-found/error behavior keep it from a 5, but it is adequate for correct invocation.

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 document_id is already fully documented. The description adds only that the ID is unique and selects a single document, which is marginal beyond the schema; the baseline of 3 applies.

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?

States the specific verb 'Get', the resource 'rest mode period document', and the scope 'single ... by unique ID'. This clearly distinguishes it from the sibling list tool get_rest_mode_periods.

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 gives clear context: use this when you have a unique document ID to retrieve one record. It does not name alternatives or exclusions, so it falls short of the top score.

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