Rebrand MCPEngine → MCPEngage + add HR/IT-specific content and OAuth details

This commit is contained in:
Jake Shore 2026-02-02 06:58:44 -05:00
parent 56c37d8521
commit 86734e67e5
3 changed files with 79 additions and 30 deletions

View File

@ -1,2 +1,12 @@
# Rippling API Credentials # Rippling API Configuration
RIPPLING_API_KEY=your-api-key-here # Get your API credentials from: Rippling → Settings → Integrations → API
# Your Rippling API key or OAuth token
# Supports OAuth 2.0 or API token authentication
RIPPLING_API_KEY=your_api_key_or_oauth_token_here
# Required OAuth scopes (if using OAuth):
# - employees:read
# - payroll:read (optional)
# - devices:read (optional)
# - apps:read (optional)

View File

@ -10,28 +10,46 @@
**This MCP server gives AI direct access to your entire Rippling workspace.** Instead of clicking through interfaces, you just *tell* it what you need. **This MCP server gives AI direct access to your entire Rippling workspace.** Instead of clicking through interfaces, you just *tell* it what you need.
### 🎯 Rippling-Native Power Moves ### 🎯 HR & IT Power Moves with Rippling
The AI can directly control your Rippling account with natural language: The AI can directly control your Rippling account with natural language:
- **Smart automation** — Complex workflows in plain English 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"
- **Data intelligence** — Query, analyze, and export your Rippling data
- **Rapid operations** — Bulk actions that would take hours manually 2. **Payroll Intelligence** — "Pull payroll summary for Q1 2026, group by department, identify outliers, and flag any employees with missing tax documents"
- **Cross-platform integration** — Combine Rippling with other tools seamlessly
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 ### 🔗 The Real Power: Combining Tools
AI can chain multiple Rippling operations together: AI can chain multiple Rippling operations together:
- Query data → Filter results → Generate reports - Query employees → Check device assignments → Provision missing apps
- Search records → Update fields → Notify team - Pull leave requests → Cross-reference team coverage → Alert managers
- Analyze metrics → Create tasks → Schedule follow-ups - Get payroll data → Match with performance levels → Generate compensation analysis
## 📦 What's Inside ## 📦 What's Inside
**107 API tools** covering the entire Rippling platform (HR & Payroll). **12 API tools** covering Rippling HR and IT operations:
All with proper error handling, automatic authentication, and TypeScript types. - `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 ## 🚀 Quick Start
@ -45,7 +63,10 @@ All with proper error handling, automatic authentication, and TypeScript types.
npm run build npm run build
``` ```
2. **Get your Rippling API credentials** (see Authentication section below) 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:** 3. **Configure Claude Desktop:**
@ -58,7 +79,7 @@ All with proper error handling, automatic authentication, and TypeScript types.
"mcpServers": { "mcpServers": {
"rippling": { "rippling": {
"command": "node", "command": "node",
"args": ["/ABSOLUTE/PATH/TO/rippling-mcp/dist/index.js"], "args": ["/ABSOLUTE/PATH/TO/rippling-mcp-2026-complete/dist/index.js"],
"env": { "env": {
"RIPPLING_API_KEY": "your-api-key-here" "RIPPLING_API_KEY": "your-api-key-here"
} }
@ -74,7 +95,7 @@ All with proper error handling, automatic authentication, and TypeScript types.
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/rippling-mcp) [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/rippling-mcp)
1. Click the button above 1. Click the button above
2. Set your Rippling API credentials in Railway dashboard 2. Set `RIPPLING_API_KEY` in Railway dashboard
3. Use the Railway URL as your MCP server endpoint 3. Use the Railway URL as your MCP server endpoint
### Option 3: Docker ### Option 3: Docker
@ -88,19 +109,33 @@ docker run -p 3000:3000 \
## 🔐 Authentication ## 🔐 Authentication
See the official [Rippling API documentation](https://docs.rippling.com) for authentication details. Rippling uses **OAuth 2.0** or **API Token authentication**.
The MCP server handles token refresh automatically. **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 ## 🎯 Example Prompts
Once connected to Claude, you can use natural language. Examples: Once connected to Claude, you can use natural language. HR/IT-specific examples:
- *"Show me recent activity in Rippling"* - *"Show me all active employees in engineering with their device assignments"*
- *"Create a new record with these details..."* - *"Get pending leave requests for January and check team coverage"*
- *"Export all data from last month"* - *"List all departments and their headcount"*
- *"Update the status of X to Y"* - *"Pull payroll data for Q4 2025 filtered by department"*
- *"Generate a report of..."* - *"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 ## 🛠️ Development
@ -132,18 +167,22 @@ npm run test:coverage # Coverage report
## 🐛 Troubleshooting ## 🐛 Troubleshooting
### "Authentication failed" ### "Authentication failed"
- Verify your API credentials are correct - Verify your API key/OAuth token is correct
- Check that your API key hasn't been revoked - Check that your OAuth scopes include required permissions
- Ensure you have the necessary permissions - Ensure your API key hasn't expired (OAuth tokens expire)
### "Tools not appearing in Claude" ### "Tools not appearing in Claude"
- Restart Claude Desktop after updating config - Restart Claude Desktop after updating config
- Check that the path in `claude_desktop_config.json` is absolute - Check that the path in `claude_desktop_config.json` is absolute
- Verify the build completed successfully (`dist/index.js` exists) - 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 ## 📖 Resources
- [Rippling API Documentation](https://docs.rippling.com) - [Rippling Platform API Documentation](https://developer.rippling.com/docs/rippling-api/)
- [MCP Protocol Specification](https://modelcontextprotocol.io/) - [MCP Protocol Specification](https://modelcontextprotocol.io/)
- [Claude Desktop Documentation](https://claude.ai/desktop) - [Claude Desktop Documentation](https://claude.ai/desktop)
@ -163,10 +202,10 @@ MIT License - see [LICENSE](LICENSE) for details
## 🙏 Credits ## 🙏 Credits
Built by [MCPEngine](https://mcpengage.com) — AI infrastructure for business software. 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. 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). **Questions?** Open an issue or join our [Discord community](https://discord.gg/mcpengage).

View File

@ -4,7 +4,7 @@
"description": "MCP server for Rippling API - 2026 Complete Version", "description": "MCP server for Rippling API - 2026 Complete Version",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"author": "MCPEngine <hello@mcpengage.com>", "author": "MCPEngage <hello@mcpengage.com>",
"license": "MIT", "license": "MIT",
"repository": { "repository": {
"type": "git", "type": "git",