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: trueand return a preview instead (details). - Scope: what an API token needs: this area scope or the umbrella scope
read/write. Apps connected with OAuth havereadorwrite. - Plan feature: the tool also needs this feature of your plan; without it the call returns
TIER_REQUIREDwith the plan that includes it. - Parameters: the JSON input. Required ones are marked;
ingredients[].amount_gis a field of each item of theingredientslist. 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)
| Tool | What it does | Scope |
|---|---|---|
get_started | Get started | read |
Brewing
Recipes and brews, brew day, fermentation readings, evaluations and devices. (33 tools)
| Tool | What it does | Scope |
|---|---|---|
find_brews | Find brews | readbrews:read |
get_brew | Get a brew | readbrews:read |
find_recipes | Browse the recipe book | readbrews:read |
create_brew | Create a recipe / brew | writebrews:write |
update_recipe | Edit a brew's recipe | writebrews:write |
update_brew | Rename, date, tag or pin a brew | writebrews:write |
set_brew_status | Change a brew's status | writebrews:write |
copy_brew | Brew again, new version or copy as new recipe | writebrews:write |
share_brew | Turn a brew's share link on or off | writebrews:write |
convert_imported_brew | Make an imported recipe editable | writebrews:write |
import_recipe | Import a recipe (BeerXML or MMuM) | writebrews:write |
export_brew | Export a brew (BeerXML, JSON, PDF sheets) | readbrews:read |
delete_brew | Delete a brew | destructivebrews:write |
get_brew_day_plan | Get the brew day plan | readbrews:read |
record_brew_measurements | Record brew day measurements | writebrews:write |
deduct_brew_ingredients | Deduct a brew's ingredients from stock | writeinventory:write |
log_fermentation_reading | Log a fermentation reading | writebrews:write |
get_fermentation | Get fermentation status and readings | readbrews:read |
delete_fermentation_readings | Delete fermentation readings | destructivebrews:write |
plan_carbonation | Plan carbonation (priming sugar or keg pressure) | writebrews:write |
save_brew_note | Add or edit a brew note | writebrews:write |
list_brew_notes | List a brew's notes | readbrews:read |
delete_brew_note | Delete a brew note | destructivebrews:write |
set_brew_custom_fields | Set custom field values on a brew | writebrews:write |
rate_brew | Rate a brew (quick star rating) | writebrews:write |
save_scoresheet | Fill in a BJCP or Lagerbernd scoresheet | writebrews:write |
list_evaluations | List a brew's ratings and scoresheets | readbrews:read |
delete_evaluation | Delete a rating or scoresheet | destructivebrews:write |
set_evaluation_link | Turn the public evaluation link on or off | writebrews:write |
list_devices | List fermentation devices | readbrews:read |
add_device | Add a fermentation device | writebrews:write |
update_device | Attach a device to a brew or change its settings | writebrews:write |
delete_device | Delete a device | destructivebrews:write |
Cellar
Cellar vessels, packaging, packaged stock, tap lists and labels. (23 tools)
| Tool | What it does | Scope |
|---|---|---|
get_cellar | Cellar overview: what is in which vessel | readcellar:read |
save_stay | Put a beer in a vessel, or change a stay | writecellar:write |
end_stay | Empty a vessel today (end a stay) | writecellar:write |
plan_brew_cellar | Plan a brew's path through the cellar | writecellar:write |
move_brew_day | Move a brew day and its planned cellar stays | writebrews:write |
save_cellar_vessel | Add or edit a vessel or bottle/can container | writecellar:write |
delete_cellar_item | Delete a stay, vessel or container | destructivecellar:write |
get_packaging_context | Before packaging: volume, free kegs, bottles | readcellar:read |
package_beer | Package beer into kegs, bottles or cans | writecellar:write |
get_beer_stock | Beer on hand: kegs, bottles and cans | readcellar:read |
update_keg | Update a keg: litres left, pour, empty, sensor | writecellar:write |
update_bottle_stock | Change bottle/can stock | writecellar:write |
undo_stock_change | Undo a keg or bottle stock change | writecellar:write |
get_taplist | Tap lists: beers, taps, menus and screens | readcellar:read |
save_tap_list | Create or edit a tap list | writecellar:write |
save_taplist_beer | Add a beer to a tap list, or change it | writecellar:write |
manage_tap | Taps: put a beer on, next up, add/rename taps | writecellar:write |
manage_taplist_sharing | Menus, TV screens and guest links of tap lists | writecellar:write |
delete_taplist_item | Delete a tap list, beer, tap, menu or screen | destructivecellar:write |
get_labels | Label templates and the label text of brews | readcellar:read |
save_label_template | Create, edit or copy a label template | writecellar:write |
delete_label_template | Delete a label template | destructivecellar:write |
set_trmnl_screen | Choose what a TRMNL e-ink screen shows | writecellar:write |
Inventory
Ingredient stock, ingredient catalog, packages, orders and the planner (what am I short of). (16 tools)
| Tool | What it does | Scope |
|---|---|---|
find_stock | Find ingredient stock | readinventory:read |
add_stock | Add ingredient stock | writeinventory:write |
update_stock | Use up, correct or edit stock | writeinventory:write |
remove_stock | Remove a stock row | destructiveinventory:write |
find_ingredients | Find ingredients | readinventory:read |
save_custom_ingredient | Create or edit an own ingredient | writeinventory:write |
delete_custom_ingredient | Delete an own ingredient | destructiveinventory:write |
get_ingredient_packages | List or open ingredient packages | readinventory:read |
select_package_ingredients | Pick ingredients from a package | writeinventory:write |
get_orders | List orders or open one | readinventory:read |
save_order | Create or edit an order | writeinventory:write |
edit_order_items | Add, change or remove order lines | writeinventory:write |
receive_order | Receive an order into stock | writeinventory:write |
delete_order | Delete an order | destructiveinventory:write |
get_planner | Plan ingredients for planned brews | readinventory:read |
create_order_from_shortages | Order what the planned brews are short of | writeinventory:write |
Setup
Profiles (equipment, mash, water, fermentation), styles, custom fields, preferences, calendar, analysis, calculators, imports and exports. (19 tools)
| Tool | What it does | Scope |
|---|---|---|
find_profiles | Find profiles | readprofiles:read |
get_profile | Get a profile with all settings | readprofiles:read |
create_profile | Create a profile | writeprofiles:write |
update_profile | Change a profile | writeprofiles:write |
delete_profile | Delete a profile | destructiveprofiles:write |
apply_profile | Apply a profile to brews | destructivebrews:write |
find_styles | Find beer styles | readstyles:read |
save_style | Create or change an own style | writestyles:write |
delete_style | Delete an own style | destructivestyles:write |
list_custom_fields | List custom field definitions | readcustom-fields:read |
save_custom_field | Create, change or archive a custom field | writecustom-fields:write |
delete_custom_field | Delete a custom field for good | destructivecustom-fields:write |
get_preferences | Get preferences | readsettings:read |
update_preferences | Change preferences | writesettings:write |
reset_preferences | Reset preferences to defaults | destructivesettings:write |
get_calendar | Brewing calendar | readbrews:read |
run_calculator | Run a brewing calculator | readsettings:read |
list_imports | List import runs | readsettings:read |
undo_import | Undo an import run | destructivesettings:write |
Community
Community feed and profiles, recipe sharing, feedback, support tickets, inbox and changelog. (20 tools)
| Tool | What it does | Scope |
|---|---|---|
browse_community | Browse the community feed or discover brewers | readcommunity:read |
get_brewer_profile | Get a brewer's community profile | readcommunity:read |
interact_with_brewer | Follow, unfollow, block or report a brewer | writecommunity:write |
cheer_brew | Cheer another brewer's beer | writecommunity:write |
update_community_profile | Update the community profile and shared recipes | writecommunity:write |
adopt_shared_recipe | Copy a shared recipe into the user's brews | writebrews:write |
find_feedback_threads | Find feedback threads (feature requests, questions, roadmap) | readcommunity:read |
get_feedback_thread | Read a feedback thread | readcommunity:read |
post_feedback | Post a feature request, question or reply in Feedback | writecommunity:write |
edit_feedback_post | Edit the user's own Feedback post | writecommunity:write |
delete_feedback_post | Delete the user's own Feedback post | destructivecommunity:write |
react_to_feedback | Vote, follow, accept an answer or report in Feedback | writecommunity:write |
answer_feedback_questionnaire | Answer a feedback questionnaire | writecommunity:write |
contact_support | Report a problem to support, or reply on a ticket | writecommunity:write |
get_inbox | Inbox: support tickets, team messages and notifications | readcommunity:read |
mark_inbox_read | Mark inbox items as read or archive messages | writecommunity:write |
get_changelog | What's new in BrewForge | readcommunity:read |
get_account_overview | Plan, limits, bounty points and referrals | readcommunity:read |
redeem_bounty_code | Redeem a bounty code | writecommunity:write |
export_my_data | Export the user's account data (JSON) | readread |