docs+fix: reconcile 22 documentation claims with the code; emit the contact phones the docs promised - #129
Merged
Conversation
…he contact phones the docs promised Audit of every doc surface against the live 50-tool inventory. The findings split into three classes. CONTRADICTED BY CODE - search-contacts promised phone numbers in four places (tool description twice, README, CLAUDE.md) and dropped them from both the text and structuredContent. The phones were already being read by the same SQL that reads emails, then discarded one line before serialization. Now emitted. - README documented a search-contacts 'limit' (default 10). No such parameter exists and results are uncapped; a caller would misread a complete result set as clipped. - README said get-unread-count with no mailbox returns a total. 2.8.15 changed it to INBOX only, deliberately, because summing double-counted on Gmail. - Known Limitations still claimed 'No smart mailboxes' while the same README documents four smart-mailbox tools shipped in 2.9.0. - fetch-attachment was documented as numeric-id only; it accepts imap: ids. - SKILL.md still told agents resolve-message-id is 'needed for flag colors' — the eighth surviving copy of the rot 2.10.1 fixed everywhere else, and the one most likely to push an agent back onto the AppleScript/TCC path. MISSING - get-message's mailbox/account params were undocumented — they are the documented fix for large-folder timeouts, so the fix was undiscoverable. - search-contacts needs Node 22.5+ (node:sqlite) and Full Disk Access, and returns an empty list rather than erroring without them. Neither was stated outside the CHANGELOG. - get-mail-stats was documented as taking no parameters; it accepts account. - Smart-mailbox tools need Full Disk Access; every failure surfaced as 'no smart mailboxes'. - flagColorIndex, the only way to read a flag color, appeared only in the CHANGELOG. - SKILL.md had no smart-mailbox section at all. OBSOLETE - IMAP-SETUP taught the pre-2.6.0 rule that reads need a matching account argument to route to IMAP; since 2.6.0 they prefer IMAP automatically. - Development block told contributors to run npm install, which package.json's own preinstall guard hard-fails. - SECURITY.md and README claimed no data goes to external servers — untrue once the opt-in IMAP/SMTP backends are configured; reframed as no THIRD parties. - SECURITY.md documented a numeric-only message-id regex; imap: ids are accepted. - Antigravity marketplace still advertised the removed Hermes packaging. Two error messages also gained the mandated setup URL + doctor pointer. skills/ edited at the root only, then pnpm run sync:skills.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Audit of every documentation surface against the live 50-tool inventory (dumped from the built server over MCP, not inferred). 22 findings, each adversarially verified before landing.
The one that is a real bug, not a doc bug
search-contactspromised phone numbers in four places — the tool description twice (Use when: … find their email address(es)/phone(s)andReturns: … and phone numbers), the README, andCLAUDE.md— and returned them in zero.contactsDbalready read phones in the same SQL that reads emails; the handler discarded them one line before serialization, from both the text andstructuredContent.Same class as 2.10.1's
colorApplied: false: a documented output contract the handler silently fails. An agent asked for someone's number got a result with no phone and could only conclude none was on file.Verified against the real Contacts DB after the fix:
That contact returned
"emails": []and nothing else before — the phone was read and thrown away.Contradicted by the code
search-contactslimitparam, default 10get-unread-countmailbox→ totalfetch-attachmentimap:idsskills/apple-mail/SKILL.mdresolve-message-id"needed for flag colors"That last one is the most consequential: an agent planning from the skill's tool table would resolve
imap:ids purely to color a flag, reintroducing the AppleScript/TCC dependency 2.10.0 removed — the one that previously killed four consecutive scheduled jobs.Missing
get-message'smailbox/accountparams — the documented cure for large-folder timeouts, undiscoverable because the table omitted themsearch-contactsneeds Node 22.5+ (node:sqlite) and Full Disk Access, and returns an empty list rather than an error without them — so "no contacts found" could mean "cannot read Contacts"get-mail-stats'saccountscope (documented as "Parameters: None")flagColorIndex— the only way to read a flag color — existed only in the CHANGELOGObsolete
docs/IMAP-SETUP.mdstill taught the pre-2.6.0 rule that reads need a matchingaccountto route to IMAP — since 2.6.0 they prefer IMAP automatically and fan out across configured accountsnpm install, whichpackage.json's ownpreinstallguard hard-failsSECURITY.mddocumented a numeric-only message-id regex superseded byimap:idsCorrected privacy claim
SECURITY.mdand the README both said no data is sent to external servers. That is false once the opt-in IMAP/SMTP backends are configured — they connect to your provider, which is the point. Reframed as no third parties: nothing reaches this project or anyone else, and with the default AppleScript backend everything stays on-device.Verification
no-explicit-anywarnings, count unchanged), typecheck, format:check, 417 tests, plugin-manifest sync, skills drift check, bundle-matches-source — all passskills/edited at the canonical root only, thenpnpm run sync:skillssearch-contactschange against the live Contacts DB (above)Checklist
## [2.10.3]CHANGELOG heading (tool descriptions and handler output are shipped bytes)