usefulapiDeputy MCP server
See rosters, timesheets, leave and staff in Deputy, and create shifts, leave and memos. Hosted by usefulapi: connect it to Claude, ChatGPT, Cursor or any MCP client.
What can I ask?
Turn on the Deputy connector, then ask in plain words. The AI picks the tools.
- Who is rostered to work this Saturday, and in which area?
- Which timesheets are still waiting for approval this week?
- Which leave requests are waiting for a decision?
- Add a draft shift for Jane Smith next Tuesday from 9am to 5pm in the Kitchen.
What you can do with Deputy in Claude and ChatGPT
For managers who roster staff and approve timesheets and leave in Deputy.
See who is rostered and in which area
The AI searches shifts by time window, employee, area and published or open state. You see who works when, and which shifts are still open.
Find timesheets that wait for approval
The AI searches timesheets by time window, employee, area and approval state, and reads one with its breaks. You see hours and cost per timesheet.
Check leave requests, or record leave and unavailability
The AI lists leave requests by status, employee and dates. It can add a leave request for an employee or record a time they cannot work.
Changes dataCheck availability, then create and publish shifts
The AI checks an employee's unavailability, adds a shift as a draft or open shift, and publishes drafts with the notification you choose.
Changes dataCorrect and approve a timesheet
The AI reads a timesheet, corrects its start, end, area or meal break, and approves it as a supervisor. Approved timesheets go toward payroll export.
Changes dataPost a memo to a location's news feed
The AI posts a memo, optionally asking staff to confirm they read it, or aimed at chosen locations or users. Staff see it at once.
Changes dataHow do I connect Deputy?
Before you connect
The login page asks for your Deputy install host and Permanent access token.
Create one in Deputy → Integrations → API (developer portal): in your install open /exec/devapp/oauth_clients, choose New OAuth Client, then Get an Access Token. The token acts with its owner's Deputy permissions — supervisor tools (timesheet approval, publishing shifts) need a manager-level user. Your credentials are used only to call the API on your behalf and to derive a private account id; they are never shown to anyone.
Claude claude.ai · Desktop
- Open Customize → Connectors, then click + Add → Add custom connector.
- Enter the name Deputy and this URL, then click Add:https://
deputy. usefulapi. io/ mcp - Claude opens the login page: enter your Deputy install host and Permanent access token.
- In a chat, click + → Connectors and turn on Deputy.
Team and Enterprise: an Owner adds the connector for the organization first.
ChatGPT chatgpt.com
- Open Plugins, click +, then Add custom MCP server.
- Enter the name Deputy and this URL, choose OAuth as the authentication, confirm the warning and create it:https://
deputy. usefulapi. io/ mcp - ChatGPT opens the login page: enter your Deputy install host and Permanent access token.
- In Plugins, install Deputy, then choose it in a chat.
No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Claude Code
Run this command, then run /mcp in Claude Code to log in:
Cursor
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"deputy": {
"url": "https://deputy.usefulapi.io/mcp"
}
}
} VS Code
Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"deputy": {
"type": "http",
"url": "https://deputy.usefulapi.io/mcp"
}
}
} Codex
Run these commands. The second one opens the login page:
Other clients
Windsurf, Cline, Zed and other MCP clients: add this URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Deputy install host and Permanent access token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Guides
- Check Deputy timesheets against the roster before payroll
Claude or ChatGPT can list Deputy timesheets for a pay period, compare them with the scheduled shifts and leave, and show what is still unapproved.
21 October 2026
Pricing
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper user | $9/mo · $90/yr | 10,000 tool calls / month |
| Pro+per user | $39/mo · $390/yr | 100,000 tool calls / month |
Each paid plan covers this Deputy server only. Ask your AI to run deputy_upgrade and choose Pro or Pro+, billed monthly or yearly (it returns a Stripe Checkout link). If you already have Pro, ask to change it to Pro+. The change requires your confirmation, keeps your billing interval and charges the price difference for the rest of the period immediately. Cancel any time with deputy_cancel_subscription: your paid plan continues to the end of the paid period, with no refund for the current period, and asking to resume the same plan with deputy_upgrade before then undoes the cancel. Or write to support@usefulapi.io.
Tools 25
Show all 25 tools (the AI picks them for you)
Read only · 13
- Who am I
deputy_whoamiReturn the Deputy user the token belongs to — name, employee id, company and permissions. A cheap way to confirm DEPUTY_INSTALL and the token are right. - List locations
deputy_list_locationsList the install's locations (workplaces). Deputy calls a location a Company; its Id is what other tools take as location_id. - List areas
deputy_list_areasList areas (Deputy OperationalUnits — the rosterable sections of a location, e.g. Kitchen, Front of house). Shifts and timesheets belong to an area. Optionally only one location's areas. Deputy: GET /api/v1/resource/OperationalUnit, or POST .../OperationalUnit/QUERY when filtered. - List employees
deputy_list_employeesSearch employees by name, location or active status. Returns Id, DisplayName, Company (main location), Active, StartDate, Role and more. - Get one employee
deputy_get_employeeFetch one employee's details as a supervisor sees them — contact, locations, role and employment. - List shifts
deputy_list_shiftsSearch the roster (scheduled shifts) by time window, employee, area, and published/open state. Each record has StartTime/EndTime (unix), StartTimeLocalized, Employee (0 or null when open), OperationalUnit (area), Published, Open, Cost and _DPMetaData with names. - Get one shift
deputy_get_shiftFetch one shift (Roster record) by id. - List timesheets
deputy_list_timesheetsSearch timesheets (actual worked time) by time window, employee, area and approval state. Each record has StartTime/EndTime (unix; EndTime null while in progress), TotalTime (hours), Cost, TimeApproved, PayRuleApproved, IsInProgress, IsLeave, Roster (linked shift) and Exported. - Get one timesheet
deputy_get_timesheetFetch one timesheet's full details, including breaks and approval state. - List leave requests
deputy_list_leaveSearch leave requests by employee, location, status and time window. Status: 0 awaiting approval, 1 approved, 2 declined, 3 cancelled, 4 date approved without pay, 5 pay approved without date. Start/End are unix; LeaveRule is the leave type id. - Get an employee's unavailability
deputy_get_employee_unavailabilityList the times one employee has marked themselves (or been marked) unavailable to work — check before rostering them. - Query any Deputy resource
deputy_query_resourceRun a Resource API search on any business object (leave types, pay rules, public holidays, memos, events, shift templates, pay lines, availability, sales data, …). `search` is Deputy's clause map, e.g. {"s1":{"field":"Employee","data":12,"type":"eq"}}; operators: eq ne gt lt ge le is 'is not' in 'not in' starts contains. Use deputy_describe_resource to see an object's fields and joins. Read-only. - Describe a Deputy resource
deputy_describe_resourceReturn a Resource API object's field list, field types and joinable associations — what deputy_query_resource can filter, sort and join on.
Changes data · 8
- Create a shift
deputy_create_shiftAdd a shift to the roster, assigned to an employee or left open. Created as a DRAFT unless publish is true (publishing can notify the employee). Deputy returns an empty 200 on success — use deputy_list_shifts to find the new shift's id. - Update a shift
deputy_update_shiftChange an existing shift's times, area, employee, break or comment. Send the full intended shift (same fields as create) — Deputy's update is the add call with the shift id. Deputy: POST /api/v1/supervise/roster with intRosterId. - Publish shifts
deputy_publish_shiftsPublish draft shifts so employees see them, choosing how they are notified: 1 SMS and email, 2 SMS, 3 email, 4 no notification, 5 confirmation required. Only the listed shift ids are published. - Create a leave request
deputy_create_leave_requestAdd a leave request for an employee. By default it waits for manager approval (status 0); pass status 1 only when your system is the source of truth and the leave is already approved. Deputy tracks leave in hours, so give exact start and end times. Find leave type ids with deputy_query_resource on LeaveRules. - Add unavailability for an employee
deputy_add_unavailabilityRecord a time an employee cannot work (one-off, or recurring with an RFC 5545-style rule such as FREQ WEEKLY, INTERVAL 1, BYDAY MO). Auto-scheduling then skips them. - Post a memo
deputy_create_memoPost a memo to a location's news feed, optionally requiring staff to confirm they read it, or targeted to specific locations or users. Visible to staff immediately. - Update a timesheet
deputy_update_timesheetCorrect an existing timesheet's start/end time, area, meal break or supervisor comment. Times cannot be in the future. - Approve a timesheet
deputy_approve_timesheetApprove one timesheet's times as a supervisor. Approved timesheets flow toward payroll export, so check it first with deputy_get_timesheet.
Your usefulapi plan · 4
- Usage status (free-tier meter)
deputy_usage_statusReport the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter. - Request a missing feature
deputy_request_featureTell usefulapi that the user needs something the Deputy tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. - Upgrade to Pro or Pro+
deputy_upgradeGet a paid plan for Deputy (the free tier caps monthly usage). Pro: 10,000 tool calls a month, for normal use — plan "monthly" ($9/month) or "yearly" ($90/year, 2 months free). Pro+: 100,000 tool calls a month, for automations and heavy use — plan "plus" ($39/month) or "plus_yearly" ($390/year). Without a plan it returns both Pro and Pro+, each with a payment link, for the user to choose; with a plan, one link. An existing Pro subscription changes to Pro+ in place: call without confirm first, as the reply states the exact charge for this account (the price difference for the rest of the period, or in a free Pro trial the full Pro+ price, as the trial ends); then call with confirm: true. Cancel any time: the plan then runs to the end of the paid period, so it also suits a one-time job. A link opens Stripe Checkout in the browser; after payment the account upgrades automatically. Does not count against the meter. - Cancel the Pro subscription
deputy_cancel_subscriptionCancel the caller's Deputy Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run deputy_upgrade later to undo the cancel before the period ends. Does not count against the meter.
FAQ
What can I do with Deputy in Claude or ChatGPT?
See who is rostered and in which area. Find timesheets that wait for approval. Check leave requests, or record leave and unavailability. Check availability, then create and publish shifts. Correct and approve a timesheet. Post a memo to a location's news feed. See what you can do for the details.
Is this an official Deputy product?
No. usefulapi is an independent service. It is not affiliated with or endorsed by Deputy. The server calls the Deputy API with your own Deputy access, so it sees only the data that your account can see.
Can I connect Deputy to Claude or ChatGPT?
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
What do I need to connect?
The login page asks for your Deputy install host and Permanent access token. See Before you connect for where to find them.
Do I put my Deputy key or an Authorization header in the client config?
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Deputy install host and Permanent access token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
How do you keep my Deputy credentials?
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Deputy API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Deputy.
Can the AI change my Deputy data?
Yes, if you approve it. 8 of the 21 Deputy tools can create or change data. The other 13 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
What does it cost?
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with 10,000 tool calls / month. Pro+ costs $39/mo or $390/yr, with 100,000 tool calls / month. Each subscription covers this Deputy server only. Cancel any time: your paid plan then runs to the end of the paid period. Run deputy_usage_status to see how many calls you used.
How do I subscribe or cancel?
Ask the AI to run deputy_upgrade and choose Pro or Pro+, billed monthly or yearly: it returns a Stripe Checkout link. If you already have Pro, ask to change it to Pro+. After you confirm, your existing subscription changes in place, keeps its billing interval and charges the price difference for the rest of the period immediately. To cancel, run deputy_cancel_subscription. Your paid plan continues to the end of the paid period.
What if a Deputy tool that I need is missing?
Tell the AI what you wanted to do. It can send the request with deputy_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Which AI clients can I use?
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.
Need a tool this server does not have, or a connection to another system? We build custom integrations and MCP servers.