MCP Reference

Eight tools for your
AI assistant

The CostPad MCP server exposes your model over the Model Context Protocol. Any compliant client can read it, edit it, and run scenarios.

Draft schemas — parameter names and return shapes may change before the package is published.
get_simulationRead
Returns the current simulation inputs — COGS items, pricing tiers, user mix, add-ons, one-time purchases, and scalar parameters. Inspect what's loaded before running scenarios.
Parameters
section"all" | "cogs" | "tiers" | "mix" | "addOns" | "oneTimePurchases" | "scalars"Which section to return. Defaults to all. optional
Returns
cogs[]CostItemEach with name, type (fixed · per_user · per_unit), value, unitLabel, and category.
tiers[]TierName, price, units per user, color.
mix[]TierCountUser count per tier ({ tierId, count }).
addOns[] · oneTimePurchases[]object[]Add-on packs and one-time purchases.
scalarsobjectOperating params — fees, infra, churn, growth, etc.
get_economicsRead
Runs the calc engine on the current state and returns computed economics — revenue, margins, COGS, fees, free-tier impact, scale projections, and growth.
Parameters
sections[]"summary" | "tierMetrics" | "blended" | "fees" | "freeTier" | "scale" | "growth" | "addOns"Sections to include. Defaults to all. optional
Returns
summaryobjecttotalRevenue, totalCogs, grossProfit, grossMargin, totalUsers, paidUsers, freeUsers.
blendedobjectblendedARPU, blendedCOGS, blendedMargin, netRev.
feesobjectblendedFeePerSub, netRevAfterFees, marginAfterFees.
tierMetrics · freeTier · scale · growthobjectPer-tier metrics, free-tier impact, scale milestones, growth data.
get_growthRead
Month-by-month growth projection with optional parameter overrides — subscriber growth, revenue, costs, profit, and breakeven/payback months.
Parameters
monthlyChurnPctnumberMonthly churn rate (%). optional
monthlyNewSubsnumberNew subscribers per month. optional
growthRatenumberMonthly growth rate (%) for new subs. optional
monthsToProjectnumberMonths to project forward (1–120). optional
Returns
growthData[]object[]Per-month activeSubs, revenue, costs, profit, cumulativeProfit.
breakevenMonthnumberMonth the model turns cumulatively profitable.
paybackMonth · month12number · objectPayback month and the month-12 snapshot.
update_cogsWrite
Add, update, replace, or remove COGS items. Returns the updated COGS array.
Parameters
action"set" | "add" | "update" | "remove"set replaces all, add appends, update edits by id, remove deletes by id. required
items[]CostItemItems to set/add/update (not needed for remove). optional
ids[]stringIDs to delete (with action: "remove"). optional
update_tiersWrite
Add, update, replace, or remove pricing tiers. Mix entries are auto-synced when tiers change. Returns updated tiers and mix.
Parameters
action"set" | "add" | "update" | "remove"Same semantics as update_cogs. required
tiers[]TierTiers to set/add/update. optional
ids[]stringTier IDs to remove. optional
update_mixWrite
Set user counts per tier. Only listed tiers are updated; others keep their current count. Useful for pushing live subscriber counts from a billing provider.
Parameters
mix[]{ tierId, count }[]Tier-to-user-count mappings. required
run_scenarioCompute
Run a what-if by temporarily overriding any parameters — does NOT change stored state. The most powerful tool for exploring pricing changes.
Parameters
overridesobjectAny params to override (cogs, tiers, mix, addOns, fees, churn, growth…). Unspecified use current state. required
comparebooleanIf true, also return baseline + a diff. Default false. optional
Returns
economicsEconomicsScenario result when compare is false/omitted.
{ baseline, scenario, diff }objectReturned when compare is true.
export_reportCompute
Generate a formatted pricing report of the current simulation, as Markdown or JSON.
Parameters
format"markdown" | "json"Output format. Defaults to markdown. optional
sections[]"overview" | "cogs" | "tiers" | "blended" | "fees" | "freeTier" | "scale" | "growth"Sections to include. Defaults to all. optional

Connect your assistant

Run the MCP server and point Claude, Cursor, or Windsurf at your model.

MCP server setupRead the docs