{"openapi":"3.1.0","info":{"title":"Brewfather (BYOK) API","version":"0.1.0","description":"Brewfather (BYOK) lets an AI assistant read your own Brewfather data through the Brewfather API with a key you supply (Brewfather user id). Read-only: 11 tools (list_batches, get_batch, get_batch_last_reading, list_batch_readings, get_batch_brew_tracker, list_recipes, get_recipe, list_fermentables, list_hops, list_yeasts, list_miscs). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-brewfather.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-brewfather/docs"},"termsOfService":"https://connectorbay.com/byok-brewfather/terms"},"servers":[{"url":"https://byok-brewfather.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-brewfather/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_batches":{"post":{"operationId":"list_batches","summary":"List your brew batches (name, number, status, brewer, brew date, recipe name); filter by status and page with start_afte","description":"List your brew batches (name, number, status, brewer, brew date, recipe name); filter by status and page with start_after. Use for \"Which of my Brewfather batches are fermenting right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["Planning","Brewing","Fermenting","Conditioning","Completed","Archived"],"type":"string"},{"type":"null"}],"default":null,"description":"Only batches in this status.","title":"Status"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"order_by_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction by _id: asc or desc (default asc).","title":"Order By Direction"}},"title":"list_batchesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_batch":{"post":{"operationId":"get_batch","summary":"Get one batch: status, dates, estimated and measured gravity, IBU, colour, ABV, attenuation, volumes and taste rating. U","description":"Get one batch: status, dates, estimated and measured gravity, IBU, colour, ABV, attenuation, volumes and taste rating. Use for \"What was the final gravity and ABV of my batch abc123BatchId\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch _id as returned by list_batches.","maxLength":200,"title":"Batch Id","type":"string"}},"required":["batch_id"],"title":"get_batchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_batch_last_reading":{"post":{"operationId":"get_batch_last_reading","summary":"Get the latest fermentation reading of a batch: gravity, temperature, pH, pressure and source device type. Use for \"What","description":"Get the latest fermentation reading of a batch: gravity, temperature, pH, pressure and source device type. Use for \"What is the latest gravity reading of batch abc123BatchId\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch _id as returned by list_batches.","maxLength":200,"title":"Batch Id","type":"string"}},"required":["batch_id"],"title":"get_batch_last_readingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_batch_readings":{"post":{"operationId":"list_batch_readings","summary":"List all stored fermentation readings of a batch (time, gravity, temperature, pH, source), oldest first. Use for \"Show t","description":"List all stored fermentation readings of a batch (time, gravity, temperature, pH, source), oldest first. Use for \"Show the gravity curve readings of batch abc123BatchId\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch _id as returned by list_batches.","maxLength":200,"title":"Batch Id","type":"string"}},"required":["batch_id"],"title":"list_batch_readingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_batch_brew_tracker":{"post":{"operationId":"get_batch_brew_tracker","summary":"Get the stored brew tracker state of a batch: whether it is enabled or completed, the current stage and the stages (empt","description":"Get the stored brew tracker state of a batch: whether it is enabled or completed, the current stage and the stages (empty when no tracker is active). Use for \"Where is the brew tracker for batch abc123BatchId\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch _id as returned by list_batches.","maxLength":200,"title":"Batch Id","type":"string"}},"required":["batch_id"],"title":"get_batch_brew_trackerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_recipes":{"post":{"operationId":"list_recipes","summary":"List your recipes (name, author, type, style, equipment); page with start_after. Use for \"What recipes do I have in Brew","description":"List your recipes (name, author, type, style, equipment); page with start_after. Use for \"What recipes do I have in Brewfather\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"order_by_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction by _id: asc or desc (default asc).","title":"Order By Direction"}},"title":"list_recipesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_recipe":{"post":{"operationId":"get_recipe","summary":"Get one recipe with style, volumes, expected OG/FG/ABV/IBU/colour and its fermentables, hops, yeasts and misc ingredient","description":"Get one recipe with style, volumes, expected OG/FG/ABV/IBU/colour and its fermentables, hops, yeasts and misc ingredients. Use for \"What is in my recipe rec1 and what ABV and IBU will it have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recipe_id":{"description":"Recipe _id as returned by list_recipes.","maxLength":200,"title":"Recipe Id","type":"string"}},"required":["recipe_id"],"title":"get_recipeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_fermentables":{"post":{"operationId":"list_fermentables","summary":"List your Brewfather fermentable (malt and sugar) inventory (items you added or changed) with stock amount and key prope","description":"List your Brewfather fermentable (malt and sugar) inventory (items you added or changed) with stock amount and key properties; units are metric. Use for \"Which malts do I have in stock in Brewfather\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inventory_exists":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"True to list only fermentable (malt and sugar) with stock above zero, ordered by stock.","title":"Inventory Exists"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"complete":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"Pass True to return every field of each item instead of the default short set.","title":"Complete"}},"title":"list_fermentablesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_hops":{"post":{"operationId":"list_hops","summary":"List your Brewfather hop inventory (items you added or changed) with stock amount and key properties; units are metric. ","description":"List your Brewfather hop inventory (items you added or changed) with stock amount and key properties; units are metric. Use for \"How much of each hop do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inventory_exists":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"True to list only hop with stock above zero, ordered by stock.","title":"Inventory Exists"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"complete":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"Pass True to return every field of each item instead of the default short set.","title":"Complete"}},"title":"list_hopsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_yeasts":{"post":{"operationId":"list_yeasts","summary":"List your Brewfather yeast inventory (items you added or changed) with stock amount and key properties; units are metric","description":"List your Brewfather yeast inventory (items you added or changed) with stock amount and key properties; units are metric. Use for \"Which yeasts do I have in my Brewfather inventory\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inventory_exists":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"True to list only yeast with stock above zero, ordered by stock.","title":"Inventory Exists"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"complete":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"Pass True to return every field of each item instead of the default short set.","title":"Complete"}},"title":"list_yeastsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_miscs":{"post":{"operationId":"list_miscs","summary":"List your Brewfather miscellaneous ingredient (spices, finings, water salts) inventory (items you added or changed) with","description":"List your Brewfather miscellaneous ingredient (spices, finings, water salts) inventory (items you added or changed) with stock amount and key properties; units are metric. Use for \"What misc ingredients are in my Brewfather inventory\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"inventory_exists":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"True to list only miscellaneous ingredient (spices, finings, water salts) with stock above zero, ordered by stock.","title":"Inventory Exists"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 50, default 10).","title":"Limit"},"start_after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"The _id of the last item of the previous page, to get the next page.","title":"Start After"},"complete":{"anyOf":[{"enum":["True","False"],"type":"string"},{"type":"null"}],"default":null,"description":"Pass True to return every field of each item instead of the default short set.","title":"Complete"}},"title":"list_miscsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}