Skip to main content
Glama

ofw_list_messages

Read-only

List cached OurFamilyWizard messages with filters for folder, date range, and subject/body text. Get newest-first results, paginated, with auto-refresh to avoid stale empty results.

Instructions

List messages from the local OurFamilyWizard cache. Supports filtering by folder, date range, and a substring query on subject+body. Pagination is offset-based (1-based page) but if you know what you want (a date range, a topic), prefer the filters over walking pages — the cache may have 1000+ messages. Results are newest-first by default; sort:"oldest" starts at the old end of a range instead of paging to it. Returns an explicit complete boolean describing the RESULT SET: true means "this is every message on OurFamilyWizard matching these filters as of freshness.asOf" — check it before asserting a count. An empty result from a cache that is not verified-fresh is REFUSED (result:"UNVERIFIED_EMPTY") rather than reported as an absence; pass autoRefresh:true to sync and answer instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSubstring match on subject AND body (case-insensitive). Use to find messages on a specific topic.
pageNoPage number (default 1)
sizeNoMessages per page (default 50)
sortNoResult order: "newest" (default, newest first) or "oldest" (oldest first). This decides which end a truncated page keeps — with "newest" page 1 of a wide date range holds its most RECENT slice, with "oldest" its earliest. Use "oldest" to start at the old end of a range instead of paging to it.
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands. compact omits OurFamilyWizard's raw `listData` echo, which duplicates this record's own id, subject, sentAt, recipients and read flag; the sender is promoted to `from`, and `files`/`replied` are kept. Pass "full" for the echo.
sinceNoISO date or datetime — only messages with sent_at >= since (inclusive). A value with an offset or Z is compared as that instant; a naive value is read as the account's local time (DISPLAY_TZ)
untilNoISO date or datetime — only messages with sent_at < until (exclusive). A value with an offset or Z is compared as that instant; a naive value is read as the account's local time (DISPLAY_TZ)
folderIdNoFolder name: "inbox", "sent", or "both" (default "both")
autoRefreshNoIf the result comes back EMPTY from a cache that is not verified-fresh, sync the backing folders first and answer from the refreshed cache instead of refusing. Defaults to the OFW_AUTO_REFRESH env var (false unless set), in which case the call refuses with result:"UNVERIFIED_EMPTY" and names the remedy. Costs OFW requests when it fires.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.19.4

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint:true, and the description adds substantial behavioral context: cache-based results, the complete boolean describing result-set completeness, the UNVERIFIED_EMPTY refusal for unverified caches, autoRefresh sync behavior, sort semantics affecting which end of a range a page keeps, and view field shaping. No contradiction with annotations; this exceeds the baseline.

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 long but every sentence adds value. It is front-loaded with the core purpose, then flows into filtering, pagination/sort, result-set semantics, and edge cases. There is no fluff or redundancy; the structure is logical and efficient.

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?

For a 9-parameter list tool with no output schema and only readOnlyHint annotation, the description covers all critical aspects: caching, freshness, pagination, sort behavior, response shape via view, and the complete boolean. It also explains the UNVERIFIED_EMPTY refusal and autoRefresh remedy. Nothing an agent needs to call it correctly is missing.

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?

Schema coverage is 100%, so all 9 parameters are documented, but the description adds significant meaning beyond the schema: it explains sort's effect on paging (start at old end vs paging to it), the compact vs full view trade-offs (dropping duplicate fields, promoting sender to from), and autoRefresh's cost and default behavior. These enrich the parameter semantics well beyond the baseline.

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 'List messages from the local OurFamilyWizard cache' with a specific verb and resource. It enumerates filtering options (folder, date range, substring) and pagination, distinguishing itself from sibling tools like ofw_get_message (single message) and ofw_list_drafts. The scope is precise and unambiguous.

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?

Provides explicit guidance: prefer filters over walking pages when a specific date range or topic is known, and pass autoRefresh:true when the cache might be stale. It implies when to use this list tool vs alternatives, though it does not name specific sibling tools or explicit exclusions. The context is clear enough for an agent to decide when to call it.

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