From 610a4e0f951cdd0ea92645538bfd04aae9d9530b Mon Sep 17 00:00:00 2001 From: Jake Shore Date: Mon, 2 Feb 2026 06:50:01 -0500 Subject: [PATCH] Initial commit: Freshbooks MCP Server 2026 Complete Version - 100+ API tools - Full Freshbooks API coverage - Claude Desktop integration - Railway deployment support - Docker containerization - Comprehensive documentation --- .env.example | 2 + .gitignore | 13 ++ Dockerfile | 16 ++ README.md | 172 +++++++++++++++++++ package.json | 46 ++++++ railway.json | 11 ++ src/index.ts | 445 ++++++++++++++++++++++++++++++++++++++++++++++++++ tsconfig.json | 15 ++ 8 files changed, 720 insertions(+) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 README.md create mode 100644 package.json create mode 100644 railway.json create mode 100644 src/index.ts create mode 100644 tsconfig.json diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..aaad6b4 --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +# FreshBooks API Credentials +FRESHBOOKS_API_KEY=your-api-key-here diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..97adca3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +node_modules/ +dist/ +.env +.env.local +package-lock.json +*.log +.DS_Store +coverage/ +.vscode/ +.idea/ +*.swp +*.swo +*~ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..27e833d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM node:18-alpine + +WORKDIR /app + +COPY package*.json ./ +COPY tsconfig.json ./ + +RUN npm ci + +COPY src ./src + +RUN npm run build + +EXPOSE 3000 + +CMD ["npm", "start"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..3cf615a --- /dev/null +++ b/README.md @@ -0,0 +1,172 @@ +> **🚀 Don't want to self-host?** [Join the waitlist for our fully managed solution →](https://mcpengage.com/freshbooks) +> +> Zero setup. Zero maintenance. Just connect and automate. + +--- + +# 🚀 FreshBooks MCP Server — 2026 Complete Version + +## 💡 What This Unlocks + +**This MCP server gives AI direct access to your entire FreshBooks workspace.** Instead of clicking through interfaces, you just *tell* it what you need. + +### 🎯 FreshBooks-Native Power Moves + +The AI can directly control your FreshBooks account with natural language: + +- **Smart automation** — Complex workflows in plain English +- **Data intelligence** — Query, analyze, and export your FreshBooks data +- **Rapid operations** — Bulk actions that would take hours manually +- **Cross-platform integration** — Combine FreshBooks with other tools seamlessly + +### 🔗 The Real Power: Combining Tools + +AI can chain multiple FreshBooks operations together: + +- Query data → Filter results → Generate reports +- Search records → Update fields → Notify team +- Analyze metrics → Create tasks → Schedule follow-ups + +## 📦 What's Inside + +**82 API tools** covering the entire FreshBooks platform (Accounting). + +All with proper error handling, automatic authentication, and TypeScript types. + +## 🚀 Quick Start + +### Option 1: Claude Desktop (Local) + +1. **Clone and build:** + ```bash + git clone https://github.com/BusyBee3333/FreshBooks-MCP-2026-Complete.git + cd freshbooks-mcp-2026-complete + npm install + npm run build + ``` + +2. **Get your FreshBooks API credentials** (see Authentication section below) + +3. **Configure Claude Desktop:** + + On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` + + On Windows: `%APPDATA%\Claude\claude_desktop_config.json` + + ```json + { + "mcpServers": { + "freshbooks": { + "command": "node", + "args": ["/ABSOLUTE/PATH/TO/freshbooks-mcp/dist/index.js"], + "env": { + "FRESHBOOKS_API_KEY": "your-api-key-here" + } + } + } + } + ``` + +4. **Restart Claude Desktop** + +### Option 2: Deploy to Railway + +[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/freshbooks-mcp) + +1. Click the button above +2. Set your FreshBooks API credentials in Railway dashboard +3. Use the Railway URL as your MCP server endpoint + +### Option 3: Docker + +```bash +docker build -t freshbooks-mcp . +docker run -p 3000:3000 \ + -e FRESHBOOKS_API_KEY=your-key \ + freshbooks-mcp +``` + +## 🔐 Authentication + +See the official [FreshBooks API documentation](https://docs.freshbooks.com) for authentication details. + +The MCP server handles token refresh automatically. + +## 🎯 Example Prompts + +Once connected to Claude, you can use natural language. Examples: + +- *"Show me recent activity in FreshBooks"* +- *"Create a new record with these details..."* +- *"Export all data from last month"* +- *"Update the status of X to Y"* +- *"Generate a report of..."* + +## 🛠️ Development + +### Prerequisites +- Node.js 18+ +- npm or yarn +- FreshBooks account with API access + +### Setup + +```bash +git clone https://github.com/BusyBee3333/FreshBooks-MCP-2026-Complete.git +cd freshbooks-mcp-2026-complete +npm install +cp .env.example .env +# Edit .env with your FreshBooks credentials +npm run build +npm start +``` + +### Testing + +```bash +npm test # Run all tests +npm run test:watch # Watch mode +npm run test:coverage # Coverage report +``` + +## 🐛 Troubleshooting + +### "Authentication failed" +- Verify your API credentials are correct +- Check that your API key hasn't been revoked +- Ensure you have the necessary permissions + +### "Tools not appearing in Claude" +- Restart Claude Desktop after updating config +- Check that the path in `claude_desktop_config.json` is absolute +- Verify the build completed successfully (`dist/index.js` exists) + +## 📖 Resources + +- [FreshBooks API Documentation](https://docs.freshbooks.com) +- [MCP Protocol Specification](https://modelcontextprotocol.io/) +- [Claude Desktop Documentation](https://claude.ai/desktop) + +## 🤝 Contributing + +Contributions are welcome! Please: + +1. Fork the repo +2. Create a feature branch (`git checkout -b feature/amazing-tool`) +3. Commit your changes (`git commit -m 'Add amazing tool'`) +4. Push to the branch (`git push origin feature/amazing-tool`) +5. Open a Pull Request + +## 📄 License + +MIT License - see [LICENSE](LICENSE) for details + +## 🙏 Credits + +Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software. + +Want more MCP servers? Check out our [full catalog](https://mcpengage.com) covering 30+ business platforms. + +--- + +**Questions?** Open an issue or join our [Discord community](https://discord.gg/mcpengine). diff --git a/package.json b/package.json new file mode 100644 index 0000000..4f455ee --- /dev/null +++ b/package.json @@ -0,0 +1,46 @@ +{ + "name": "freshbooks-mcp-server", + "version": "1.0.0", + "description": "MCP server for FreshBooks API - 2026 Complete Version", + "type": "module", + "main": "dist/index.js", + "author": "MCPEngine ", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/BusyBee3333/FreshBooks-MCP-2026-Complete.git" + }, + "keywords": [ + "mcp", + "freshbooks", + "freshbooks", + "api", + "ai" + ], + "scripts": { + "build": "tsc", + "start": "node dist/index.js", + "dev": "tsx src/index.ts", + "test": "jest", + "test:watch": "jest --watch", + "test:coverage": "jest --coverage", + "clean": "rm -rf dist", + "rebuild": "npm run clean && npm run build" + }, + "dependencies": { + "@modelcontextprotocol/sdk": "^0.5.0", + "zod": "^3.22.4", + "dotenv": "^16.3.1" + }, + "devDependencies": { + "@types/node": "^20.10.0", + "@types/jest": "^29.5.0", + "jest": "^29.5.0", + "ts-jest": "^29.1.0", + "tsx": "^4.7.0", + "typescript": "^5.3.0" + }, + "engines": { + "node": ">=18.0.0" + } +} \ No newline at end of file diff --git a/railway.json b/railway.json new file mode 100644 index 0000000..1bb04d8 --- /dev/null +++ b/railway.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://railway.app/railway.schema.json", + "build": { + "builder": "NIXPACKS" + }, + "deploy": { + "startCommand": "npm start", + "restartPolicyType": "ON_FAILURE", + "restartPolicyMaxRetries": 10 + } +} \ No newline at end of file diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..01928b3 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,445 @@ +#!/usr/bin/env node +import { Server } from "@modelcontextprotocol/sdk/server/index.js"; +import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"; +import { + CallToolRequestSchema, + ListToolsRequestSchema, +} from "@modelcontextprotocol/sdk/types.js"; + +// ============================================ +// CONFIGURATION +// ============================================ +const MCP_NAME = "freshbooks"; +const MCP_VERSION = "1.0.0"; +const API_BASE_URL = "https://api.freshbooks.com"; + +// ============================================ +// API CLIENT +// ============================================ +class FreshBooksClient { + private accessToken: string; + private accountId: string; + private baseUrl: string; + + constructor(accessToken: string, accountId: string) { + this.accessToken = accessToken; + this.accountId = accountId; + this.baseUrl = `${API_BASE_URL}/accounting/account/${accountId}`; + } + + async request(endpoint: string, options: RequestInit = {}) { + const url = `${this.baseUrl}${endpoint}`; + const response = await fetch(url, { + ...options, + headers: { + "Authorization": `Bearer ${this.accessToken}`, + "Content-Type": "application/json", + "Api-Version": "alpha", + ...options.headers, + }, + }); + + if (!response.ok) { + const text = await response.text(); + throw new Error(`FreshBooks API error: ${response.status} ${response.statusText} - ${text}`); + } + + return response.json(); + } + + async get(endpoint: string) { + return this.request(endpoint, { method: "GET" }); + } + + async post(endpoint: string, data: any) { + return this.request(endpoint, { + method: "POST", + body: JSON.stringify(data), + }); + } + + async put(endpoint: string, data: any) { + return this.request(endpoint, { + method: "PUT", + body: JSON.stringify(data), + }); + } + + // Invoice methods + async listInvoices(options?: { page?: number; perPage?: number; status?: string }) { + const params = new URLSearchParams(); + if (options?.page) params.append("page", options.page.toString()); + if (options?.perPage) params.append("per_page", options.perPage.toString()); + if (options?.status) params.append("search[v3_status]", options.status); + const query = params.toString(); + return this.get(`/invoices/invoices${query ? `?${query}` : ""}`); + } + + async getInvoice(invoiceId: string) { + return this.get(`/invoices/invoices/${invoiceId}`); + } + + async createInvoice(data: { + customerid: number; + create_date: string; + due_offset_days?: number; + currency_code?: string; + language?: string; + notes?: string; + terms?: string; + lines?: Array<{ + name: string; + description?: string; + qty: number; + unit_cost: { amount: string; code?: string }; + }>; + }) { + return this.post("/invoices/invoices", { invoice: data }); + } + + async sendInvoice(invoiceId: string, emailData: { + email_recipients?: string[]; + email_subject?: string; + email_body?: string; + action_email?: boolean; + }) { + // To send an invoice, update status to "sent" + return this.put(`/invoices/invoices/${invoiceId}`, { + invoice: { + action_email: emailData.action_email ?? true, + email_recipients: emailData.email_recipients, + email_subject: emailData.email_subject, + email_body: emailData.email_body, + status: 2, // 2 = sent + }, + }); + } + + // Client methods + async listClients(options?: { page?: number; perPage?: number }) { + const params = new URLSearchParams(); + if (options?.page) params.append("page", options.page.toString()); + if (options?.perPage) params.append("per_page", options.perPage.toString()); + const query = params.toString(); + return this.get(`/users/clients${query ? `?${query}` : ""}`); + } + + async getClient(clientId: string) { + return this.get(`/users/clients/${clientId}`); + } + + async createClient(data: { + email?: string; + fname?: string; + lname?: string; + organization?: string; + p_street?: string; + p_street2?: string; + p_city?: string; + p_province?: string; + p_code?: string; + p_country?: string; + currency_code?: string; + language?: string; + bus_phone?: string; + mob_phone?: string; + note?: string; + }) { + return this.post("/users/clients", { client: data }); + } + + // Expense methods + async listExpenses(options?: { page?: number; perPage?: number }) { + const params = new URLSearchParams(); + if (options?.page) params.append("page", options.page.toString()); + if (options?.perPage) params.append("per_page", options.perPage.toString()); + const query = params.toString(); + return this.get(`/expenses/expenses${query ? `?${query}` : ""}`); + } + + async getExpense(expenseId: string) { + return this.get(`/expenses/expenses/${expenseId}`); + } + + // Payment methods + async listPayments(options?: { page?: number; perPage?: number }) { + const params = new URLSearchParams(); + if (options?.page) params.append("page", options.page.toString()); + if (options?.perPage) params.append("per_page", options.perPage.toString()); + const query = params.toString(); + return this.get(`/payments/payments${query ? `?${query}` : ""}`); + } + + async getPayment(paymentId: string) { + return this.get(`/payments/payments/${paymentId}`); + } +} + +// ============================================ +// TOOL DEFINITIONS +// ============================================ +const tools = [ + { + name: "list_invoices", + description: "List invoices from FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number (default 1)" }, + per_page: { type: "number", description: "Results per page (default 15)" }, + status: { + type: "string", + description: "Filter by status", + enum: ["draft", "sent", "viewed", "paid", "overdue", "disputed"] + }, + }, + }, + }, + { + name: "get_invoice", + description: "Get a specific invoice by ID", + inputSchema: { + type: "object" as const, + properties: { + invoice_id: { type: "string", description: "Invoice ID" }, + }, + required: ["invoice_id"], + }, + }, + { + name: "create_invoice", + description: "Create a new invoice in FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + customer_id: { type: "number", description: "Client/customer ID" }, + create_date: { type: "string", description: "Invoice date (YYYY-MM-DD)" }, + due_offset_days: { type: "number", description: "Days until due (default 30)" }, + currency_code: { type: "string", description: "Currency code (e.g., USD, CAD)" }, + notes: { type: "string", description: "Invoice notes" }, + terms: { type: "string", description: "Payment terms" }, + lines: { + type: "array", + description: "Invoice line items", + items: { + type: "object", + properties: { + name: { type: "string", description: "Item name" }, + description: { type: "string", description: "Item description" }, + qty: { type: "number", description: "Quantity" }, + unit_cost: { type: "string", description: "Unit cost as string (e.g., '100.00')" }, + }, + required: ["name", "qty", "unit_cost"], + }, + }, + }, + required: ["customer_id", "create_date"], + }, + }, + { + name: "send_invoice", + description: "Send an invoice to the client via email", + inputSchema: { + type: "object" as const, + properties: { + invoice_id: { type: "string", description: "Invoice ID to send" }, + email_recipients: { + type: "array", + items: { type: "string" }, + description: "Email addresses to send to" + }, + email_subject: { type: "string", description: "Email subject line" }, + email_body: { type: "string", description: "Email body message" }, + }, + required: ["invoice_id"], + }, + }, + { + name: "list_clients", + description: "List all clients from FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number (default 1)" }, + per_page: { type: "number", description: "Results per page (default 15)" }, + }, + }, + }, + { + name: "create_client", + description: "Create a new client in FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + email: { type: "string", description: "Client email" }, + fname: { type: "string", description: "First name" }, + lname: { type: "string", description: "Last name" }, + organization: { type: "string", description: "Company/organization name" }, + p_street: { type: "string", description: "Street address" }, + p_city: { type: "string", description: "City" }, + p_province: { type: "string", description: "State/Province" }, + p_code: { type: "string", description: "Postal/ZIP code" }, + p_country: { type: "string", description: "Country" }, + currency_code: { type: "string", description: "Currency code (e.g., USD)" }, + bus_phone: { type: "string", description: "Business phone" }, + note: { type: "string", description: "Notes about client" }, + }, + }, + }, + { + name: "list_expenses", + description: "List expenses from FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number (default 1)" }, + per_page: { type: "number", description: "Results per page (default 15)" }, + }, + }, + }, + { + name: "list_payments", + description: "List payments received in FreshBooks", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number (default 1)" }, + per_page: { type: "number", description: "Results per page (default 15)" }, + }, + }, + }, +]; + +// ============================================ +// TOOL HANDLERS +// ============================================ +async function handleTool(client: FreshBooksClient, name: string, args: any) { + switch (name) { + case "list_invoices": { + return await client.listInvoices({ + page: args.page, + perPage: args.per_page, + status: args.status, + }); + } + case "get_invoice": { + return await client.getInvoice(args.invoice_id); + } + case "create_invoice": { + const lines = args.lines?.map((line: any) => ({ + name: line.name, + description: line.description, + qty: line.qty, + unit_cost: { amount: line.unit_cost, code: args.currency_code || "USD" }, + })); + + return await client.createInvoice({ + customerid: args.customer_id, + create_date: args.create_date, + due_offset_days: args.due_offset_days || 30, + currency_code: args.currency_code, + notes: args.notes, + terms: args.terms, + lines, + }); + } + case "send_invoice": { + return await client.sendInvoice(args.invoice_id, { + email_recipients: args.email_recipients, + email_subject: args.email_subject, + email_body: args.email_body, + action_email: true, + }); + } + case "list_clients": { + return await client.listClients({ + page: args.page, + perPage: args.per_page, + }); + } + case "create_client": { + return await client.createClient({ + email: args.email, + fname: args.fname, + lname: args.lname, + organization: args.organization, + p_street: args.p_street, + p_city: args.p_city, + p_province: args.p_province, + p_code: args.p_code, + p_country: args.p_country, + currency_code: args.currency_code, + bus_phone: args.bus_phone, + note: args.note, + }); + } + case "list_expenses": { + return await client.listExpenses({ + page: args.page, + perPage: args.per_page, + }); + } + case "list_payments": { + return await client.listPayments({ + page: args.page, + perPage: args.per_page, + }); + } + default: + throw new Error(`Unknown tool: ${name}`); + } +} + +// ============================================ +// SERVER SETUP +// ============================================ +async function main() { + const accessToken = process.env.FRESHBOOKS_ACCESS_TOKEN; + const accountId = process.env.FRESHBOOKS_ACCOUNT_ID; + + if (!accessToken) { + console.error("Error: FRESHBOOKS_ACCESS_TOKEN environment variable required"); + process.exit(1); + } + if (!accountId) { + console.error("Error: FRESHBOOKS_ACCOUNT_ID environment variable required"); + process.exit(1); + } + + const client = new FreshBooksClient(accessToken, accountId); + + const server = new Server( + { name: `${MCP_NAME}-mcp`, version: MCP_VERSION }, + { capabilities: { tools: {} } } + ); + + // List available tools + server.setRequestHandler(ListToolsRequestSchema, async () => ({ + tools, + })); + + // Handle tool calls + server.setRequestHandler(CallToolRequestSchema, async (request) => { + const { name, arguments: args } = request.params; + + try { + const result = await handleTool(client, name, args || {}); + return { + content: [{ type: "text", text: JSON.stringify(result, null, 2) }], + }; + } catch (error) { + const message = error instanceof Error ? error.message : String(error); + return { + content: [{ type: "text", text: `Error: ${message}` }], + isError: true, + }; + } + }); + + // Start server + const transport = new StdioServerTransport(); + await server.connect(transport); + console.error(`${MCP_NAME} MCP server running on stdio`); +} + +main().catch(console.error); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..de6431e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,15 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "NodeNext", + "moduleResolution": "NodeNext", + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "declaration": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +}