{"openapi":"3.1.0","info":{"title":"Franchisecompare API","version":"0.1.0","description":"A fully local, brand-neutral franchise cost-structure comparison toolkit: total-cost-of-ownership comparison across caller-supplied options, a break-even timeline estimator, an FDD red-flags checklist, and a franchise glossary.\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://franchisecompare.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"hr@unifydynamics.com","url":"https://connectorbay.com/franchisecompare/docs"},"termsOfService":"https://connectorbay.com/franchisecompare/terms"},"servers":[{"url":"https://franchisecompare.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/franchisecompare/docs"},"security":[{},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/franchise_cost_comparison":{"post":{"operationId":"franchise_cost_comparison","summary":"Computes a total-cost-of-ownership-style comparison across 2+ hypothetical franchise options: for","description":"Computes a total-cost-of-ownership-style comparison across 2+ hypothetical franchise options: for\n    each, ongoing fees (royalty + marketing fund) as a percentage of revenue over N years, plus the total\n    dollar cost of ownership. Options are ranked lowest fee-burden-percentage first. Use for \"compare these\n    franchise fee structures over 5 years\", \"which of these two options has the lower total fee burden\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"options":{"description":"2+ options, each: {name, franchise_fee, royalty_pct, marketing_fund_pct, estimated_annual_revenue}. Use your own hypothetical or self-researched numbers, never a real brand's confidential figures without permission.","items":{"additionalProperties":true,"type":"object"},"minItems":2,"title":"Options","type":"array"},"years":{"default":5,"description":"Comparison period in years.","maximum":30,"minimum":1,"title":"Years","type":"integer"}},"required":["options"],"title":"franchise_cost_comparisonArguments","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/breakeven_timeline":{"post":{"operationId":"breakeven_timeline","summary":"Estimates months/years to break even given startup costs and a projected steady-state monthly","description":"Estimates months/years to break even given startup costs and a projected steady-state monthly\n    profit, plus a milestone table showing cumulative profit and percent of startup cost recovered at each\n    milestone month. Use for \"when does this franchise pay back its startup cost\", \"how long to break even\n    at $X/month profit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"startup_costs":{"description":"Total upfront investment (franchise fee + build-out + equipment + working capital, etc.).","minimum":0,"title":"Startup Costs","type":"number"},"monthly_profit":{"description":"Projected steady-state monthly profit (can be negative or zero).","title":"Monthly Profit","type":"number"},"milestone_months":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"default":null,"description":"Months at which to show cumulative recovery. Default 6, 12, 24, 36, 60.","title":"Milestone Months"}},"required":["startup_costs","monthly_profit"],"title":"breakeven_timelineArguments","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/fdd_red_flags_checklist":{"post":{"operationId":"fdd_red_flags_checklist","summary":"A hand-curated checklist of red flags to look for in a Franchise Disclosure Document (FDD): high","description":"A hand-curated checklist of red flags to look for in a Franchise Disclosure Document (FDD): high\n    franchisee turnover/closures (Item 20), litigation and bankruptcy history (Items 3-4), an unusually wide\n    initial-investment range and missing Item 19 financial performance data, and other structural issues\n    (supplier kickbacks, weak territory protection, one-sided renewal terms). Use for \"what red flags should\n    I look for in an FDD\", \"is a wide investment range a bad sign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"category":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"franchisee-turnover | litigation-history | investment-range-spread | other; omit for the full checklist.","title":"Category"}},"title":"fdd_red_flags_checklistArguments","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/franchise_glossary":{"post":{"operationId":"franchise_glossary","summary":"Defines common franchise-evaluation terms: FDD, franchise fee, royalty, marketing/ad fund, Item 19,","description":"Defines common franchise-evaluation terms: FDD, franchise fee, royalty, marketing/ad fund, Item 19,\n    Item 20, encroachment, territory, total cost of ownership, break-even point. Use for \"what does Item 19\n    mean\", \"what is encroachment in franchising\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A term to define, e.g. 'Item 19' or 'encroachment'. Omit for the full glossary.","title":"Term"}},"title":"franchise_glossaryArguments","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}}}}