212 lines
6.9 KiB
Markdown
212 lines
6.9 KiB
Markdown
> **🚀 Don't want to self-host?** [Join the waitlist for our fully managed solution →](https://mcpengage.com/rippling)
|
|
>
|
|
> Zero setup. Zero maintenance. Just connect and automate.
|
|
|
|
---
|
|
|
|
# 🚀 Rippling MCP Server — 2026 Complete Version
|
|
|
|
## 💡 What This Unlocks
|
|
|
|
**This MCP server gives AI direct access to your entire Rippling workspace.** Instead of clicking through interfaces, you just *tell* it what you need.
|
|
|
|
### 🎯 HR & IT Power Moves with Rippling
|
|
|
|
The AI can directly control your Rippling account with natural language:
|
|
|
|
1. **New Hire Provisioning** — "Get all employees starting next week, list their assigned devices, check which apps they need access to, and generate IT setup checklists"
|
|
|
|
2. **Payroll Intelligence** — "Pull payroll summary for Q1 2026, group by department, identify outliers, and flag any employees with missing tax documents"
|
|
|
|
3. **Device Audit** — "List all MacBooks assigned in the last 6 months, show which employees have them, check for missing devices, and generate a replacement schedule"
|
|
|
|
4. **Org Structure Analysis** — "Map all departments, teams, and job levels — identify gaps in the reporting structure and suggest reorganization opportunities"
|
|
|
|
5. **Leave Management** — "Show all approved leave requests for December, calculate coverage gaps by team, and identify who's available for on-call"
|
|
|
|
### 🔗 The Real Power: Combining Tools
|
|
|
|
AI can chain multiple Rippling operations together:
|
|
|
|
- Query employees → Check device assignments → Provision missing apps
|
|
- Pull leave requests → Cross-reference team coverage → Alert managers
|
|
- Get payroll data → Match with performance levels → Generate compensation analysis
|
|
|
|
## 📦 What's Inside
|
|
|
|
**12 API tools** covering Rippling HR and IT operations:
|
|
|
|
- `list_employees` — All employees with employment details and status
|
|
- `get_employee` — Detailed employee profile with manager and personal info
|
|
- `list_departments` — Department hierarchy and structure
|
|
- `list_teams` — Cross-functional teams and groups
|
|
- `get_payroll` — Payroll runs and compensation data
|
|
- `list_devices` — IT-managed devices (laptops, phones, tablets)
|
|
- `list_apps` — Integrated applications and provisioning status
|
|
- `get_company` — Company information and settings
|
|
- `list_groups` — Custom groups for access control
|
|
- `list_levels` — Job levels and career ladders
|
|
- `list_work_locations` — Office locations and remote sites
|
|
- `get_leave_requests` — PTO and leave requests with status
|
|
|
|
All with proper error handling, OAuth authentication, and TypeScript types.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Option 1: Claude Desktop (Local)
|
|
|
|
1. **Clone and build:**
|
|
```bash
|
|
git clone https://github.com/BusyBee3333/Rippling-MCP-2026-Complete.git
|
|
cd rippling-mcp-2026-complete
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
2. **Get your Rippling API credentials:**
|
|
- Log into Rippling → Settings → Integrations → API
|
|
- Create OAuth application or generate API token
|
|
- Copy your API key/OAuth token
|
|
|
|
3. **Configure Claude Desktop:**
|
|
|
|
On macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
|
|
On Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"rippling": {
|
|
"command": "node",
|
|
"args": ["/ABSOLUTE/PATH/TO/rippling-mcp-2026-complete/dist/index.js"],
|
|
"env": {
|
|
"RIPPLING_API_KEY": "your-api-key-here"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
4. **Restart Claude Desktop**
|
|
|
|
### Option 2: Deploy to Railway
|
|
|
|
[](https://railway.app/template/rippling-mcp)
|
|
|
|
1. Click the button above
|
|
2. Set `RIPPLING_API_KEY` in Railway dashboard
|
|
3. Use the Railway URL as your MCP server endpoint
|
|
|
|
### Option 3: Docker
|
|
|
|
```bash
|
|
docker build -t rippling-mcp .
|
|
docker run -p 3000:3000 \
|
|
-e RIPPLING_API_KEY=your-key \
|
|
rippling-mcp
|
|
```
|
|
|
|
## 🔐 Authentication
|
|
|
|
Rippling uses **OAuth 2.0** or **API Token authentication**.
|
|
|
|
**Get your API credentials:**
|
|
1. Rippling → Settings → Integrations → API
|
|
2. Create OAuth app or generate API token
|
|
3. Configure required scopes:
|
|
- `employees:read` — Employee data access
|
|
- `payroll:read` — Payroll data (optional)
|
|
- `devices:read` — Device management (optional)
|
|
- `apps:read` — App provisioning (optional)
|
|
|
|
**API Documentation:** https://developer.rippling.com/docs/rippling-api/
|
|
|
|
The MCP server handles OAuth token refresh automatically.
|
|
|
|
## 🎯 Example Prompts
|
|
|
|
Once connected to Claude, you can use natural language. HR/IT-specific examples:
|
|
|
|
- *"Show me all active employees in engineering with their device assignments"*
|
|
- *"Get pending leave requests for January and check team coverage"*
|
|
- *"List all departments and their headcount"*
|
|
- *"Pull payroll data for Q4 2025 filtered by department"*
|
|
- *"Show me all MacBooks assigned to the product team"*
|
|
- *"Get company info and list all work locations"*
|
|
- *"Find employees at IC3 level or higher in San Francisco"*
|
|
- *"List all apps integrated with Rippling and who has access"*
|
|
|
|
## 🛠️ Development
|
|
|
|
### Prerequisites
|
|
- Node.js 18+
|
|
- npm or yarn
|
|
- Rippling account with API access
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
git clone https://github.com/BusyBee3333/Rippling-MCP-2026-Complete.git
|
|
cd rippling-mcp-2026-complete
|
|
npm install
|
|
cp .env.example .env
|
|
# Edit .env with your Rippling 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 key/OAuth token is correct
|
|
- Check that your OAuth scopes include required permissions
|
|
- Ensure your API key hasn't expired (OAuth tokens expire)
|
|
|
|
### "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)
|
|
|
|
### "Insufficient permissions"
|
|
- Review your OAuth scopes in Rippling settings
|
|
- Ensure your API token has read access to required resources
|
|
|
|
## 📖 Resources
|
|
|
|
- [Rippling Platform API Documentation](https://developer.rippling.com/docs/rippling-api/)
|
|
- [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 [MCPEngage](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/mcpengage).
|