@dizzlkheinz/ynab-mcpb 0.18.3 → 0.19.0

package/src/tools/schemas/outputs/transactionOutputs.ts

@@ -89,8 +89,8 @@
  * ```
  */
 
-import { z } from 'zod/v4';
-import { CacheMetadataSchema } from '../shared/commonOutputs.js';
+import { z } from "zod/v4";
+import { CacheMetadataSchema } from "../shared/commonOutputs.js";
 
 /**
  * Schema for a complete transaction object.
@@ -98,59 +98,65 @@ import { CacheMetadataSchema } from '../shared/commonOutputs.js';
  * Represents full transaction data with amounts in dollars (converted from YNAB milliunits).
  */
 export const TransactionSchema = z.object({
-  /** Unique identifier for the transaction */
-  id: z.string().describe('Transaction ID'),
+	/** Unique identifier for the transaction */
+	id: z.string().describe("Transaction ID"),
 
-  /** Transaction date (YYYY-MM-DD format) */
-  date: z.string().describe('Transaction date'),
+	/** Transaction date (YYYY-MM-DD format) */
+	date: z.string().describe("Transaction date"),
 
-  /** Transaction amount in dollars (negative for outflows, positive for inflows) */
-  amount: z.number().describe('Transaction amount in dollars'),
+	/** Transaction amount in dollars (negative for outflows, positive for inflows) */
+	amount: z.number().describe("Transaction amount in dollars"),
 
-  /** Optional transaction memo */
-  memo: z.string().optional().describe('Transaction memo'),
+	/** Optional transaction memo */
+	memo: z.string().optional().describe("Transaction memo"),
 
-  /** Cleared status (uncleared, cleared, reconciled) */
-  cleared: z.string().describe('Cleared status'),
+	/** Cleared status (uncleared, cleared, reconciled) */
+	cleared: z.string().describe("Cleared status"),
 
-  /** Whether transaction is approved */
-  approved: z.boolean().describe('Approved flag'),
+	/** Whether transaction is approved */
+	approved: z.boolean().describe("Approved flag"),
 
-  /** Optional flag color */
-  flag_color: z.string().optional().describe('Flag color'),
+	/** Optional flag color */
+	flag_color: z.string().optional().describe("Flag color"),
 
-  /** Account ID for this transaction */
-  account_id: z.string().describe('Account ID'),
+	/** Account ID for this transaction */
+	account_id: z.string().describe("Account ID"),
 
-  /** Optional payee ID */
-  payee_id: z.string().nullish().describe('Payee ID'),
+	/** Optional payee ID */
+	payee_id: z.string().nullish().describe("Payee ID"),
 
-  /** Optional category ID */
-  category_id: z.string().nullish().describe('Category ID'),
+	/** Optional category ID */
+	category_id: z.string().nullish().describe("Category ID"),
 
-  /** Optional transfer account ID (for transfer transactions) */
-  transfer_account_id: z.string().nullish().describe('Transfer account ID'),
+	/** Optional transfer account ID (for transfer transactions) */
+	transfer_account_id: z.string().nullish().describe("Transfer account ID"),
 
-  /** Optional transfer transaction ID (for transfer transactions) */
-  transfer_transaction_id: z.string().nullish().describe('Transfer transaction ID'),
+	/** Optional transfer transaction ID (for transfer transactions) */
+	transfer_transaction_id: z
+		.string()
+		.nullish()
+		.describe("Transfer transaction ID"),
 
-  /** Optional matched transaction ID (for imported transactions) */
-  matched_transaction_id: z.string().nullish().describe('Matched transaction ID'),
+	/** Optional matched transaction ID (for imported transactions) */
+	matched_transaction_id: z
+		.string()
+		.nullish()
+		.describe("Matched transaction ID"),
 
-  /** Optional import ID */
-  import_id: z.string().optional().describe('Import ID'),
+	/** Optional import ID */
+	import_id: z.string().optional().describe("Import ID"),
 
-  /** Whether transaction is deleted */
-  deleted: z.boolean().describe('Deleted flag'),
+	/** Whether transaction is deleted */
+	deleted: z.boolean().describe("Deleted flag"),
 
-  /** Account name (enriched field, optional) */
-  account_name: z.string().optional().describe('Account name'),
+	/** Account name (enriched field, optional) */
+	account_name: z.string().optional().describe("Account name"),
 
-  /** Payee name (enriched field, optional) */
-  payee_name: z.string().optional().describe('Payee name'),
+	/** Payee name (enriched field, optional) */
+	payee_name: z.string().optional().describe("Payee name"),
 
-  /** Category name (enriched field, optional) */
-  category_name: z.string().optional().describe('Category name'),
+	/** Category name (enriched field, optional) */
+	category_name: z.string().optional().describe("Category name"),
 });
 
 /**
@@ -159,23 +165,23 @@ export const TransactionSchema = z.object({
  * Subset of transaction fields shown in preview mode for large result sets.
  */
 export const TransactionPreviewSchema = z.object({
-  /** Unique identifier for the transaction */
-  id: z.string().describe('Transaction ID'),
+	/** Unique identifier for the transaction */
+	id: z.string().describe("Transaction ID"),
 
-  /** Transaction date (YYYY-MM-DD format) */
-  date: z.string().describe('Transaction date'),
+	/** Transaction date (YYYY-MM-DD format) */
+	date: z.string().describe("Transaction date"),
 
-  /** Transaction amount in dollars */
-  amount: z.number().describe('Transaction amount in dollars'),
+	/** Transaction amount in dollars */
+	amount: z.number().describe("Transaction amount in dollars"),
 
-  /** Optional transaction memo */
-  memo: z.string().optional().describe('Transaction memo'),
+	/** Optional transaction memo */
+	memo: z.string().optional().describe("Transaction memo"),
 
-  /** Payee name (enriched field, optional) */
-  payee_name: z.string().optional().describe('Payee name'),
+	/** Payee name (enriched field, optional) */
+	payee_name: z.string().optional().describe("Payee name"),
 
-  /** Category name (enriched field, optional) */
-  category_name: z.string().optional().describe('Category name'),
+	/** Category name (enriched field, optional) */
+	category_name: z.string().optional().describe("Category name"),
 });
 
 /**
@@ -184,11 +190,11 @@ export const TransactionPreviewSchema = z.object({
  * Returns all transactions when count <= 100.
  */
 const ListTransactionsNormalSchema = CacheMetadataSchema.extend({
-  /** Total number of transactions */
-  total_count: z.number().int().describe('Total transaction count'),
+	/** Total number of transactions */
+	total_count: z.number().int().describe("Total transaction count"),
 
-  /** Array of complete transaction objects */
-  transactions: z.array(TransactionSchema).describe('List of transactions'),
+	/** Array of complete transaction objects */
+	transactions: z.array(TransactionSchema).describe("List of transactions"),
 });
 
 /**
@@ -197,23 +203,25 @@ const ListTransactionsNormalSchema = CacheMetadataSchema.extend({
  * Returns a preview when count > 100 to avoid overwhelming responses.
  */
 const ListTransactionsPreviewSchema = z.object({
-  /** Message explaining large result set */
-  message: z.string().describe('Large result set message'),
+	/** Message explaining large result set */
+	message: z.string().describe("Large result set message"),
 
-  /** Suggestion to narrow results */
-  suggestion: z.string().describe('Suggestion to narrow results'),
+	/** Suggestion to narrow results */
+	suggestion: z.string().describe("Suggestion to narrow results"),
 
-  /** Human-readable summary of transactions shown in preview (e.g., "First 50 transactions:") */
-  showing: z.string().describe('Human-readable summary of transactions shown'),
+	/** Human-readable summary of transactions shown in preview (e.g., "First 50 transactions:") */
+	showing: z.string().describe("Human-readable summary of transactions shown"),
 
-  /** Total number of transactions */
-  total_count: z.number().int().describe('Total transaction count'),
+	/** Total number of transactions */
+	total_count: z.number().int().describe("Total transaction count"),
 
-  /** Estimated response size in KB if all transactions returned */
-  estimated_size_kb: z.number().describe('Estimated response size in KB'),
+	/** Estimated response size in KB if all transactions returned */
+	estimated_size_kb: z.number().describe("Estimated response size in KB"),
 
-  /** Array of preview transaction objects */
-  preview_transactions: z.array(TransactionPreviewSchema).describe('Preview transactions'),
+	/** Array of preview transaction objects */
+	preview_transactions: z
+		.array(TransactionPreviewSchema)
+		.describe("Preview transactions"),
 });
 
 /**
@@ -222,8 +230,8 @@ const ListTransactionsPreviewSchema = z.object({
  * Discriminated union supporting both normal and preview response modes.
  */
 export const ListTransactionsOutputSchema = z.union([
-  ListTransactionsNormalSchema,
-  ListTransactionsPreviewSchema,
+	ListTransactionsNormalSchema,
+	ListTransactionsPreviewSchema,
 ]);
 
 /**
@@ -232,12 +240,14 @@ export const ListTransactionsOutputSchema = z.union([
  * Returns a single transaction by ID with cache metadata.
  */
 export const GetTransactionOutputSchema = CacheMetadataSchema.extend({
-  /** Single transaction object */
-  transaction: TransactionSchema.describe('Transaction details'),
+	/** Single transaction object */
+	transaction: TransactionSchema.describe("Transaction details"),
 });
 
 // Export inferred TypeScript types
 export type Transaction = z.infer<typeof TransactionSchema>;
 export type TransactionPreview = z.infer<typeof TransactionPreviewSchema>;
-export type ListTransactionsOutput = z.infer<typeof ListTransactionsOutputSchema>;
+export type ListTransactionsOutput = z.infer<
+	typeof ListTransactionsOutputSchema
+>;
 export type GetTransactionOutput = z.infer<typeof GetTransactionOutputSchema>;

package/src/tools/schemas/outputs/utilityOutputs.ts

@@ -10,8 +10,8 @@
  * exact response shape details.
  */
 
-import { z } from 'zod/v4';
-import { SuccessResponseSchema } from '../shared/commonOutputs.js';
+import { z } from "zod/v4";
+import { SuccessResponseSchema } from "../shared/commonOutputs.js";
 
 // ============================================================================
 // GET USER OUTPUT
@@ -23,7 +23,7 @@ import { SuccessResponseSchema } from '../shared/commonOutputs.js';
  * Represents the authenticated user's information from YNAB API.
  */
 export const UserSchema = z.object({
-  id: z.string(),
+	id: z.string(),
 });
 
 /**
@@ -41,7 +41,7 @@ export const UserSchema = z.object({
  * ```
  */
 export const GetUserOutputSchema = z.object({
-  user: UserSchema,
+	user: UserSchema,
 });
 
 export type GetUserOutput = z.infer<typeof GetUserOutputSchema>;
@@ -67,12 +67,14 @@ export type GetUserOutput = z.infer<typeof GetUserOutputSchema>;
  * ```
  */
 export const GetDefaultBudgetOutputSchema = z.object({
-  default_budget_id: z.string().nullable(),
-  has_default: z.boolean(),
-  message: z.string(),
+	default_budget_id: z.string().nullable(),
+	has_default: z.boolean(),
+	message: z.string(),
 });
 
-export type GetDefaultBudgetOutput = z.infer<typeof GetDefaultBudgetOutputSchema>;
+export type GetDefaultBudgetOutput = z.infer<
+	typeof GetDefaultBudgetOutputSchema
+>;
 
 // ============================================================================
 // SET DEFAULT BUDGET OUTPUT
@@ -96,11 +98,13 @@ export type GetDefaultBudgetOutput = z.infer<typeof GetDefaultBudgetOutputSchema
  * ```
  */
 export const SetDefaultBudgetOutputSchema = SuccessResponseSchema.extend({
-  default_budget_id: z.string(),
-  cache_warm_started: z.boolean(),
+	default_budget_id: z.string(),
+	cache_warm_started: z.boolean(),
 });
 
-export type SetDefaultBudgetOutput = z.infer<typeof SetDefaultBudgetOutputSchema>;
+export type SetDefaultBudgetOutput = z.infer<
+	typeof SetDefaultBudgetOutputSchema
+>;
 
 // ============================================================================
 // CLEAR CACHE OUTPUT
@@ -120,7 +124,9 @@ export type SetDefaultBudgetOutput = z.infer<typeof SetDefaultBudgetOutputSchema
  * };
  * ```
  */
-export const ClearCacheOutputSchema = SuccessResponseSchema.pick({ success: true });
+export const ClearCacheOutputSchema = SuccessResponseSchema.pick({
+	success: true,
+});
 
 export type ClearCacheOutput = z.infer<typeof ClearCacheOutputSchema>;
 
@@ -145,10 +151,10 @@ export type ClearCacheOutput = z.infer<typeof ClearCacheOutputSchema>;
  * ```
  */
 export const SetOutputFormatOutputSchema = SuccessResponseSchema.extend({
-  options: z.object({
-    defaultMinify: z.boolean().optional(),
-    prettySpaces: z.number().optional(),
-  }),
+	options: z.object({
+		defaultMinify: z.boolean().optional(),
+		prettySpaces: z.number().optional(),
+	}),
 });
 
 export type SetOutputFormatOutput = z.infer<typeof SetOutputFormatOutputSchema>;
@@ -163,15 +169,15 @@ export type SetOutputFormatOutput = z.infer<typeof SetOutputFormatOutputSchema>;
  * Contains runtime information about the MCP server process.
  */
 export const ServerInfoSchema = z.object({
-  name: z.string(),
-  version: z.string(),
-  node_version: z.string(),
-  platform: z.string(),
-  arch: z.string(),
-  pid: z.number(),
-  uptime_ms: z.number(),
-  uptime_readable: z.string(),
-  env: z.record(z.string(), z.unknown()),
+	name: z.string(),
+	version: z.string(),
+	node_version: z.string(),
+	platform: z.string(),
+	arch: z.string(),
+	pid: z.number(),
+	uptime_ms: z.number(),
+	uptime_readable: z.string(),
+	env: z.record(z.string(), z.unknown()),
 });
 
 /**
@@ -180,12 +186,12 @@ export const ServerInfoSchema = z.object({
  * Reports memory consumption of the MCP server process.
  */
 export const MemoryInfoSchema = z.object({
-  rss_mb: z.number(),
-  heap_used_mb: z.number(),
-  heap_total_mb: z.number(),
-  external_mb: z.number(),
-  array_buffers_mb: z.number(),
-  description: z.record(z.string(), z.string()),
+	rss_mb: z.number(),
+	heap_used_mb: z.number(),
+	heap_total_mb: z.number(),
+	external_mb: z.number(),
+	array_buffers_mb: z.number(),
+	description: z.record(z.string(), z.string()),
 });
 
 /**
@@ -194,11 +200,11 @@ export const MemoryInfoSchema = z.object({
  * Shows environment variable configuration status.
  */
 export const EnvironmentInfoSchema = z.object({
-  token_present: z.boolean(),
-  token_length: z.number(),
-  token_preview: z.string().nullable(),
-  ynab_env_keys_present: z.array(z.string()),
-  working_directory: z.string(),
+	token_present: z.boolean(),
+	token_length: z.number(),
+	token_preview: z.string().nullable(),
+	ynab_env_keys_present: z.array(z.string()),
+	working_directory: z.string(),
 });
 
 /**
@@ -207,17 +213,17 @@ export const EnvironmentInfoSchema = z.object({
  * Reports cache status and performance metrics.
  */
 export const CacheInfoSchema = z.object({
-  entries: z.number(),
-  estimated_size_kb: z.number(),
-  keys: z.array(z.string()),
-  // Optional performance metrics
-  hits: z.number().optional(),
-  misses: z.number().optional(),
-  evictions: z.number().optional(),
-  lastCleanup: z.string().nullable().optional(),
-  maxEntries: z.number().optional(),
-  hitRate: z.string().optional(),
-  performance_summary: z.string().optional(),
+	entries: z.number(),
+	estimated_size_kb: z.number(),
+	keys: z.array(z.string()),
+	// Optional performance metrics
+	hits: z.number().optional(),
+	misses: z.number().optional(),
+	evictions: z.number().optional(),
+	lastCleanup: z.string().nullable().optional(),
+	maxEntries: z.number().optional(),
+	hitRate: z.string().optional(),
+	performance_summary: z.string().optional(),
 });
 
 /**
@@ -226,15 +232,15 @@ export const CacheInfoSchema = z.object({
  * Reports status of delta request feature and knowledge base.
  */
 export const DeltaInfoSchema = z.object({
-  enabled: z.boolean(),
-  knowledge_entries: z.number(),
-  knowledge_stats: z.record(z.string(), z.unknown()),
-  feature_flag: z.string(),
-  delta_hits: z.number(),
-  delta_misses: z.number(),
-  delta_hit_rate: z.number(),
-  merge_operations: z.number(),
-  knowledge_gap_events: z.number(),
+	enabled: z.boolean(),
+	knowledge_entries: z.number(),
+	knowledge_stats: z.record(z.string(), z.unknown()),
+	feature_flag: z.string(),
+	delta_hits: z.number(),
+	delta_misses: z.number(),
+	delta_hit_rate: z.number(),
+	merge_operations: z.number(),
+	knowledge_gap_events: z.number(),
 });
 
 /**
@@ -266,12 +272,12 @@ export const DeltaInfoSchema = z.object({
  * ```
  */
 export const DiagnosticInfoOutputSchema = z.object({
-  timestamp: z.string(),
-  server: ServerInfoSchema.optional(),
-  memory: MemoryInfoSchema.optional(),
-  environment: EnvironmentInfoSchema.optional(),
-  cache: CacheInfoSchema.optional(),
-  delta: DeltaInfoSchema.optional(),
+	timestamp: z.string(),
+	server: ServerInfoSchema.optional(),
+	memory: MemoryInfoSchema.optional(),
+	environment: EnvironmentInfoSchema.optional(),
+	cache: CacheInfoSchema.optional(),
+	delta: DeltaInfoSchema.optional(),
 });
 
 export type DiagnosticInfoOutput = z.infer<typeof DiagnosticInfoOutputSchema>;
@@ -286,7 +292,7 @@ export type DiagnosticInfoOutput = z.infer<typeof DiagnosticInfoOutputSchema>;
  * Represents how dates are formatted in the YNAB budget.
  */
 export const DateFormatSchema = z.object({
-  format: z.string(),
+	format: z.string(),
 });
 
 /**
@@ -295,14 +301,14 @@ export const DateFormatSchema = z.object({
  * Represents how currency values are formatted in the YNAB budget.
  */
 export const CurrencyFormatSchema = z.object({
-  iso_code: z.string(),
-  example_format: z.string(),
-  decimal_digits: z.number(),
-  decimal_separator: z.string().optional(),
-  symbol_first: z.boolean().optional(),
-  group_separator: z.string().optional(),
-  currency_symbol: z.string().optional(),
-  display_symbol: z.boolean().optional(),
+	iso_code: z.string(),
+	example_format: z.string(),
+	decimal_digits: z.number(),
+	decimal_separator: z.string().optional(),
+	symbol_first: z.boolean().optional(),
+	group_separator: z.string().optional(),
+	currency_symbol: z.string().optional(),
+	display_symbol: z.boolean().optional(),
 });
 
 /**
@@ -312,18 +318,18 @@ export const CurrencyFormatSchema = z.object({
  * format settings and entity counts.
  */
 export const BudgetDetailSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  last_modified_on: z.string().optional(),
-  first_month: z.string().optional(),
-  last_month: z.string().optional(),
-  date_format: DateFormatSchema.optional(),
-  currency_format: CurrencyFormatSchema.optional(),
-  accounts_count: z.number(),
-  categories_count: z.number(),
-  payees_count: z.number(),
-  months_count: z.number(),
-  message: z.string(),
+	id: z.string(),
+	name: z.string(),
+	last_modified_on: z.string().optional(),
+	first_month: z.string().optional(),
+	last_month: z.string().optional(),
+	date_format: DateFormatSchema.optional(),
+	currency_format: CurrencyFormatSchema.optional(),
+	accounts_count: z.number(),
+	categories_count: z.number(),
+	payees_count: z.number(),
+	months_count: z.number(),
+	message: z.string(),
 });
 
 /**
@@ -364,7 +370,7 @@ export const BudgetDetailSchema = z.object({
  * ```
  */
 export const GetBudgetOutputSchema = z.object({
-  budget: BudgetDetailSchema,
+	budget: BudgetDetailSchema,
 });
 
 export type GetBudgetOutput = z.infer<typeof GetBudgetOutputSchema>;

package/src/tools/schemas/shared/commonOutputs.ts

@@ -12,7 +12,7 @@
  * - Success response patterns: src/server/YNABMCPServer.ts (lines 456-460)
  */
 
-import { z } from 'zod/v4';
+import { z } from "zod/v4";
 
 /**
  * CacheMetadataSchema
@@ -37,15 +37,20 @@ import { z } from 'zod/v4';
  * ```
  */
 export const CacheMetadataSchema = z.object({
-  cached: z.boolean().optional().describe('Indicates if data was served from cache'),
-  cache_info: z
-    .string()
-    .optional()
-    .describe('Human-readable cache status message (e.g., "Cache hit", "Cache miss")'),
-  usedDelta: z
-    .boolean()
-    .optional()
-    .describe('Indicates if delta merge optimization was applied for budgets'),
+	cached: z
+		.boolean()
+		.optional()
+		.describe("Indicates if data was served from cache"),
+	cache_info: z
+		.string()
+		.optional()
+		.describe(
+			'Human-readable cache status message (e.g., "Cache hit", "Cache miss")',
+		),
+	usedDelta: z
+		.boolean()
+		.optional()
+		.describe("Indicates if delta merge optimization was applied for budgets"),
 });
 
 export type CacheMetadata = z.infer<typeof CacheMetadataSchema>;
@@ -70,8 +75,8 @@ export type CacheMetadata = z.infer<typeof CacheMetadataSchema>;
  * ```
  */
 export const SuccessResponseSchema = z.object({
-  success: z.boolean().describe('Indicates operation success'),
-  message: z.string().describe('Human-readable success message'),
+	success: z.boolean().describe("Indicates operation success"),
+	message: z.string().describe("Human-readable success message"),
 });
 
 export type SuccessResponse = z.infer<typeof SuccessResponseSchema>;
@@ -101,10 +106,10 @@ export type SuccessResponse = z.infer<typeof SuccessResponseSchema>;
  * ```
  */
 export const ConfirmationResponseSchema = SuccessResponseSchema.extend({
-  details: z
-    .record(z.string(), z.unknown())
-    .optional()
-    .describe('Additional confirmation details as key-value pairs'),
+	details: z
+		.record(z.string(), z.unknown())
+		.optional()
+		.describe("Additional confirmation details as key-value pairs"),
 });
 
 export type ConfirmationResponse = z.infer<typeof ConfirmationResponseSchema>;
@@ -132,9 +137,12 @@ export type ConfirmationResponse = z.infer<typeof ConfirmationResponseSchema>;
  * ```
  */
 export const ErrorDetailsSchema = z.object({
-  error: z.string().describe('Error message'),
-  code: z.string().optional().describe('Error code for categorization'),
-  details: z.string().optional().describe('Additional error context or details'),
+	error: z.string().describe("Error message"),
+	code: z.string().optional().describe("Error code for categorization"),
+	details: z
+		.string()
+		.optional()
+		.describe("Additional error context or details"),
 });
 
 export type ErrorDetails = z.infer<typeof ErrorDetailsSchema>;