@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/user/schemas.d.ts

@@ -0,0 +1,258 @@
+/**
+ * Zod schemas for User entity
+ *
+ * User account schemas for FreshBooks API
+ */
+import { z } from 'zod';
+/**
+ * Business membership schema
+ */
+export declare const BusinessMembershipSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    accountId: z.ZodString;
+    role: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    name: string;
+    role: string;
+    id: number;
+}, {
+    accountId: string;
+    name: string;
+    role: string;
+    id: number;
+}>;
+/**
+ * Full User schema with all properties
+ */
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    email: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    businessMemberships: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        accountId: z.ZodString;
+        role: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }, {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }>, "many">;
+    phoneNumbers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        number: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        number: string;
+        title?: string | undefined;
+    }, {
+        number: string;
+        title?: string | undefined;
+    }>, "many">>;
+    addresses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        street: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        province: z.ZodOptional<z.ZodString>;
+        country: z.ZodOptional<z.ZodString>;
+        postalCode: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }, {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }>, "many">>;
+    profession: z.ZodOptional<z.ZodString>;
+    links: z.ZodOptional<z.ZodObject<{
+        me: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        me: string;
+    }, {
+        me: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    id: number;
+    firstName: string;
+    lastName: string;
+    businessMemberships: {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }[];
+    phoneNumbers?: {
+        number: string;
+        title?: string | undefined;
+    }[] | undefined;
+    addresses?: {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }[] | undefined;
+    profession?: string | undefined;
+    links?: {
+        me: string;
+    } | undefined;
+}, {
+    email: string;
+    id: number;
+    firstName: string;
+    lastName: string;
+    businessMemberships: {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }[];
+    phoneNumbers?: {
+        number: string;
+        title?: string | undefined;
+    }[] | undefined;
+    addresses?: {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }[] | undefined;
+    profession?: string | undefined;
+    links?: {
+        me: string;
+    } | undefined;
+}>;
+/**
+ * Input schema for getting current user info (no parameters needed)
+ */
+export declare const UserMeInputSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+/**
+ * Output schema for user_me operation
+ */
+export declare const UserMeOutputSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    email: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    businessMemberships: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        accountId: z.ZodString;
+        role: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }, {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }>, "many">;
+    phoneNumbers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        number: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        number: string;
+        title?: string | undefined;
+    }, {
+        number: string;
+        title?: string | undefined;
+    }>, "many">>;
+    addresses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        street: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        province: z.ZodOptional<z.ZodString>;
+        country: z.ZodOptional<z.ZodString>;
+        postalCode: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }, {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }>, "many">>;
+    profession: z.ZodOptional<z.ZodString>;
+    links: z.ZodOptional<z.ZodObject<{
+        me: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        me: string;
+    }, {
+        me: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    id: number;
+    firstName: string;
+    lastName: string;
+    businessMemberships: {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }[];
+    phoneNumbers?: {
+        number: string;
+        title?: string | undefined;
+    }[] | undefined;
+    addresses?: {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }[] | undefined;
+    profession?: string | undefined;
+    links?: {
+        me: string;
+    } | undefined;
+}, {
+    email: string;
+    id: number;
+    firstName: string;
+    lastName: string;
+    businessMemberships: {
+        accountId: string;
+        name: string;
+        role: string;
+        id: number;
+    }[];
+    phoneNumbers?: {
+        number: string;
+        title?: string | undefined;
+    }[] | undefined;
+    addresses?: {
+        city?: string | undefined;
+        province?: string | undefined;
+        country?: string | undefined;
+        postalCode?: string | undefined;
+        street?: string | undefined;
+    }[] | undefined;
+    profession?: string | undefined;
+    links?: {
+        me: string;
+    } | undefined;
+}>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/tools/user/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/tools/user/schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;EAKnC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqBrB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB,gDAE5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAa,CAAC"}

package/dist/tools/user/schemas.js

@@ -0,0 +1,51 @@
+/**
+ * Zod schemas for User entity
+ *
+ * User account schemas for FreshBooks API
+ */
+import { z } from 'zod';
+/**
+ * Business membership schema
+ */
+export const BusinessMembershipSchema = z.object({
+    id: z.number().describe('Business ID'),
+    name: z.string().describe('Business name'),
+    accountId: z.string().describe('Account ID for this business'),
+    role: z.string().describe('User role in this business (e.g., owner, admin, employee)'),
+});
+/**
+ * Full User schema with all properties
+ */
+export const UserSchema = z.object({
+    id: z.number().describe('Unique user identifier'),
+    email: z.string().email().describe('User email address'),
+    firstName: z.string().describe('First name'),
+    lastName: z.string().describe('Last name'),
+    businessMemberships: z.array(BusinessMembershipSchema).describe('Businesses this user belongs to'),
+    phoneNumbers: z.array(z.object({
+        title: z.string().optional(),
+        number: z.string(),
+    })).optional().describe('User phone numbers'),
+    addresses: z.array(z.object({
+        street: z.string().optional(),
+        city: z.string().optional(),
+        province: z.string().optional(),
+        country: z.string().optional(),
+        postalCode: z.string().optional(),
+    })).optional().describe('User addresses'),
+    profession: z.string().optional().describe('User profession'),
+    links: z.object({
+        me: z.string().describe('Link to user profile'),
+    }).optional().describe('Related resource links'),
+});
+/**
+ * Input schema for getting current user info (no parameters needed)
+ */
+export const UserMeInputSchema = z.object({
+// No parameters needed - gets current authenticated user
+});
+/**
+ * Output schema for user_me operation
+ */
+export const UserMeOutputSchema = UserSchema;
+//# sourceMappingURL=schemas.js.map

package/dist/tools/user/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/tools/user/schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC9D,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;CACvF,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACjD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACxD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC1C,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAClG,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;KACnB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACzC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IAC7D,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;KAChD,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CACjD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;AACxC,yDAAyD;CAC1D,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC"}

package/dist/tools/user/user-me.d.ts

@@ -0,0 +1,129 @@
+/**
+ * User Me Tool
+ *
+ * Get information about the currently authenticated user.
+ */
+import { z } from "zod";
+import { UserMeInputSchema, UserMeOutputSchema } from "./schemas.js";
+import { FreshBooksClientWrapper } from "../../client/index.js";
+/**
+ * Tool definition for user_me
+ */
+export declare const userMeTool: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    outputSchema: z.ZodObject<{
+        id: z.ZodNumber;
+        email: z.ZodString;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        businessMemberships: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            name: z.ZodString;
+            accountId: z.ZodString;
+            role: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            accountId: string;
+            name: string;
+            role: string;
+            id: number;
+        }, {
+            accountId: string;
+            name: string;
+            role: string;
+            id: number;
+        }>, "many">;
+        phoneNumbers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            number: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: string;
+            title?: string | undefined;
+        }, {
+            number: string;
+            title?: string | undefined;
+        }>, "many">>;
+        addresses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            street: z.ZodOptional<z.ZodString>;
+            city: z.ZodOptional<z.ZodString>;
+            province: z.ZodOptional<z.ZodString>;
+            country: z.ZodOptional<z.ZodString>;
+            postalCode: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            city?: string | undefined;
+            province?: string | undefined;
+            country?: string | undefined;
+            postalCode?: string | undefined;
+            street?: string | undefined;
+        }, {
+            city?: string | undefined;
+            province?: string | undefined;
+            country?: string | undefined;
+            postalCode?: string | undefined;
+            street?: string | undefined;
+        }>, "many">>;
+        profession: z.ZodOptional<z.ZodString>;
+        links: z.ZodOptional<z.ZodObject<{
+            me: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            me: string;
+        }, {
+            me: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        email: string;
+        id: number;
+        firstName: string;
+        lastName: string;
+        businessMemberships: {
+            accountId: string;
+            name: string;
+            role: string;
+            id: number;
+        }[];
+        phoneNumbers?: {
+            number: string;
+            title?: string | undefined;
+        }[] | undefined;
+        addresses?: {
+            city?: string | undefined;
+            province?: string | undefined;
+            country?: string | undefined;
+            postalCode?: string | undefined;
+            street?: string | undefined;
+        }[] | undefined;
+        profession?: string | undefined;
+        links?: {
+            me: string;
+        } | undefined;
+    }, {
+        email: string;
+        id: number;
+        firstName: string;
+        lastName: string;
+        businessMemberships: {
+            accountId: string;
+            name: string;
+            role: string;
+            id: number;
+        }[];
+        phoneNumbers?: {
+            number: string;
+            title?: string | undefined;
+        }[] | undefined;
+        addresses?: {
+            city?: string | undefined;
+            province?: string | undefined;
+            country?: string | undefined;
+            postalCode?: string | undefined;
+            street?: string | undefined;
+        }[] | undefined;
+        profession?: string | undefined;
+        links?: {
+            me: string;
+        } | undefined;
+    }>;
+    execute(input: z.infer<typeof UserMeInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof UserMeOutputSchema>>;
+};
+//# sourceMappingURL=user-me.d.ts.map

package/dist/tools/user/user-me.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-me.d.ts","sourceRoot":"","sources":["../../../src/tools/user/user-me.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAwCZ,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,UAChC,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;CAqB/C,CAAC"}

package/dist/tools/user/user-me.js

@@ -0,0 +1,63 @@
+/**
+ * User Me Tool
+ *
+ * Get information about the currently authenticated user.
+ */
+import { UserMeInputSchema, UserMeOutputSchema } from "./schemas.js";
+import { ErrorHandler } from "../../errors/error-handler.js";
+/**
+ * Tool definition for user_me
+ */
+export const userMeTool = {
+    name: "user_me",
+    description: `Get information about the currently authenticated user.
+
+WHEN TO USE:
+- User asks "who am I", "what's my account info", "show my profile"
+- Need to get the user's business memberships and account IDs
+- Need to verify authentication is working
+- Need to get user's email or name
+
+WHAT IT RETURNS:
+Complete user profile including:
+- User ID, email, name
+- Business memberships with account IDs and roles
+- Phone numbers and addresses
+- Professional information
+
+IMPORTANT:
+This uses the current OAuth access token to identify the user.
+No parameters needed - automatically gets the authenticated user.
+
+USE CASES:
+- Finding account IDs for other API calls
+- Verifying which businesses the user has access to
+- Getting user details for personalization
+- Checking user roles and permissions
+
+EXAMPLE PROMPTS:
+- "Who am I logged in as?"
+- "What businesses do I have access to?"
+- "Show me my FreshBooks profile"
+- "What's my account ID?"
+
+RETURNS:
+User profile with business memberships and account information.`,
+    inputSchema: UserMeInputSchema,
+    outputSchema: UserMeOutputSchema,
+    async execute(input, client) {
+        const handler = ErrorHandler.wrapHandler('user_me', async (_input, _context) => {
+            const result = await client.executeWithRetry('user_me', async (fbClient) => {
+                const response = await fbClient.users.me();
+                if (!response.ok) {
+                    throw response.error;
+                }
+                return response.data;
+            });
+            // Return user data
+            return result;
+        });
+        return handler(input, { accountId: '' }); // No accountId needed for this endpoint
+    },
+};
+//# sourceMappingURL=user-me.js.map

package/dist/tools/user/user-me.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-me.js","sourceRoot":"","sources":["../../../src/tools/user/user-me.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAI7D;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI,EAAE,SAAS;IACf,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gEAgCiD;IAE9D,WAAW,EAAE,iBAAiB;IAC9B,YAAY,EAAE,kBAAkB;IAEhC,KAAK,CAAC,OAAO,CACX,KAAwC,EACxC,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,SAAS,EACT,KAAK,EAAE,MAAyC,EAAE,QAAqB,EAAE,EAAE;YACzE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACzE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;gBAE3C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,mBAAmB;YACnB,OAAO,MAAa,CAAC;QACvB,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,wCAAwC;IACpF,CAAC;CACF,CAAC"}