@goodsamsoftware/freshbooks-mcp 1.0.5 → 1.0.7

package/dist/tools/timer/timer-discard.js

@@ -13,47 +13,47 @@ import { ErrorHandler } from "../../errors/error-handler.js";
  */
 export const timerDiscardTool = {
     name: "timer_discard",
-    description: `Discard a running timer without logging the time in FreshBooks.
-
-WHEN TO USE:
-- User says "discard timer", "delete timer", "cancel tracking"
-- Timer was started by mistake
-- Work was not actually performed
-- Want to abandon tracked time without saving
-
-IMPORTANT DIFFERENCE: Discard vs Stop
-- timer_stop: Logs the time, saves the time entry with calculated duration
-- timer_discard: DELETES the timer completely, no record is kept
-
-USE WITH CAUTION:
-- This permanently deletes the timer and all its time entries
-- The tracked time CANNOT be recovered after discarding
-- Use timer_stop if you want to keep and log the time entry
-
-HOW IT WORKS:
-Deletes the timer completely:
-- Timer and all time entries are removed from FreshBooks
-- No duration is logged
-- No record remains
-
-REQUIRED:
-- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
-
-OPTIONAL:
-- timerId: ID of the timer to discard (from timer_current). If not provided, discards the current timer.
-
-WHAT IF NO TIMER EXISTS:
-- Returns error if no timer found
-
-EXAMPLE USAGE:
-- "Discard my current timer" (auto-detects current timer)
-- "Delete timer - I didn't actually work on it"
-- "Cancel time tracking"
-
-RETURNS:
-Confirmation object with:
-- success: true if deletion succeeded
-- timeEntryId: The first time entry ID that was deleted
+    description: `Discard a running timer without logging the time in FreshBooks.
+
+WHEN TO USE:
+- User says "discard timer", "delete timer", "cancel tracking"
+- Timer was started by mistake
+- Work was not actually performed
+- Want to abandon tracked time without saving
+
+IMPORTANT DIFFERENCE: Discard vs Stop
+- timer_stop: Logs the time, saves the time entry with calculated duration
+- timer_discard: DELETES the timer completely, no record is kept
+
+USE WITH CAUTION:
+- This permanently deletes the timer and all its time entries
+- The tracked time CANNOT be recovered after discarding
+- Use timer_stop if you want to keep and log the time entry
+
+HOW IT WORKS:
+Deletes the timer completely:
+- Timer and all time entries are removed from FreshBooks
+- No duration is logged
+- No record remains
+
+REQUIRED:
+- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
+
+OPTIONAL:
+- timerId: ID of the timer to discard (from timer_current). If not provided, discards the current timer.
+
+WHAT IF NO TIMER EXISTS:
+- Returns error if no timer found
+
+EXAMPLE USAGE:
+- "Discard my current timer" (auto-detects current timer)
+- "Delete timer - I didn't actually work on it"
+- "Cancel time tracking"
+
+RETURNS:
+Confirmation object with:
+- success: true if deletion succeeded
+- timeEntryId: The first time entry ID that was deleted
 - message: Confirmation message`,
     inputSchema: TimerDiscardInputSchema,
     outputSchema: TimerDiscardOutputSchema,

package/dist/tools/timer/timer-start.js

@@ -13,49 +13,49 @@ import { ErrorHandler } from "../../errors/error-handler.js";
  */
 export const timerStartTool = {
     name: "timer_start",
-    description: `Start a new timer for time tracking in FreshBooks.
-
-WHEN TO USE:
-- User says "start timer", "begin tracking time", "clock in"
-- User wants to track time on a task or project
-- Starting work on billable hours
-
-HOW IT WORKS:
-Creates a new time entry with:
-- active=true (timer is running)
-- duration=0 (will auto-calculate when stopped)
-- startedAt=now (start time)
-- isLogged=false (not yet logged as completed time)
-
-IMPORTANT NOTES:
-- FreshBooks typically allows only ONE active timer per user
-- If a timer is already running, you may need to stop it first
-- The timer will continue running until explicitly stopped
-- Duration is auto-calculated from startedAt when stopped
-
-REQUIRED:
-- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
-
-OPTIONAL BUT HELPFUL:
-- projectId: Associate timer with a specific project (recommended for billing)
-- clientId: Associate timer with a client
-- serviceId: Type of service/work being performed
-- taskId: Specific task within a project
-- note: Description of work being performed (can be updated when stopping)
-- billable: Whether time is billable (default: true)
-- internal: Whether this is internal work (default: false)
-
-EXAMPLE USAGE:
-- "Start a timer for Project Alpha"
-- "Begin tracking time on bug fixes"
-- "Clock in for client meeting"
-
-RETURNS:
-Created time entry with:
-- id: Use this ID to stop or discard the timer later
-- active: true (timer is running)
-- duration: 0 (will be calculated when stopped)
-- startedAt: When timer started
+    description: `Start a new timer for time tracking in FreshBooks.
+
+WHEN TO USE:
+- User says "start timer", "begin tracking time", "clock in"
+- User wants to track time on a task or project
+- Starting work on billable hours
+
+HOW IT WORKS:
+Creates a new time entry with:
+- active=true (timer is running)
+- duration=0 (will auto-calculate when stopped)
+- startedAt=now (start time)
+- isLogged=false (not yet logged as completed time)
+
+IMPORTANT NOTES:
+- FreshBooks typically allows only ONE active timer per user
+- If a timer is already running, you may need to stop it first
+- The timer will continue running until explicitly stopped
+- Duration is auto-calculated from startedAt when stopped
+
+REQUIRED:
+- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
+
+OPTIONAL BUT HELPFUL:
+- projectId: Associate timer with a specific project (recommended for billing)
+- clientId: Associate timer with a client
+- serviceId: Type of service/work being performed
+- taskId: Specific task within a project
+- note: Description of work being performed (can be updated when stopping)
+- billable: Whether time is billable (default: true)
+- internal: Whether this is internal work (default: false)
+
+EXAMPLE USAGE:
+- "Start a timer for Project Alpha"
+- "Begin tracking time on bug fixes"
+- "Clock in for client meeting"
+
+RETURNS:
+Created time entry with:
+- id: Use this ID to stop or discard the timer later
+- active: true (timer is running)
+- duration: 0 (will be calculated when stopped)
+- startedAt: When timer started
 - timer: Active timer object with isRunning=true`,
     inputSchema: TimerStartInputSchema,
     outputSchema: TimerStartOutputSchema,

package/dist/tools/timer/timer-stop.js

@@ -13,39 +13,39 @@ import { ErrorHandler } from "../../errors/error-handler.js";
  */
 export const timerStopTool = {
     name: "timer_stop",
-    description: `Stop a running timer and log the time in FreshBooks.
-
-WHEN TO USE:
-- User says "stop timer", "stop tracking", "clock out"
-- User finishes work on a task/project and wants to log the time
-- User wants to save and log the time entry
-
-HOW IT WORKS:
-1. Gets the current timer to calculate total duration
-2. Aggregates duration across all time entry segments
-3. Updates the timer to mark time as logged and billable
-
-REQUIRED:
-- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
-
-OPTIONAL:
-- timerId: ID of the timer to stop (from timer_current). If not provided, stops the current running timer.
-- note: Update the description before stopping
-
-WHAT IF NO TIMER IS RUNNING:
-- Returns error if no active timer found
-
-EXAMPLE USAGE:
-- "Stop my timer" (auto-detects current timer)
-- "Stop timer and add note: completed bug fixes"
-
-RETURNS:
-Stopped time entry with:
-- id: The time entry ID
-- timerId: The timer ID
-- active: false (timer has stopped)
-- duration: Total calculated time in seconds
-- isLogged: true (time is now logged)
+    description: `Stop a running timer and log the time in FreshBooks.
+
+WHEN TO USE:
+- User says "stop timer", "stop tracking", "clock out"
+- User finishes work on a task/project and wants to log the time
+- User wants to save and log the time entry
+
+HOW IT WORKS:
+1. Gets the current timer to calculate total duration
+2. Aggregates duration across all time entry segments
+3. Updates the timer to mark time as logged and billable
+
+REQUIRED:
+- businessId: FreshBooks business ID (get from user_me -> businessMemberships[].business.id)
+
+OPTIONAL:
+- timerId: ID of the timer to stop (from timer_current). If not provided, stops the current running timer.
+- note: Update the description before stopping
+
+WHAT IF NO TIMER IS RUNNING:
+- Returns error if no active timer found
+
+EXAMPLE USAGE:
+- "Stop my timer" (auto-detects current timer)
+- "Stop timer and add note: completed bug fixes"
+
+RETURNS:
+Stopped time entry with:
+- id: The time entry ID
+- timerId: The timer ID
+- active: false (timer has stopped)
+- duration: Total calculated time in seconds
+- isLogged: true (time is now logged)
 - billable: true (time is marked billable)`,
     inputSchema: TimerStopInputSchema,
     outputSchema: TimerStopOutputSchema,

package/package.json

@@ -1,88 +1,88 @@
-{
-  "name": "@goodsamsoftware/freshbooks-mcp",
-  "version": "1.0.5",
-  "description": "FreshBooks MCP server providing 1:1 parity with the FreshBooks Node.js SDK",
-  "type": "module",
-  "main": "dist/server.js",
-  "types": "dist/server.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/server.d.ts",
-      "import": "./dist/server.js",
-      "require": "./dist/server.js"
-    },
-    "./tools": {
-      "types": "./dist/tools/index.d.ts",
-      "import": "./dist/tools/index.js",
-      "require": "./dist/tools/index.js"
-    },
-    "./client": {
-      "types": "./dist/client/index.d.ts",
-      "import": "./dist/client/index.js",
-      "require": "./dist/client/index.js"
-    },
-    "./auth": {
-      "types": "./dist/auth/index.d.ts",
-      "import": "./dist/auth/index.js",
-      "require": "./dist/auth/index.js"
-    },
-    "./errors": {
-      "types": "./dist/errors/index.d.ts",
-      "import": "./dist/errors/index.js",
-      "require": "./dist/errors/index.js"
-    },
-    "./utils": {
-      "types": "./dist/utils/index.d.ts",
-      "import": "./dist/utils/index.js",
-      "require": "./dist/utils/index.js"
-    }
-  },
-  "bin": {
-    "freshbooks-mcp": "./dist/server.js"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "start": "node dist/server.js",
-    "dev": "tsx watch src/server.ts",
-    "test": "vitest",
-    "test:coverage": "vitest --coverage",
-    "lint": "eslint src/",
-    "typecheck": "tsc --noEmit"
-  },
-  "keywords": [
-    "freshbooks",
-    "mcp",
-    "model-context-protocol",
-    "time-tracking",
-    "invoicing"
-  ],
-  "author": "Chadwick Posey <chadwick.posey@goodsamsoftware.com>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Good-Samaritan-Software-LLC/freshbooks-mcp.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Good-Samaritan-Software-LLC/freshbooks-mcp/issues"
-  },
-  "homepage": "https://freshbooks.goodsamsoftware.com/",
-  "dependencies": {
-    "@freshbooks/api": "^4.1.0",
-    "@modelcontextprotocol/sdk": "^1.0.0",
-    "zod": "^3.22.0"
-  },
-  "devDependencies": {
-    "@faker-js/faker": "^8.3.1",
-    "@types/node": "^20.0.0",
-    "@vitest/coverage-v8": "^4.0.16",
-    "eslint": "^8.0.0",
-    "tsx": "^4.0.0",
-    "typescript": "^5.3.0",
-    "vitest": "^4.0.16"
-  }
-}
+{
+  "name": "@goodsamsoftware/freshbooks-mcp",
+  "version": "1.0.7",
+  "description": "FreshBooks MCP server providing 1:1 parity with the FreshBooks Node.js SDK",
+  "type": "module",
+  "main": "dist/server.js",
+  "types": "dist/server.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "require": "./dist/server.js"
+    },
+    "./tools": {
+      "types": "./dist/tools/index.d.ts",
+      "import": "./dist/tools/index.js",
+      "require": "./dist/tools/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "import": "./dist/auth/index.js",
+      "require": "./dist/auth/index.js"
+    },
+    "./errors": {
+      "types": "./dist/errors/index.d.ts",
+      "import": "./dist/errors/index.js",
+      "require": "./dist/errors/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.js"
+    }
+  },
+  "bin": {
+    "freshbooks-mcp": "./dist/server.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/server.js",
+    "dev": "tsx watch src/server.ts",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "freshbooks",
+    "mcp",
+    "model-context-protocol",
+    "time-tracking",
+    "invoicing"
+  ],
+  "author": "Chadwick Posey <chadwick.posey@goodsamsoftware.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Good-Samaritan-Software-LLC/freshbooks-mcp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Good-Samaritan-Software-LLC/freshbooks-mcp/issues"
+  },
+  "homepage": "https://freshbooks.goodsamsoftware.com/",
+  "dependencies": {
+    "@freshbooks/api": "^4.1.0",
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.3.1",
+    "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^8.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.16"
+  }
+}