BrewForge Docs

Setup tools

Every tool of the setup toolset of the BrewForge MCP server and actions API, with access, scope, plan feature and parameters.

Profiles, styles, custom fields, preferences, calendar, analysis, calculators, imports and exports. Every tool here is an MCP tool on https://brewforge.sh/api/mcp?toolsets=setup and an action at POST /api/v1/actions/<name>. This page is generated from the API itself; see the tool reference for how to read it.

find_profiles

Find profiles

readScope: profiles:readAPI reference

List the brewer's own profiles: equipment, mash, fermentation, water and hop stand curves, with the default of each kind marked is_default. Each row has a one-line summary (batch size, mash steps, fermentation stages, water ions). Use get_profile for every setting. With templates: true it lists the ready-made templates BrewForge offers instead (e.g. Grainfather G30, Burton on Trent water); add one with create_profile { template }. Volumes in litres, temperatures in °C, ions in mg/L.

Prop

Type

get_profile

Get a profile with all settings

readScope: profiles:readAPI reference

Every setting of one profile, in the same field names create_profile and update_profile take (litres, °C, minutes, mg/L). For equipment profiles, include: ["evaporation"] adds the measured boil-off of past brews with this equipment (pre/post-boil volumes) compared to the profile's boil_off_rate, to answer "what is my real boil-off?". Call find_profiles first if you do not know the name.

Prop

Type

create_profile

Create a profile

writeScope: profiles:writePlan feature: profilesAPI reference

Create an equipment, mash, fermentation, water or hop stand profile. Three ways: (1) new, with the settings object of its kind (equipment needs only batch_volume_l, everything else gets the app defaults; mash needs steps; fermentation needs stages; hop_stand needs points; water takes the ions); (2) copy_from an own profile of the same kind (duplicate); (3) template: add a BrewForge template (see find_profiles { templates: true }). With copy_from or template, settings you send override the copy. is_default: true makes it the default for new brews. Example: {"kind": "water", "name": "Tap water", "water": {"calcium_ppm": 80, "magnesium_ppm": 12, "sodium_ppm": 20, "chloride_ppm": 60, "sulfate_ppm": 110, "bicarbonate_ppm": 150}}. Returns the profile with all settings (litres, °C, minutes, mg/L).

Prop

Type

update_profile

Change a profile

writeScope: profiles:writePlan feature: profilesAPI reference

Change some settings of one own profile; everything you do not send stays as it is. Rename with name, make it the default for new brews with is_default: true. Settings go into the object of the profile's kind, e.g. {"kind": "equipment", "profile": "Grainfather G30", "equipment": {"boil_off_rate": 3.2}}. Mash steps, fermentation stages and hop stand points are replaced as a whole list. Brews keep their own copy of a profile: to push the change into planned brews afterwards, call apply_profile. Returns the profile with all settings.

Prop

Type

delete_profile

Delete a profile

destructiveScope: profiles:writePlan feature: profilesAPI reference

Permanently delete one own profile (equipment, mash, fermentation, water or hop stand curve). Without confirm: true it only shows what would be deleted. Brews keep their own copy of the settings, so no brew changes; they just stop being linked to it. Deleting the default leaves the kind without a default until you set one (update_profile is_default).

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

apply_profile

Apply a profile to brews

destructiveScope: brews:writePlan feature: profilesAPI reference

Push an equipment, mash or fermentation profile into brews. Brews keep their own copy of profiles, so changing a profile does not change existing brews until you apply it. With brew: replace that one brew's equipment / mash steps / fermentation stages with the profile (equipment with scale_recipe: true also scales the ingredient amounts to the new batch size; idea/planned brews only). Without brew: refresh every idea/planned brew that is linked to this profile. Without confirm: true it only returns how many brews would change. Imported brews get a new version instead of being changed.

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

find_styles

Find beer styles

readScope: styles:readAPI reference

Search beer styles by name, style number or category: the BJCP 2021 library (source "library", id = style number like "21A") and the brewer's own styles (source "mine"). Each row has the style's ranges as [min, max]: og_sg / fg_sg (SG), ibu, color_ebc (EBC, as brews report color) and color_srm (SRM, as in the guidelines), abv_pct. Example: {"query": "ipa"} or {"category": "Pale Bitter European Beer"}. To use a library style as a base for your own, call save_style { from_library }.

Prop

Type

save_style

Create or change an own style

writeScope: styles:writeAPI reference

Create or change one of the brewer's own beer styles (the BJCP library itself is read-only). Three ways: (1) style given: change that own style, only the fields you send; (2) from_library: copy a BJCP 2021 style (e.g. "21A") as an own style, then apply the fields you send; (3) neither: create a new style (name required). Ranges: og/fg in SG (e.g. og_min_sg 1.056), ibu, color in SRM (or EBC with color_unit "ebc"), abv in %. null clears a value. Returns the saved style with its ranges.

Prop

Type

delete_style

Delete an own style

destructiveScope: styles:writeAPI reference

Permanently delete one of the brewer's own beer styles (library styles cannot be deleted). Without confirm: true it only shows what would be deleted. Recipes keep the style values they copied, so no brew changes.

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

list_custom_fields

List custom field definitions

readScope: custom-fields:readAPI reference

The brewer's own custom fields: extra values they record on brews (scope "brew", shown in a section given by placement: brew_details, brew_day, fermentation, packaging, tasting) or on brew notes (scope "brew_note"). Each has a key, name, type (text, number, integer, date, time, datetime, boolean, select, url), choices for select fields, unit and default. Archived fields are hidden in the app; include_archived: true lists them too. Create or change them with save_custom_field.

Prop

Type

save_custom_field

Create, change or archive a custom field

writeScope: custom-fields:writeAPI reference

Create a custom field definition (omit field) or change one (field = its key, name or id). Brew fields (scope "brew", default) need a placement: the brew page section they appear in. Brew note fields (scope "brew_note") have no placement. Type and scope are fixed after creation. archived: true hides a field in the app (values stay), false restores it; delete it for good with delete_custom_field. Example: {"name": "Mash pH", "type": "number", "placement": "brew_day", "unit": "pH"}. Values on brews are set with the brewing tools.

Prop

Type

delete_custom_field

Delete a custom field for good

destructiveScope: custom-fields:writeAPI reference

Permanently delete a custom field definition and every value recorded for it on brews and brew notes. Without confirm: true it only returns the impact (how many brews and notes have a value). To only hide a field and keep its values, use save_custom_field { archived: true } instead.

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

get_preferences

Get preferences

readScope: settings:readAPI reference

The brewer's settings: units and formats the app shows (volume, weight, temperature, gravity, color, pressure, CO2, currency, date format), IBU formula, efficiency convention, language, brew-day recalculation mode, defaults for new brews (default profiles, brewer name, next batch number floor, default additions, default bittering hop) and the calendar feed (iCal URL and filters). Change them with update_preferences. Tools always take and return canonical units; these settings only say how the user reads values.

No parameters.

update_preferences

Change preferences

writeScope: settings:writeAPI reference

Change the brewer's settings; only what you send changes. Units/formats: e.g. {"volume_unit": "gallons", "temperature_unit": "fahrenheit", "gravity_format": "sg"}. Defaults for new brews: default_equipment_profile / _mash_ / _fermentation_ / _water_profile (own profile by name), brewer_name, batch_number_floor, default_additions (replaces the list). Calendar: calendar_feed "enable" (returns the iCal URL), "regenerate" (new URL, old one stops working) or "disable", and calendar_feed_settings. Returns all preferences like get_preferences. To go back to the default units use reset_preferences.

Prop

Type

reset_preferences

Reset preferences to defaults

destructiveScope: settings:writeAPI reference

Reset the brewer's settings to BrewForge's defaults (litres, kg, °C, °Plato, EBC, psi, CO2 volumes, EUR, European dates, Tinseth, international efficiency) and clear brewer name, batch number floor, default additions, default bittering hop, brewery logo and water salt preferences. The language stays. Profiles and their defaults are not touched. Without confirm: true it lists exactly what would change. To change single settings use update_preferences instead.

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

get_calendar

Brewing calendar

readScope: brews:readAPI reference

Events of the brewing calendar in a date range, as the app's calendar shows them: planned and actual brew days, fermentation steps (dry hop, cold crash, ...), packaging days, ready-by / brew-by dates, reminders and (with the cellar feature) when kegs and fermenters are occupied or free. Default range: 7 days ago to 60 days ahead. Example: {"from": "2026-12-01", "to": "2026-12-31", "types": ["brew_day", "planned"]}. The iCal subscription URL is in get_preferences (calendar_feed).

Prop

Type

run_calculator

Run a brewing calculator

readScope: settings:readPlan feature: calculatorsAPI reference

BrewForge's brewing calculators: ABV, IBU, beer color, strike water, step mash, dilution, boil-off, hydrometer temperature correction, refractometer, priming sugar, force carbonation, spunding, yeast pitch rate, hop freshness and unit conversion. Use them instead of doing brewing math yourself. Call without calculator to get the list with each calculator's parameters and an example; then call with calculator and params. Example: {"calculator": "priming-sugar", "params": {"volume": 19, "co2": 2.4, "beerTemp": 18}}. Results carry their units.

Prop

Type

list_imports

List import runs

readScope: settings:readAPI reference

Recent imports from Brewfather (backup) and Kleiner Brauhelfer, newest first, with what each created (counts per kind: brews, profiles, inventory, ...) and whether it can still be undone (7 days after it finished). Undo one with undo_import. Imports themselves run in the app's import wizards (Settings → Import), which parse the files in the browser.

Prop

Type

undo_import

Undo an import run

destructiveScope: settings:writeAPI reference

Remove everything one Brewfather or Kleiner Brauhelfer import run created (brews with their readings, profiles, styles, inventory, own ingredients) and revert the stock it added. Possible for 7 days after the import. Brews with beer still in the cellar and ingredients still in use are kept and listed. Without confirm: true it only shows what the run created. Get the run id from list_imports.

Needs confirm: true; without it nothing changes and the response previews what would be removed.

Prop

Type

On this page