Bywell

Open one lesson from Bywell's course, by lesson id (from get_learning_path) or by topic (e.g. 'EPS', 'guidance', 'concentration', 'TFSA'): its text, a check question with answer choices and the correct one, practice questions, and something to try. Opening doesn't mark it done; complete_lesson does. Free can start a few new lessons a day, the same as the app: past that it returns limitReached with upgradeUrl. Lessons already finished always open.

get_lesson

The user's Bywell plan (free or pro) and what it includes, how much of this month's Bywell AI allowance is used, where they invest, their investing experience, what they mostly hold and what they want help with.

get_account

The user's current positions across connected brokerage accounts: brokerage, account and account type, market value in the trading currency and in the user's display currency (baseValue), cost basis (baseCost), and portfolio weight.

get_holdings

The user's savings goals (a first home, a safety net...) with progress, as the app shows them: current (linked holdings in the goal's currency plus cash saved elsewhere), target, pct, months left, monthly amount needed as plain arithmetic with no assumed returns, whether they're on a steady pace (onTrack), and which accounts count (accounts). Empty when they haven't set one.

get_goals

The user's own investment thesis (why they own it, what would make them sell, what they're watching, conviction, review date) and dated notes (with ids, and sources for saved research) for one stock, or with no ticker, every stock they've written about plus general notes.

get_journal

The user's watchlists and the tickers in each.

get_watchlists

Bywell's investing course in the user's country's wording, unit by unit, each lesson marked done, started or not started, with the next lesson to take (from where their path starts). On Free it also gives how many lessons they've finished today against the daily limit and how many are left; on Pro the limit is null. Progress is shared with the Bywell app. Use it whenever they ask to start, continue or resume their course or lessons.

get_learning_path

The user's past Bywell AI research chats, newest first, each with a title, stock (or general) and a preview of the latest answer. ticker narrows to one stock; 'general' to chats not about one stock.

get_conversations

The user's notification settings (preset, quiet hours, daily limit, each alert type) and their price alerts.

list_alerts

The user's active earnings reminders.

list_reminders

Mutes every alert about one stock for a number of days, until turned back on (days null), or unmutes it (days 0).

mute_stock_alerts

Where the user's money sits, as the allocation strip on the app's Holdings screen shows it: by tax treatment of the account (tax-free, tax-deferred, taxable, deductible + tax-free), by currency, and by market (US, Canada, Other), each with value, share (0 to 1) and what's inside. Values are in the user's display currency unless `currency` is given. By currency and by market are part of Pro; on Free they're null and upgradeUrl is set.

get_allocation

A rundown of the user's account in one call. With a linked brokerage: total value, each account's value, how many positions, the five largest with their weights, how much of the total the top five make up, the split by tax treatment (and by currency and market on Pro), plus watchlist and reminder counts. With no brokerage linked: their watchlists, and where to link one. Values come from the user's brokerage and are in their display currency unless `currency` is given; no prices or news are added.

get_portfolio_summary

One past Bywell AI chat in full: every question and answer, with the sources each answer cited. Read-only: chats can't be added to through this connector.

get_conversation

Remove a ticker from every watchlist it's on.

remove_from_watchlist

Add a dated note to the user's journal, about one stock or general (no ticker). kind 'buy' or 'sell' records the reasoning behind a trade; 'research' saves findings with their sources.

save_note

Save the user's room for one tax-advantaged account this year (TFSA, RRSP, FHSA in Canada; IRA, 401(k), HSA in the US): the figure they read in CRA My Account or the IRS limit they're using, plus anything they contributed outside linked accounts (another brokerage, payroll). Bywell never asks for or stores tax documents; only the numbers the user gives. Saving again for the same account and year replaces the earlier figures. Returns the year's room for every account, as get_contribution_room does.

set_contribution_room

Alert the user when a stock goes above or below a price, or moves a percentage from today's price. Free checks against each day's close, for the stocks it covers; Pro checks every 5 minutes in market hours. Fires once unless repeat is true.

set_price_alert

Changes how much Bywell notifies the user. A preset (essentials, everything, quiet) replaces the alert types and daily limit; the other fields adjust one thing.

update_notification_settings

Write or update the user's thesis for one stock. Only the fields given change.

update_thesis