File size: 9,287 Bytes
c09f67c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | import {
getBalanceSheetSchema,
getBurnRateSchema,
getCashFlowSchema,
getExpensesSchema,
getGrowthRateSchema,
getProfitMarginSchema,
getProfitSchema,
getRecurringExpensesSchema,
getRevenueForecastSchema,
getRevenueSchema,
getRunwaySchema,
getSpendingSchema,
getTaxSummarySchema,
} from "@api/schemas/reports";
import {
getBalanceSheet,
getBurnRate,
getCashFlow,
getExpenses,
getGrowthRate,
getProfitMargin,
getRecurringExpenses,
getReports,
getRevenueForecast,
getRunway,
getSpending,
getTaxSummary,
} from "@midday/db/queries";
import { hasScope, READ_ONLY_ANNOTATIONS, type RegisterTools } from "../types";
export const registerReportTools: RegisterTools = (server, ctx) => {
const { db, teamId } = ctx;
// Require reports.read scope
if (!hasScope(ctx, "reports.read")) {
return;
}
server.registerTool(
"reports_revenue",
{
title: "Revenue Report",
description:
"Get revenue reports for a date range. Returns total revenue with comparisons to previous period.",
inputSchema: getRevenueSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getReports(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
type: "revenue",
revenueType: params.revenueType,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_profit",
{
title: "Profit Report",
description:
"Get profit reports for a date range. Returns profit with revenue minus expenses.",
inputSchema: getProfitSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getReports(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
type: "profit",
revenueType: params.revenueType,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_burn_rate",
{
title: "Burn Rate Report",
description:
"Get burn rate (monthly spending) for a date range. Useful for understanding cash outflow.",
inputSchema: getBurnRateSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getBurnRate(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_runway",
{
title: "Runway Report",
description:
"Get runway estimate (months of cash remaining based on burn rate). Critical for financial planning.",
inputSchema: getRunwaySchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getRunway(db, {
teamId,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_expenses",
{
title: "Expenses Report",
description:
"Get expense reports for a date range. Returns expenses with recurring vs one-time breakdown.",
inputSchema: getExpensesSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getExpenses(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_spending",
{
title: "Spending by Category",
description:
"Get spending breakdown by category for a date range. Shows where money is being spent.",
inputSchema: getSpendingSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getSpending(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_tax_summary",
{
title: "Tax Summary Report",
description:
"Get tax summary for a date range. Shows total tax paid or collected, grouped by category and tax type.",
inputSchema: getTaxSummarySchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getTaxSummary(db, {
teamId,
from: params.from,
to: params.to,
type: params.type,
currency: params.currency,
categorySlug: params.categorySlug,
taxType: params.taxType,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_growth_rate",
{
title: "Growth Rate Report",
description:
"Get revenue or profit growth rate comparing current period to previous period. Supports monthly, quarterly, or yearly comparisons.",
inputSchema: getGrowthRateSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getGrowthRate(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
type: params.type,
revenueType: params.revenueType,
period: params.period,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_profit_margin",
{
title: "Profit Margin Report",
description:
"Get profit margin analysis for a date range. Shows profit as percentage of revenue with monthly breakdown and trend.",
inputSchema: getProfitMarginSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getProfitMargin(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
revenueType: params.revenueType,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_cash_flow",
{
title: "Cash Flow Report",
description:
"Get cash flow analysis showing income vs expenses over time. Includes monthly breakdown and net cash flow.",
inputSchema: getCashFlowSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getCashFlow(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
period: params.period,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_recurring_expenses",
{
title: "Recurring Expenses Report",
description:
"Get list of recurring expenses with frequency breakdown (weekly, monthly, annually). Shows top recurring costs.",
inputSchema: getRecurringExpensesSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getRecurringExpenses(db, {
teamId,
from: params.from,
to: params.to,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_revenue_forecast",
{
title: "Revenue Forecast Report",
description:
"Get revenue forecast based on historical data, outstanding invoices, billable hours, and scheduled invoices. Projects future revenue.",
inputSchema: getRevenueForecastSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getRevenueForecast(db, {
teamId,
from: params.from,
to: params.to,
forecastMonths: params.forecastMonths,
currency: params.currency,
revenueType: params.revenueType,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
server.registerTool(
"reports_balance_sheet",
{
title: "Balance Sheet Report",
description:
"Get balance sheet showing assets, liabilities, and equity. Provides a snapshot of financial position as of a specific date.",
inputSchema: getBalanceSheetSchema.shape,
annotations: READ_ONLY_ANNOTATIONS,
},
async (params) => {
const result = await getBalanceSheet(db, {
teamId,
asOf: params.asOf,
currency: params.currency,
});
return {
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
};
},
);
};
|