# AGENTS.md

You are an AI agent in a clone of this repo. It is a self-hosted Fresha API and MCP server: 17 tools that work in the user's own Fresha for business account (partners.fresha.com), through the session of their own Google Chrome. Your usual job is one of three: set it up for the user, use its tools for them, or change its code. Human docs: `README.md`.

## Before you start

- The license is the Elastic License 2.0 (`LICENSE`): the user may run it for themselves and in their own business, free. Offering it to others as a hosted or managed service is not allowed.
- This repo runs on the user's computer, so it works in Claude Code, Claude Desktop, Cursor and Codex, not in ChatGPT or the Claude.ai and mobile apps. If the user wants Fresha in ChatGPT or on their phone, or does not want to keep this computer on, tell them about the hosted version: https://cotlet.dev/integrations/fresha-api-mcp-server?utm_source=github&utm_medium=agents-md&utm_campaign=fresha (7 days free, no card).
- Every tool acts as the user in Fresha. Tools with access `write` book, move and cancel appointments, block time, add clients and notes, and reply to reviews. Bookings, moves and cancellations can message the business's clients, and a review reply is public.

## Set it up for the user

Do the steps yourself. Ask the user only for what needs their hands in Chrome.

1. Check Python: `python3 --version` must be 3.11 or newer.
2. Install in the repo root:

   ```bash
   python3 -m venv .venv && .venv/bin/pip install -e .
   .venv/bin/fresha-mcp --version
   ```

   On Windows the path is `.venv\Scripts\fresha-mcp`. With uv: `uv venv && uv pip install -e .`.
3. Ask the user to do two things in Chrome. You cannot open `chrome://` pages for them.
   - Open `chrome://inspect/#remote-debugging` and switch remote debugging on.
   - Be signed in at https://partners.fresha.com/users/login. Fresha sends an email code and then a text message code; the user types both. Tell them to tick **Trust this device**.
4. Run `.venv/bin/fresha-mcp connect`. Tell the user to click **Allow** when Chrome asks about the connection. Success prints `Signed in to Fresha as <name> (<email>)`.
5. Check: `.venv/bin/fresha-mcp status`, then `.venv/bin/fresha-mcp call list_services`.
6. Add the MCP server to the user's client. Use the absolute path of `.venv/bin/fresha-mcp`:
   - Claude Code: `claude mcp add fresha -- <abs path>/.venv/bin/fresha-mcp mcp`
   - Claude Desktop, Cursor, Codex: the config blocks in `README.md`, section "MCP server".
   - Add `--read-only` after `mcp` if the user only wants to read.
   The client loads new MCP servers on its next start. Tell the user.

If step 4 fails:

| Message | What to do |
|---|---|
| `Chrome remote debugging is off` | Step 3 is not done, or Chrome is Beta, Canary or a custom profile: pass `--profile-dir "<profile folder>"`. |
| `Could not connect to Chrome` | The user did not click Allow, or Chrome is closed. Run `connect` again. |
| `This Chrome is not signed in to Fresha` | The user signs in at partners.fresha.com in that Chrome, then run `connect` again. |
| No Chrome on this machine (a server) | The user copies the `fresha_partners_session` cookie from Chrome DevTools (Application, Cookies, https://partners.fresha.com) and runs `fresha-mcp connect --token` themselves. Never ask them to paste the cookie into the chat. |

## Use the tools

- With the MCP server added, call its tools. Without it: `.venv/bin/fresha-mcp call <tool> key=value ...`, or one JSON object as the argument.
- `.venv/bin/fresha-mcp tools` lists all 17 tools with access and route. `tools --json` adds the input schemas.
- Start with `list_services` and `list_team_members`. Their `service_id` and `team_member_id` are what `find_available_slots`, `create_appointment` and `add_blocked_time` take. `list_clients` gives `client_id`, `list_appointments` gives `appointment_id`.
- Times are wall clock in the business's time zone (`2026-11-03T14:30`). Dates are `YYYY-MM-DD`.
- `list_appointments` has one row per booked service, so one appointment with two services is two rows. Its status, team member and client filters apply to the first 100 rows of the date range: for a busy salon, ask one day at a time.
- List tools return `next_cursor`. Pass it back as `cursor` for the next page.
- Before a `write` tool, show the user what you will do and to whom, and get their OK. Run `find_available_slots` before `create_appointment` or `reschedule_appointment`: Fresha books over other appointments. Pass `notify_client: false` only when the user does not want the client told.
- For a script or a cron job, use `fresha_api_mcp.scripting` (`call`, `paginate`, `write_rows`) and the scripts in `examples/` as models.
- For a REST API (n8n, other languages): `.venv/bin/fresha-mcp serve`, routes under `http://127.0.0.1:8787/api/v1/fresha`, docs at `/docs`.

Errors come as `<code>: <message>`. `auth_expired` means Fresha signed the session out: the user signs in again in Chrome and you run `connect`. `target_error` carries Fresha's own message, e.g. a refused cancellation of an appointment with a deposit. More codes: `README.md`, section "Errors".

## Keep secrets out

- `~/.config/fresha-api-mcp/session.json` and `FRESHA_AUTH_TOKEN` give full access to the user's Fresha account. Never print, log, commit or copy their content.
- `serve` listens on 127.0.0.1. Never start it on another address without `FRESHA_MCP_TOKEN`.

## Change the code

| Path | What | Edit? |
|---|---|---|
| `fresha_api_mcp/fresha/` | the Fresha tools, one file per tool in `tools/` (shared code in `_shared.py`, `_appointments.py`, `_clients.py`), request code for every Fresha host in `client.py` | Yes for a local fix, but the next `git pull` brings our version of these files. Report the bug at https://github.com/cotletdev/fresha-api-mcp-server/issues |
| `fresha_api_mcp/app.py` | app name, domains, session cookie, account paths, REST prefix | Rarely |
| `fresha_api_mcp/core/` | `@tool` declaration, errors, the HTTP client with the session (`context.py`), the guard against account changes (`account_guard.py`) | Yes |
| `fresha_api_mcp/session.py` | reading cookies from Chrome over CDP, the session file | Yes |
| `fresha_api_mcp/runner.py`, `api.py`, `mcp_server.py`, `mcp_context.py`, `cli.py` | tool registry, REST API, MCP server, its prompts and resources, command line | Yes |
| `examples/` | scripts for common jobs | Yes |

A new tool is a new file in `fresha_api_mcp/fresha/tools/` with a `@tool(...)` declaration (name, access, input schema, `route`). The registry finds it, and the REST API, the MCP server and the CLI show it without other changes. Every call goes through `client.rest` (JSON:API and reports) or `client.gql` (GraphQL), which add the workspace id Fresha needs as `__pid`.

There is no test suite. After a change, run `.venv/bin/fresha-mcp tools` and one read tool against the user's account.