Model Context Protocol
Connect Claude, ChatGPT, Cursor or any MCP client to Pixelbase and let it read your business — customers, orders, catalogue, staff and the ledger — with an API token you control.
The Model Context Protocol is how an AI assistant connects to a system it wasn't built with. Point Claude, ChatGPT, Cursor or any other MCP client at the endpoint below, give it a Pixelbase API token, and it can read your company's data as part of a conversation — no copy-paste, no export.
https://www.pxb.app/api/mcp
Everything here is read-only. The tools list and fetch; none of them create, change, or delete anything. An assistant can tell you what last week's orders came to; it cannot issue a refund.
Access is exactly the access the token was granted. The server builds its tool list per connection from the token's scopes, so an assistant holding a customers-only token is never even shown the ledger. To narrow what an assistant can see, create an API client with fewer scopes — that is the whole control surface, and it is the same one the API and the CLI use.
Two things worth knowing before you connect:
- Calls act as the employee who created the API client, and that person's own per-location access applies on top of the token's scopes.
- Every tool call is a public API request, so it counts toward your API usage and rate limit like any other.
Quick start
Create an API client on the /console/api page, exchange its credentials for a token, and hand it to your assistant.
claude mcp add --transport http pixelbase https://www.pxb.app/api/mcp \
--header "Authorization: Bearer $PXB_TOKEN"Other clients, and how to get the token, are on Connect an assistant.
What an assistant can read
One tool per collection, and each one appears only when the token carries its scope. This table is generated from the same registry the server builds its tools from, so it can't fall out of step.
| Tool | Returns | Scope | Location |
|---|---|---|---|
| list_appointments | Booked appointments at one location — who is coming, for which service, and when. | appointments:read | Required |
| list_appointment_availability | The weekly windows a location accepts appointments in. Read this before reasoning about whether a time is bookable. | appointments:read | Required |
| list_appointment_services | The services a location can be booked for, with their duration and price. | appointments:read | Required |
| list_customers | A location's customers — the people it sells to or serves. This is the CRM record: name, contact details, and status. | customers:read | Required |
| list_customer_custom_fields | The extra fields this location defines on its customers. Read it to interpret custom values on a customer record. | customer:custom-fields:read | Required |
| list_departments | How the company divides its staff — the departments employees belong to. | company-structure:read | — |
| list_domains | Domain names the company has registered or connected, and their status. | domains:read | — |
| list_email_addresses | Company mailboxes — the addresses staff send and receive from. | email:addresses:read | — |
| list_employees | The people who work for the company, with their status and role. Not customers — those are `list_customers`. | employees:read | — |
| list_employee_invitations | Outstanding invitations to join the company as an employee. | employee:invitations:read | — |
| list_employee_onboardings | Where each new hire has got to in onboarding. | employee:onboardings:read | — |
| list_gallery_photos | Photos published on a location's public page. | gallery:read | Required |
| list_job_titles | The job titles the company defines, which employees are assigned to. | company-structure:read | — |
| list_legal_entities | The registered companies behind the business — LLCs and corporations, with their formation state and EIN status. One company can own several. | settings:read | — |
| list_location_hours | One location's opening times for the week. | location:hours:read | Required |
| list_locations | The places the company operates from. Call this first: every location-scoped tool needs one of these ids. | locations:read | — |
| list_newsletter_subscriptions | People who subscribed to the company newsletter. | newsletter:subscriptions:read | — |
| list_notifications | Notifications raised for the company — what the platform has flagged recently. | notifications:read | — |
| list_orders | Sales orders placed at a location — what was bought, by whom, and what it came to. | orders:read | Required |
| list_products | What a location sells: its catalogue, with prices and stock. | products:read | Required |
| list_support_cases | Support cases the company has opened with Pixelbase, and where each one stands. | support:cases:read | — |
| list_transactions | Money in and out — the ledger. Each record carries an amount in cents, a type, a status, and its IRS category. | transactions:read | — |
Plus whoami, which reports the company and the granted scopes, and get_api_resource, which reads a single record or any API path without a tool of its own.
Topics
For agents
The whole reference as one document, so an agent can read it in a single fetch.
curl https://www.pxb.app/docs/mcp/docs.md
curl https://www.pxb.app/docs/mcp/docs.json