BrewForge Docs

Tool reference

Every tool of the BrewForge MCP server and actions API, by toolset, generated from the API itself.

All tools of the MCP server and actions of the actions API, grouped by toolset. This reference is generated from the API at every docs build, so it always matches what the server offers. Names, descriptions and parameters are the ones an AI assistant sees.

How to read an entry

  • read, write or destructive: whether the tool only reads, changes data, or deletes or undoes something. Destructive tools change nothing without confirm: true and return a preview instead (details).
  • Scope: what an API token needs: this area scope or the umbrella scope read / write. Apps connected with OAuth have read or write.
  • Plan feature: the tool also needs this feature of your plan; without it the call returns TIER_REQUIRED with the plan that includes it.
  • Parameters: the JSON input. Required ones are marked; ingredients[].amount_g is a field of each item of the ingredients list. Units are in the field names (_sg, _c, _l, _g).
  • API reference links to the same action in the OpenAPI reference, with its output schema and a playground.

Getting started

Account, plan, units and enabled features; a map of the other toolsets. Always available. (1 tool)

ToolWhat it doesScope
get_startedGet startedread

Brewing

Recipes and brews, brew day, fermentation readings, evaluations and devices. (33 tools)

ToolWhat it doesScope
find_brewsFind brewsreadbrews:read
get_brewGet a brewreadbrews:read
find_recipesBrowse the recipe bookreadbrews:read
create_brewCreate a recipe / brewwritebrews:write
update_recipeEdit a brew's recipewritebrews:write
update_brewRename, date, tag or pin a brewwritebrews:write
set_brew_statusChange a brew's statuswritebrews:write
copy_brewBrew again, new version or copy as new recipewritebrews:write
share_brewTurn a brew's share link on or offwritebrews:write
convert_imported_brewMake an imported recipe editablewritebrews:write
import_recipeImport a recipe (BeerXML or MMuM)writebrews:write
export_brewExport a brew (BeerXML, JSON, PDF sheets)readbrews:read
delete_brewDelete a brewdestructivebrews:write
get_brew_day_planGet the brew day planreadbrews:read
record_brew_measurementsRecord brew day measurementswritebrews:write
deduct_brew_ingredientsDeduct a brew's ingredients from stockwriteinventory:write
log_fermentation_readingLog a fermentation readingwritebrews:write
get_fermentationGet fermentation status and readingsreadbrews:read
delete_fermentation_readingsDelete fermentation readingsdestructivebrews:write
plan_carbonationPlan carbonation (priming sugar or keg pressure)writebrews:write
save_brew_noteAdd or edit a brew notewritebrews:write
list_brew_notesList a brew's notesreadbrews:read
delete_brew_noteDelete a brew notedestructivebrews:write
set_brew_custom_fieldsSet custom field values on a brewwritebrews:write
rate_brewRate a brew (quick star rating)writebrews:write
save_scoresheetFill in a BJCP or Lagerbernd scoresheetwritebrews:write
list_evaluationsList a brew's ratings and scoresheetsreadbrews:read
delete_evaluationDelete a rating or scoresheetdestructivebrews:write
set_evaluation_linkTurn the public evaluation link on or offwritebrews:write
list_devicesList fermentation devicesreadbrews:read
add_deviceAdd a fermentation devicewritebrews:write
update_deviceAttach a device to a brew or change its settingswritebrews:write
delete_deviceDelete a devicedestructivebrews:write

Cellar

Cellar vessels, packaging, packaged stock, tap lists and labels. (23 tools)

ToolWhat it doesScope
get_cellarCellar overview: what is in which vesselreadcellar:read
save_stayPut a beer in a vessel, or change a staywritecellar:write
end_stayEmpty a vessel today (end a stay)writecellar:write
plan_brew_cellarPlan a brew's path through the cellarwritecellar:write
move_brew_dayMove a brew day and its planned cellar stayswritebrews:write
save_cellar_vesselAdd or edit a vessel or bottle/can containerwritecellar:write
delete_cellar_itemDelete a stay, vessel or containerdestructivecellar:write
get_packaging_contextBefore packaging: volume, free kegs, bottlesreadcellar:read
package_beerPackage beer into kegs, bottles or canswritecellar:write
get_beer_stockBeer on hand: kegs, bottles and cansreadcellar:read
update_kegUpdate a keg: litres left, pour, empty, sensorwritecellar:write
update_bottle_stockChange bottle/can stockwritecellar:write
undo_stock_changeUndo a keg or bottle stock changewritecellar:write
get_taplistTap lists: beers, taps, menus and screensreadcellar:read
save_tap_listCreate or edit a tap listwritecellar:write
save_taplist_beerAdd a beer to a tap list, or change itwritecellar:write
manage_tapTaps: put a beer on, next up, add/rename tapswritecellar:write
manage_taplist_sharingMenus, TV screens and guest links of tap listswritecellar:write
delete_taplist_itemDelete a tap list, beer, tap, menu or screendestructivecellar:write
get_labelsLabel templates and the label text of brewsreadcellar:read
save_label_templateCreate, edit or copy a label templatewritecellar:write
delete_label_templateDelete a label templatedestructivecellar:write
set_trmnl_screenChoose what a TRMNL e-ink screen showswritecellar:write

Inventory

Ingredient stock, ingredient catalog, packages, orders and the planner (what am I short of). (16 tools)

ToolWhat it doesScope
find_stockFind ingredient stockreadinventory:read
add_stockAdd ingredient stockwriteinventory:write
update_stockUse up, correct or edit stockwriteinventory:write
remove_stockRemove a stock rowdestructiveinventory:write
find_ingredientsFind ingredientsreadinventory:read
save_custom_ingredientCreate or edit an own ingredientwriteinventory:write
delete_custom_ingredientDelete an own ingredientdestructiveinventory:write
get_ingredient_packagesList or open ingredient packagesreadinventory:read
select_package_ingredientsPick ingredients from a packagewriteinventory:write
get_ordersList orders or open onereadinventory:read
save_orderCreate or edit an orderwriteinventory:write
edit_order_itemsAdd, change or remove order lineswriteinventory:write
receive_orderReceive an order into stockwriteinventory:write
delete_orderDelete an orderdestructiveinventory:write
get_plannerPlan ingredients for planned brewsreadinventory:read
create_order_from_shortagesOrder what the planned brews are short ofwriteinventory:write

Setup

Profiles (equipment, mash, water, fermentation), styles, custom fields, preferences, calendar, analysis, calculators, imports and exports. (19 tools)

ToolWhat it doesScope
find_profilesFind profilesreadprofiles:read
get_profileGet a profile with all settingsreadprofiles:read
create_profileCreate a profilewriteprofiles:write
update_profileChange a profilewriteprofiles:write
delete_profileDelete a profiledestructiveprofiles:write
apply_profileApply a profile to brewsdestructivebrews:write
find_stylesFind beer stylesreadstyles:read
save_styleCreate or change an own stylewritestyles:write
delete_styleDelete an own styledestructivestyles:write
list_custom_fieldsList custom field definitionsreadcustom-fields:read
save_custom_fieldCreate, change or archive a custom fieldwritecustom-fields:write
delete_custom_fieldDelete a custom field for gooddestructivecustom-fields:write
get_preferencesGet preferencesreadsettings:read
update_preferencesChange preferenceswritesettings:write
reset_preferencesReset preferences to defaultsdestructivesettings:write
get_calendarBrewing calendarreadbrews:read
run_calculatorRun a brewing calculatorreadsettings:read
list_importsList import runsreadsettings:read
undo_importUndo an import rundestructivesettings:write

Community

Community feed and profiles, recipe sharing, feedback, support tickets, inbox and changelog. (20 tools)

ToolWhat it doesScope
browse_communityBrowse the community feed or discover brewersreadcommunity:read
get_brewer_profileGet a brewer's community profilereadcommunity:read
interact_with_brewerFollow, unfollow, block or report a brewerwritecommunity:write
cheer_brewCheer another brewer's beerwritecommunity:write
update_community_profileUpdate the community profile and shared recipeswritecommunity:write
adopt_shared_recipeCopy a shared recipe into the user's brewswritebrews:write
find_feedback_threadsFind feedback threads (feature requests, questions, roadmap)readcommunity:read
get_feedback_threadRead a feedback threadreadcommunity:read
post_feedbackPost a feature request, question or reply in Feedbackwritecommunity:write
edit_feedback_postEdit the user's own Feedback postwritecommunity:write
delete_feedback_postDelete the user's own Feedback postdestructivecommunity:write
react_to_feedbackVote, follow, accept an answer or report in Feedbackwritecommunity:write
answer_feedback_questionnaireAnswer a feedback questionnairewritecommunity:write
contact_supportReport a problem to support, or reply on a ticketwritecommunity:write
get_inboxInbox: support tickets, team messages and notificationsreadcommunity:read
mark_inbox_readMark inbox items as read or archive messageswritecommunity:write
get_changelogWhat's new in BrewForgereadcommunity:read
get_account_overviewPlan, limits, bounty points and referralsreadcommunity:read
redeem_bounty_codeRedeem a bounty codewritecommunity:write
export_my_dataExport the user's account data (JSON)readread

On this page