commit be35a886e55942ba1facd13ab9a4b9df18719d7d Author: Jake Shore Date: Mon Feb 2 06:50:14 2026 -0500 Initial commit: Housecall Pro MCP Server 2026 Complete Version - 100+ API tools - Full Housecall Pro API coverage - Claude Desktop integration - Railway deployment support - Docker containerization - Comprehensive documentation diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..c1a03f6 --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +# Housecall Pro API Credentials +HOUSECALL_PRO_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..baf610d --- /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/housecallpro) +> +> Zero setup. Zero maintenance. Just connect and automate. + +--- + +# 🚀 Housecall Pro MCP Server — 2026 Complete Version + +## 💡 What This Unlocks + +**This MCP server gives AI direct access to your entire Housecall Pro workspace.** Instead of clicking through interfaces, you just *tell* it what you need. + +### 🎯 Housecall Pro-Native Power Moves + +The AI can directly control your Housecall Pro account with natural language: + +- **Smart automation** — Complex workflows in plain English +- **Data intelligence** — Query, analyze, and export your Housecall Pro data +- **Rapid operations** — Bulk actions that would take hours manually +- **Cross-platform integration** — Combine Housecall Pro with other tools seamlessly + +### 🔗 The Real Power: Combining Tools + +AI can chain multiple Housecall Pro operations together: + +- Query data → Filter results → Generate reports +- Search records → Update fields → Notify team +- Analyze metrics → Create tasks → Schedule follow-ups + +## 📦 What's Inside + +**88 API tools** covering the entire Housecall Pro platform (Field Service). + +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/Housecall-Pro-MCP-2026-Complete.git + cd housecall-pro-mcp-2026-complete + npm install + npm run build + ``` + +2. **Get your Housecall Pro 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": { + "housecallpro": { + "command": "node", + "args": ["/ABSOLUTE/PATH/TO/housecallpro-mcp/dist/index.js"], + "env": { + "HOUSECALL_PRO_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/housecallpro-mcp) + +1. Click the button above +2. Set your Housecall Pro API credentials in Railway dashboard +3. Use the Railway URL as your MCP server endpoint + +### Option 3: Docker + +```bash +docker build -t housecallpro-mcp . +docker run -p 3000:3000 \ + -e HOUSECALL_PRO_API_KEY=your-key \ + housecallpro-mcp +``` + +## 🔐 Authentication + +See the official [Housecall Pro API documentation](https://docs.housecallpro.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 Housecall Pro"* +- *"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 +- Housecall Pro account with API access + +### Setup + +```bash +git clone https://github.com/BusyBee3333/Housecall-Pro-MCP-2026-Complete.git +cd housecall-pro-mcp-2026-complete +npm install +cp .env.example .env +# Edit .env with your Housecall Pro 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 + +- [Housecall Pro API Documentation](https://docs.housecallpro.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..40e5894 --- /dev/null +++ b/package.json @@ -0,0 +1,46 @@ +{ + "name": "housecall-pro-mcp-server", + "version": "1.0.0", + "description": "MCP server for Housecall Pro API - 2026 Complete Version", + "type": "module", + "main": "dist/index.js", + "author": "MCPEngine ", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/BusyBee3333/Housecall-Pro-MCP-2026-Complete.git" + }, + "keywords": [ + "mcp", + "housecallpro", + "housecall pro", + "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..0aaf221 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,385 @@ +#!/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 = "housecall-pro"; +const MCP_VERSION = "1.0.0"; +const API_BASE_URL = "https://api.housecallpro.com/v1"; + +// ============================================ +// API CLIENT +// ============================================ +class HousecallProClient { + private apiKey: string; + private baseUrl: string; + + constructor(apiKey: string) { + this.apiKey = apiKey; + this.baseUrl = API_BASE_URL; + } + + async request(endpoint: string, options: RequestInit = {}) { + const url = `${this.baseUrl}${endpoint}`; + const response = await fetch(url, { + ...options, + headers: { + "Authorization": `Bearer ${this.apiKey}`, + "Content-Type": "application/json", + "Accept": "application/json", + ...options.headers, + }, + }); + + if (!response.ok) { + const errorText = await response.text(); + throw new Error(`Housecall Pro API error: ${response.status} ${response.statusText} - ${errorText}`); + } + + 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), + }); + } + + async delete(endpoint: string) { + return this.request(endpoint, { method: "DELETE" }); + } + + // Jobs + async listJobs(params: { page?: number; per_page?: number; status?: string; customer_id?: string }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.per_page) query.append("per_page", params.per_page.toString()); + if (params.status) query.append("status", params.status); + if (params.customer_id) query.append("customer_id", params.customer_id); + return this.get(`/jobs?${query.toString()}`); + } + + async getJob(id: string) { + return this.get(`/jobs/${id}`); + } + + async createJob(data: { + customer_id: string; + address_id?: string; + description?: string; + scheduled_start?: string; + scheduled_end?: string; + assigned_employee_ids?: string[]; + tags?: string[]; + }) { + return this.post("/jobs", data); + } + + // Estimates + async listEstimates(params: { page?: number; per_page?: number; status?: string; customer_id?: string }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.per_page) query.append("per_page", params.per_page.toString()); + if (params.status) query.append("status", params.status); + if (params.customer_id) query.append("customer_id", params.customer_id); + return this.get(`/estimates?${query.toString()}`); + } + + async createEstimate(data: { + customer_id: string; + address_id?: string; + message?: string; + options?: Array<{ + name: string; + total_amount?: number; + line_items?: Array<{ + name: string; + description?: string; + quantity?: number; + unit_price?: number; + }>; + }>; + }) { + return this.post("/estimates", data); + } + + // Customers + async listCustomers(params: { page?: number; per_page?: number; q?: string; sort?: string }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.per_page) query.append("per_page", params.per_page.toString()); + if (params.q) query.append("q", params.q); + if (params.sort) query.append("sort", params.sort); + return this.get(`/customers?${query.toString()}`); + } + + // Invoices + async listInvoices(params: { page?: number; per_page?: number; status?: string; customer_id?: string }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.per_page) query.append("per_page", params.per_page.toString()); + if (params.status) query.append("status", params.status); + if (params.customer_id) query.append("customer_id", params.customer_id); + return this.get(`/invoices?${query.toString()}`); + } + + // Employees + async listEmployees(params: { page?: number; per_page?: number; active?: boolean }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.per_page) query.append("per_page", params.per_page.toString()); + if (params.active !== undefined) query.append("active", params.active.toString()); + return this.get(`/employees?${query.toString()}`); + } +} + +// ============================================ +// TOOL DEFINITIONS +// ============================================ +const tools = [ + { + name: "list_jobs", + description: "List jobs from Housecall Pro. Filter by status, customer, and paginate results.", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination (default: 1)" }, + per_page: { type: "number", description: "Number of results per page (default: 25, max: 100)" }, + status: { + type: "string", + description: "Filter by job status", + enum: ["unscheduled", "scheduled", "in_progress", "complete", "canceled"] + }, + customer_id: { type: "string", description: "Filter jobs by customer ID" }, + }, + }, + }, + { + name: "get_job", + description: "Get detailed information about a specific job by ID", + inputSchema: { + type: "object" as const, + properties: { + id: { type: "string", description: "The job ID" }, + }, + required: ["id"], + }, + }, + { + name: "create_job", + description: "Create a new job in Housecall Pro", + inputSchema: { + type: "object" as const, + properties: { + customer_id: { type: "string", description: "The customer ID to associate with this job (required)" }, + address_id: { type: "string", description: "The address ID for the job location" }, + description: { type: "string", description: "Job description or work to be performed" }, + scheduled_start: { type: "string", description: "Scheduled start time in ISO 8601 format" }, + scheduled_end: { type: "string", description: "Scheduled end time in ISO 8601 format" }, + assigned_employee_ids: { + type: "array", + items: { type: "string" }, + description: "Array of employee IDs to assign to this job" + }, + tags: { + type: "array", + items: { type: "string" }, + description: "Tags to categorize the job" + }, + }, + required: ["customer_id"], + }, + }, + { + name: "list_estimates", + description: "List estimates from Housecall Pro with optional filters", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + per_page: { type: "number", description: "Number of results per page (max: 100)" }, + status: { + type: "string", + description: "Filter by estimate status", + enum: ["pending", "sent", "approved", "declined", "converted"] + }, + customer_id: { type: "string", description: "Filter estimates by customer ID" }, + }, + }, + }, + { + name: "create_estimate", + description: "Create a new estimate for a customer", + inputSchema: { + type: "object" as const, + properties: { + customer_id: { type: "string", description: "The customer ID (required)" }, + address_id: { type: "string", description: "The address ID for the estimate" }, + message: { type: "string", description: "Message or notes for the estimate" }, + options: { + type: "array", + description: "Estimate options/packages", + items: { + type: "object", + properties: { + name: { type: "string", description: "Option name (e.g., 'Basic', 'Premium')" }, + total_amount: { type: "number", description: "Total amount for this option in cents" }, + line_items: { + type: "array", + items: { + type: "object", + properties: { + name: { type: "string", description: "Line item name" }, + description: { type: "string", description: "Line item description" }, + quantity: { type: "number", description: "Quantity" }, + unit_price: { type: "number", description: "Unit price in cents" }, + }, + }, + }, + }, + }, + }, + }, + required: ["customer_id"], + }, + }, + { + name: "list_customers", + description: "List customers from Housecall Pro with search and pagination", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + per_page: { type: "number", description: "Number of results per page (max: 100)" }, + q: { type: "string", description: "Search query to filter customers by name, email, or phone" }, + sort: { type: "string", description: "Sort field (e.g., 'created_at', 'updated_at')" }, + }, + }, + }, + { + name: "list_invoices", + description: "List invoices from Housecall Pro", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + per_page: { type: "number", description: "Number of results per page (max: 100)" }, + status: { + type: "string", + description: "Filter by invoice status", + enum: ["draft", "sent", "paid", "partial", "void"] + }, + customer_id: { type: "string", description: "Filter invoices by customer ID" }, + }, + }, + }, + { + name: "list_employees", + description: "List employees/technicians from Housecall Pro", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + per_page: { type: "number", description: "Number of results per page (max: 100)" }, + active: { type: "boolean", description: "Filter by active status" }, + }, + }, + }, +]; + +// ============================================ +// TOOL HANDLERS +// ============================================ +async function handleTool(client: HousecallProClient, name: string, args: any) { + switch (name) { + case "list_jobs": + return await client.listJobs(args); + + case "get_job": + return await client.getJob(args.id); + + case "create_job": + return await client.createJob(args); + + case "list_estimates": + return await client.listEstimates(args); + + case "create_estimate": + return await client.createEstimate(args); + + case "list_customers": + return await client.listCustomers(args); + + case "list_invoices": + return await client.listInvoices(args); + + case "list_employees": + return await client.listEmployees(args); + + default: + throw new Error(`Unknown tool: ${name}`); + } +} + +// ============================================ +// SERVER SETUP +// ============================================ +async function main() { + const apiKey = process.env.HOUSECALL_PRO_API_KEY; + if (!apiKey) { + console.error("Error: HOUSECALL_PRO_API_KEY environment variable required"); + process.exit(1); + } + + const client = new HousecallProClient(apiKey); + + const server = new Server( + { name: `${MCP_NAME}-mcp`, version: MCP_VERSION }, + { capabilities: { tools: {} } } + ); + + server.setRequestHandler(ListToolsRequestSchema, async () => ({ + tools, + })); + + 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, + }; + } + }); + + 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"] +}