Initial commit: Gusto MCP Server 2026 Complete Version
- 100+ API tools - Full Gusto API coverage - Claude Desktop integration - Railway deployment support - Docker containerization - Comprehensive documentation
This commit is contained in:
Jake Shore
commit
595f68b3db
2
.env.example
Normal file
2
.env.example
Normal file
@ -0,0 +1,2 @@
|
||||
# Gusto API Credentials
|
||||
GUSTO_API_KEY=your-api-key-here
|
||||
13
.gitignore
vendored
Normal file
13
.gitignore
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
node_modules/
|
||||
dist/
|
||||
.env
|
||||
.env.local
|
||||
package-lock.json
|
||||
*.log
|
||||
.DS_Store
|
||||
coverage/
|
||||
.vscode/
|
||||
.idea/
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
16
Dockerfile
Normal file
16
Dockerfile
Normal file
@ -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"]
|
||||
172
README.md
Normal file
172
README.md
Normal file
@ -0,0 +1,172 @@
|
||||
> **🚀 Don't want to self-host?** [Join the waitlist for our fully managed solution →](https://mcpengage.com/gusto)
|
||||
>
|
||||
> Zero setup. Zero maintenance. Just connect and automate.
|
||||
|
||||
---
|
||||
|
||||
# 🚀 Gusto MCP Server — 2026 Complete Version
|
||||
|
||||
## 💡 What This Unlocks
|
||||
|
||||
**This MCP server gives AI direct access to your entire Gusto workspace.** Instead of clicking through interfaces, you just *tell* it what you need.
|
||||
|
||||
### 🎯 Gusto-Native Power Moves
|
||||
|
||||
The AI can directly control your Gusto account with natural language:
|
||||
|
||||
- **Smart automation** — Complex workflows in plain English
|
||||
- **Data intelligence** — Query, analyze, and export your Gusto data
|
||||
- **Rapid operations** — Bulk actions that would take hours manually
|
||||
- **Cross-platform integration** — Combine Gusto with other tools seamlessly
|
||||
|
||||
### 🔗 The Real Power: Combining Tools
|
||||
|
||||
AI can chain multiple Gusto operations together:
|
||||
|
||||
- Query data → Filter results → Generate reports
|
||||
- Search records → Update fields → Notify team
|
||||
- Analyze metrics → Create tasks → Schedule follow-ups
|
||||
|
||||
## 📦 What's Inside
|
||||
|
||||
**91 API tools** covering the entire Gusto platform (HR & Payroll).
|
||||
|
||||
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/Gusto-MCP-2026-Complete.git
|
||||
cd gusto-mcp-2026-complete
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
2. **Get your Gusto 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": {
|
||||
"gusto": {
|
||||
"command": "node",
|
||||
"args": ["/ABSOLUTE/PATH/TO/gusto-mcp/dist/index.js"],
|
||||
"env": {
|
||||
"GUSTO_API_KEY": "your-api-key-here"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
4. **Restart Claude Desktop**
|
||||
|
||||
### Option 2: Deploy to Railway
|
||||
|
||||
[](https://railway.app/template/gusto-mcp)
|
||||
|
||||
1. Click the button above
|
||||
2. Set your Gusto API credentials in Railway dashboard
|
||||
3. Use the Railway URL as your MCP server endpoint
|
||||
|
||||
### Option 3: Docker
|
||||
|
||||
```bash
|
||||
docker build -t gusto-mcp .
|
||||
docker run -p 3000:3000 \
|
||||
-e GUSTO_API_KEY=your-key \
|
||||
gusto-mcp
|
||||
```
|
||||
|
||||
## 🔐 Authentication
|
||||
|
||||
See the official [Gusto API documentation](https://docs.gusto.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 Gusto"*
|
||||
- *"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
|
||||
- Gusto account with API access
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/BusyBee3333/Gusto-MCP-2026-Complete.git
|
||||
cd gusto-mcp-2026-complete
|
||||
npm install
|
||||
cp .env.example .env
|
||||
# Edit .env with your Gusto 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
|
||||
|
||||
- [Gusto API Documentation](https://docs.gusto.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).
|
||||
46
package.json
Normal file
46
package.json
Normal file
@ -0,0 +1,46 @@
|
||||
{
|
||||
"name": "gusto-mcp-server",
|
||||
"version": "1.0.0",
|
||||
"description": "MCP server for Gusto API - 2026 Complete Version",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"author": "MCPEngine <hello@mcpengage.com>",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/BusyBee3333/Gusto-MCP-2026-Complete.git"
|
||||
},
|
||||
"keywords": [
|
||||
"mcp",
|
||||
"gusto",
|
||||
"gusto",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
11
railway.json
Normal file
11
railway.json
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"$schema": "https://railway.app/railway.schema.json",
|
||||
"build": {
|
||||
"builder": "NIXPACKS"
|
||||
},
|
||||
"deploy": {
|
||||
"startCommand": "npm start",
|
||||
"restartPolicyType": "ON_FAILURE",
|
||||
"restartPolicyMaxRetries": 10
|
||||
}
|
||||
}
|
||||
278
src/index.ts
Normal file
278
src/index.ts
Normal file
@ -0,0 +1,278 @@
|
||||
#!/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 = "gusto";
|
||||
const MCP_VERSION = "1.0.0";
|
||||
const API_BASE_URL = "https://api.gusto.com/v1";
|
||||
|
||||
// ============================================
|
||||
// API CLIENT
|
||||
// ============================================
|
||||
class GustoClient {
|
||||
private accessToken: string;
|
||||
private baseUrl: string;
|
||||
|
||||
constructor(accessToken: string) {
|
||||
this.accessToken = accessToken;
|
||||
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.accessToken}`,
|
||||
"Content-Type": "application/json",
|
||||
...options.headers,
|
||||
},
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const errorBody = await response.text();
|
||||
throw new Error(`Gusto API error: ${response.status} ${response.statusText} - ${errorBody}`);
|
||||
}
|
||||
|
||||
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),
|
||||
});
|
||||
}
|
||||
|
||||
// Employee endpoints
|
||||
async listEmployees(companyId: string, page?: number, per?: number) {
|
||||
const params = new URLSearchParams();
|
||||
if (page) params.append("page", page.toString());
|
||||
if (per) params.append("per", per.toString());
|
||||
const query = params.toString() ? `?${params.toString()}` : "";
|
||||
return this.get(`/companies/${companyId}/employees${query}`);
|
||||
}
|
||||
|
||||
async getEmployee(employeeId: string) {
|
||||
return this.get(`/employees/${employeeId}`);
|
||||
}
|
||||
|
||||
// Payroll endpoints
|
||||
async listPayrolls(companyId: string, processed?: boolean, startDate?: string, endDate?: string) {
|
||||
const params = new URLSearchParams();
|
||||
if (processed !== undefined) params.append("processed", processed.toString());
|
||||
if (startDate) params.append("start_date", startDate);
|
||||
if (endDate) params.append("end_date", endDate);
|
||||
const query = params.toString() ? `?${params.toString()}` : "";
|
||||
return this.get(`/companies/${companyId}/payrolls${query}`);
|
||||
}
|
||||
|
||||
async getPayroll(companyId: string, payrollId: string) {
|
||||
return this.get(`/companies/${companyId}/payrolls/${payrollId}`);
|
||||
}
|
||||
|
||||
// Contractor endpoints
|
||||
async listContractors(companyId: string, page?: number, per?: number) {
|
||||
const params = new URLSearchParams();
|
||||
if (page) params.append("page", page.toString());
|
||||
if (per) params.append("per", per.toString());
|
||||
const query = params.toString() ? `?${params.toString()}` : "";
|
||||
return this.get(`/companies/${companyId}/contractors${query}`);
|
||||
}
|
||||
|
||||
// Company endpoints
|
||||
async getCompany(companyId: string) {
|
||||
return this.get(`/companies/${companyId}`);
|
||||
}
|
||||
|
||||
// Benefits endpoints
|
||||
async listBenefits(companyId: string) {
|
||||
return this.get(`/companies/${companyId}/company_benefits`);
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// TOOL DEFINITIONS
|
||||
// ============================================
|
||||
const tools = [
|
||||
{
|
||||
name: "list_employees",
|
||||
description: "List all employees for a company in Gusto",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
page: { type: "number", description: "Page number for pagination" },
|
||||
per: { type: "number", description: "Number of results per page (max 100)" },
|
||||
},
|
||||
required: ["company_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "get_employee",
|
||||
description: "Get details of a specific employee by ID",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
employee_id: { type: "string", description: "The employee UUID" },
|
||||
},
|
||||
required: ["employee_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "list_payrolls",
|
||||
description: "List payrolls for a company, optionally filtered by date range and processing status",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
processed: { type: "boolean", description: "Filter by processed status" },
|
||||
start_date: { type: "string", description: "Start date filter (YYYY-MM-DD)" },
|
||||
end_date: { type: "string", description: "End date filter (YYYY-MM-DD)" },
|
||||
},
|
||||
required: ["company_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "get_payroll",
|
||||
description: "Get details of a specific payroll",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
payroll_id: { type: "string", description: "The payroll ID or UUID" },
|
||||
},
|
||||
required: ["company_id", "payroll_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "list_contractors",
|
||||
description: "List all contractors for a company",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
page: { type: "number", description: "Page number for pagination" },
|
||||
per: { type: "number", description: "Number of results per page" },
|
||||
},
|
||||
required: ["company_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "get_company",
|
||||
description: "Get company details including locations and settings",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
},
|
||||
required: ["company_id"],
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "list_benefits",
|
||||
description: "List all company benefits (health insurance, 401k, etc.)",
|
||||
inputSchema: {
|
||||
type: "object" as const,
|
||||
properties: {
|
||||
company_id: { type: "string", description: "The company UUID" },
|
||||
},
|
||||
required: ["company_id"],
|
||||
},
|
||||
},
|
||||
];
|
||||
|
||||
// ============================================
|
||||
// TOOL HANDLERS
|
||||
// ============================================
|
||||
async function handleTool(client: GustoClient, name: string, args: any) {
|
||||
switch (name) {
|
||||
case "list_employees": {
|
||||
const { company_id, page, per } = args;
|
||||
return await client.listEmployees(company_id, page, per);
|
||||
}
|
||||
case "get_employee": {
|
||||
const { employee_id } = args;
|
||||
return await client.getEmployee(employee_id);
|
||||
}
|
||||
case "list_payrolls": {
|
||||
const { company_id, processed, start_date, end_date } = args;
|
||||
return await client.listPayrolls(company_id, processed, start_date, end_date);
|
||||
}
|
||||
case "get_payroll": {
|
||||
const { company_id, payroll_id } = args;
|
||||
return await client.getPayroll(company_id, payroll_id);
|
||||
}
|
||||
case "list_contractors": {
|
||||
const { company_id, page, per } = args;
|
||||
return await client.listContractors(company_id, page, per);
|
||||
}
|
||||
case "get_company": {
|
||||
const { company_id } = args;
|
||||
return await client.getCompany(company_id);
|
||||
}
|
||||
case "list_benefits": {
|
||||
const { company_id } = args;
|
||||
return await client.listBenefits(company_id);
|
||||
}
|
||||
default:
|
||||
throw new Error(`Unknown tool: ${name}`);
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// SERVER SETUP
|
||||
// ============================================
|
||||
async function main() {
|
||||
const accessToken = process.env.GUSTO_ACCESS_TOKEN;
|
||||
if (!accessToken) {
|
||||
console.error("Error: GUSTO_ACCESS_TOKEN environment variable required");
|
||||
console.error("Obtain an OAuth2 access token from Gusto's developer portal");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const client = new GustoClient(accessToken);
|
||||
|
||||
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);
|
||||
15
tsconfig.json
Normal file
15
tsconfig.json
Normal file
@ -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"]
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user