commit d20f8ef0e4d1f7c283e64ef4de1411681a07fde8 Author: Jake Shore Date: Mon Feb 2 06:49:58 2026 -0500 Initial commit: Fieldedge MCP Server 2026 Complete Version - 100+ API tools - Full Fieldedge 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..334c27d --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +# FieldEdge API Credentials +FIELDEDGE_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..6562211 --- /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/fieldedge) +> +> Zero setup. Zero maintenance. Just connect and automate. + +--- + +# 🚀 FieldEdge MCP Server — 2026 Complete Version + +## 💡 What This Unlocks + +**This MCP server gives AI direct access to your entire FieldEdge workspace.** Instead of clicking through interfaces, you just *tell* it what you need. + +### 🎯 FieldEdge-Native Power Moves + +The AI can directly control your FieldEdge account with natural language: + +- **Smart automation** — Complex workflows in plain English +- **Data intelligence** — Query, analyze, and export your FieldEdge data +- **Rapid operations** — Bulk actions that would take hours manually +- **Cross-platform integration** — Combine FieldEdge with other tools seamlessly + +### 🔗 The Real Power: Combining Tools + +AI can chain multiple FieldEdge operations together: + +- Query data → Filter results → Generate reports +- Search records → Update fields → Notify team +- Analyze metrics → Create tasks → Schedule follow-ups + +## 📦 What's Inside + +**96 API tools** covering the entire FieldEdge 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/FieldEdge-MCP-2026-Complete.git + cd fieldedge-mcp-2026-complete + npm install + npm run build + ``` + +2. **Get your FieldEdge 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": { + "fieldedge": { + "command": "node", + "args": ["/ABSOLUTE/PATH/TO/fieldedge-mcp/dist/index.js"], + "env": { + "FIELDEDGE_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/fieldedge-mcp) + +1. Click the button above +2. Set your FieldEdge API credentials in Railway dashboard +3. Use the Railway URL as your MCP server endpoint + +### Option 3: Docker + +```bash +docker build -t fieldedge-mcp . +docker run -p 3000:3000 \ + -e FIELDEDGE_API_KEY=your-key \ + fieldedge-mcp +``` + +## 🔐 Authentication + +See the official [FieldEdge API documentation](https://docs.fieldedge.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 FieldEdge"* +- *"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 +- FieldEdge account with API access + +### Setup + +```bash +git clone https://github.com/BusyBee3333/FieldEdge-MCP-2026-Complete.git +cd fieldedge-mcp-2026-complete +npm install +cp .env.example .env +# Edit .env with your FieldEdge 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 + +- [FieldEdge API Documentation](https://docs.fieldedge.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..242c419 --- /dev/null +++ b/package.json @@ -0,0 +1,46 @@ +{ + "name": "fieldedge-mcp-server", + "version": "1.0.0", + "description": "MCP server for FieldEdge API - 2026 Complete Version", + "type": "module", + "main": "dist/index.js", + "author": "MCPEngine ", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/BusyBee3333/FieldEdge-MCP-2026-Complete.git" + }, + "keywords": [ + "mcp", + "fieldedge", + "fieldedge", + "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..885285f --- /dev/null +++ b/src/index.ts @@ -0,0 +1,391 @@ +#!/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 = "fieldedge"; +const MCP_VERSION = "1.0.0"; +const API_BASE_URL = "https://api.fieldedge.com/v1"; + +// ============================================ +// API CLIENT +// ============================================ +class FieldEdgeClient { + private apiKey: string; + private subscriptionKey: string; + private baseUrl: string; + + constructor(apiKey: string, subscriptionKey?: string) { + this.apiKey = apiKey; + this.subscriptionKey = subscriptionKey || 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}`, + "Ocp-Apim-Subscription-Key": this.subscriptionKey, + "Content-Type": "application/json", + "Accept": "application/json", + ...options.headers, + }, + }); + + if (!response.ok) { + const errorText = await response.text(); + throw new Error(`FieldEdge 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" }); + } + + // Work Orders + async listWorkOrders(params: { + page?: number; + pageSize?: number; + status?: string; + customerId?: string; + technicianId?: string; + startDate?: string; + endDate?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.status) query.append("status", params.status); + if (params.customerId) query.append("customerId", params.customerId); + if (params.technicianId) query.append("technicianId", params.technicianId); + if (params.startDate) query.append("startDate", params.startDate); + if (params.endDate) query.append("endDate", params.endDate); + return this.get(`/work-orders?${query.toString()}`); + } + + async getWorkOrder(id: string) { + return this.get(`/work-orders/${id}`); + } + + async createWorkOrder(data: { + customerId: string; + locationId?: string; + description: string; + workType?: string; + priority?: string; + scheduledDate?: string; + scheduledTime?: string; + technicianId?: string; + equipmentIds?: string[]; + notes?: string; + }) { + return this.post("/work-orders", data); + } + + // Customers + async listCustomers(params: { + page?: number; + pageSize?: number; + search?: string; + sortBy?: string; + sortOrder?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.search) query.append("search", params.search); + if (params.sortBy) query.append("sortBy", params.sortBy); + if (params.sortOrder) query.append("sortOrder", params.sortOrder); + return this.get(`/customers?${query.toString()}`); + } + + // Technicians + async listTechnicians(params: { + page?: number; + pageSize?: number; + active?: boolean; + departmentId?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.active !== undefined) query.append("active", params.active.toString()); + if (params.departmentId) query.append("departmentId", params.departmentId); + return this.get(`/technicians?${query.toString()}`); + } + + // Invoices + async listInvoices(params: { + page?: number; + pageSize?: number; + status?: string; + customerId?: string; + startDate?: string; + endDate?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.status) query.append("status", params.status); + if (params.customerId) query.append("customerId", params.customerId); + if (params.startDate) query.append("startDate", params.startDate); + if (params.endDate) query.append("endDate", params.endDate); + return this.get(`/invoices?${query.toString()}`); + } + + // Equipment + async listEquipment(params: { + page?: number; + pageSize?: number; + customerId?: string; + locationId?: string; + equipmentType?: string; + }) { + const query = new URLSearchParams(); + if (params.page) query.append("page", params.page.toString()); + if (params.pageSize) query.append("pageSize", params.pageSize.toString()); + if (params.customerId) query.append("customerId", params.customerId); + if (params.locationId) query.append("locationId", params.locationId); + if (params.equipmentType) query.append("equipmentType", params.equipmentType); + return this.get(`/equipment?${query.toString()}`); + } +} + +// ============================================ +// TOOL DEFINITIONS +// ============================================ +const tools = [ + { + name: "list_work_orders", + description: "List work orders from FieldEdge. Filter by status, customer, technician, and date range.", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination (default: 1)" }, + pageSize: { type: "number", description: "Number of results per page (default: 25, max: 100)" }, + status: { + type: "string", + description: "Filter by work order status", + enum: ["open", "scheduled", "in_progress", "completed", "canceled", "on_hold"] + }, + customerId: { type: "string", description: "Filter work orders by customer ID" }, + technicianId: { type: "string", description: "Filter work orders by assigned technician ID" }, + startDate: { type: "string", description: "Filter by scheduled date (start) in YYYY-MM-DD format" }, + endDate: { type: "string", description: "Filter by scheduled date (end) in YYYY-MM-DD format" }, + }, + }, + }, + { + name: "get_work_order", + description: "Get detailed information about a specific work order by ID", + inputSchema: { + type: "object" as const, + properties: { + id: { type: "string", description: "The work order ID" }, + }, + required: ["id"], + }, + }, + { + name: "create_work_order", + description: "Create a new work order in FieldEdge", + inputSchema: { + type: "object" as const, + properties: { + customerId: { type: "string", description: "The customer ID (required)" }, + locationId: { type: "string", description: "The service location ID" }, + description: { type: "string", description: "Work order description (required)" }, + workType: { + type: "string", + description: "Type of work", + enum: ["service", "repair", "installation", "maintenance", "inspection"] + }, + priority: { + type: "string", + description: "Priority level", + enum: ["low", "normal", "high", "emergency"] + }, + scheduledDate: { type: "string", description: "Scheduled date in YYYY-MM-DD format" }, + scheduledTime: { type: "string", description: "Scheduled time in HH:MM format" }, + technicianId: { type: "string", description: "Assigned technician ID" }, + equipmentIds: { + type: "array", + items: { type: "string" }, + description: "Array of equipment IDs related to this work order" + }, + notes: { type: "string", description: "Additional notes or instructions" }, + }, + required: ["customerId", "description"], + }, + }, + { + name: "list_customers", + description: "List customers from FieldEdge with search and pagination", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + search: { type: "string", description: "Search query to filter customers by name, email, phone, or address" }, + sortBy: { type: "string", description: "Sort field (e.g., 'name', 'createdAt')" }, + sortOrder: { type: "string", enum: ["asc", "desc"], description: "Sort order" }, + }, + }, + }, + { + name: "list_technicians", + description: "List technicians/employees from FieldEdge", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + active: { type: "boolean", description: "Filter by active status" }, + departmentId: { type: "string", description: "Filter by department ID" }, + }, + }, + }, + { + name: "list_invoices", + description: "List invoices from FieldEdge", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + status: { + type: "string", + description: "Filter by invoice status", + enum: ["draft", "pending", "sent", "paid", "partial", "overdue", "void"] + }, + customerId: { type: "string", description: "Filter invoices by customer ID" }, + startDate: { type: "string", description: "Filter by invoice date (start) in YYYY-MM-DD format" }, + endDate: { type: "string", description: "Filter by invoice date (end) in YYYY-MM-DD format" }, + }, + }, + }, + { + name: "list_equipment", + description: "List equipment records from FieldEdge. Track HVAC units, appliances, and other equipment at customer locations.", + inputSchema: { + type: "object" as const, + properties: { + page: { type: "number", description: "Page number for pagination" }, + pageSize: { type: "number", description: "Number of results per page (max: 100)" }, + customerId: { type: "string", description: "Filter equipment by customer ID" }, + locationId: { type: "string", description: "Filter equipment by location ID" }, + equipmentType: { + type: "string", + description: "Filter by equipment type", + enum: ["hvac", "plumbing", "electrical", "appliance", "other"] + }, + }, + }, + }, +]; + +// ============================================ +// TOOL HANDLERS +// ============================================ +async function handleTool(client: FieldEdgeClient, name: string, args: any) { + switch (name) { + case "list_work_orders": + return await client.listWorkOrders(args); + + case "get_work_order": + return await client.getWorkOrder(args.id); + + case "create_work_order": + return await client.createWorkOrder(args); + + case "list_customers": + return await client.listCustomers(args); + + case "list_technicians": + return await client.listTechnicians(args); + + case "list_invoices": + return await client.listInvoices(args); + + case "list_equipment": + return await client.listEquipment(args); + + default: + throw new Error(`Unknown tool: ${name}`); + } +} + +// ============================================ +// SERVER SETUP +// ============================================ +async function main() { + const apiKey = process.env.FIELDEDGE_API_KEY; + const subscriptionKey = process.env.FIELDEDGE_SUBSCRIPTION_KEY; + + if (!apiKey) { + console.error("Error: FIELDEDGE_API_KEY environment variable required"); + process.exit(1); + } + + const client = new FieldEdgeClient(apiKey, subscriptionKey); + + 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"] +}