Pool Brain MCP by usefulapi is an MCP server published by io.usefulapi, hosted at pool-brain.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 24 tools, including poolbrain_list_companies, poolbrain_list_users, poolbrain_get_billing_defaults, poolbrain_list_service_levels, poolbrain_search_customers.
Read customers, routes, jobs and invoices; create or update customers and add notes in Pool Brain.
4,107 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List the companies a Master API Key can reach, with companyId, name and subscription status. A company key gets an error here. Pool Brain Open API: GET /v2/company_list.
No parameters.
{
"name": "poolbrain_list_companies",
"title": "List companies",
"description": "List the companies a Master API Key can reach, with companyId, name and subscription status. A company key gets an error here. Pool Brain Open API: GET /v2/company_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List companies",
"readOnlyHint": true
}
}List staff users with userId, name, email, role, permissions and active flag. Pool Brain Open API: GET /v2/user_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| userId | integer | Filter by userId. |
| fromDate | string | Start date, YYYY-MM-DD. |
| isActive | integer | 1 for active users, 0 for inactive. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_users",
"title": "List users",
"description": "List staff users with userId, name, email, role, permissions and active flag. Pool Brain Open API: GET /v2/user_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"userId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by userId."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"isActive": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "1 for active users, 0 for inactive."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List users",
"readOnlyHint": true
}
}Read the company's billing defaults (terms, tax and invoice settings). Pool Brain Open API: GET /v2/setting_billing_defaults.
No parameters.
{
"name": "poolbrain_get_billing_defaults",
"title": "Get billing defaults",
"description": "Read the company's billing defaults (terms, tax and invoice settings). Pool Brain Open API: GET /v2/setting_billing_defaults.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get billing defaults",
"readOnlyHint": true
}
}Read service level details, including the pool types linked to each service level. Pool Brain Open API: GET /v2/service_level_list.
No parameters.
{
"name": "poolbrain_list_service_levels",
"title": "List service levels",
"description": "Read service level details, including the pool types linked to each service level. Pool Brain Open API: GET /v2/service_level_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List service levels",
"readOnlyHint": true
}
}Search customers: contact details, addresses and service history. Filter by any field below. Pool Brain Open API: GET /v2/customer_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | string | Customer id. |
| allAddresses | string | Any property address text. |
| billingAddress | string | Billing address text. |
| customerStatus | string | Customer status as the vendor names it. |
| primaryAddress | string | Primary address text. |
| routeStopEmail | string | Route Stop Email of a property (partial match). |
| contactPhoneNumber | string |
List customer notes, optionally for one customer. Pool Brain Open API: GET /v2/customer_notes_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| notesId | string | Note id. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_customer_notes",
"title": "List customer notes",
"description": "List customer notes, optionally for one customer. Pool Brain Open API: GET /v2/customer_notes_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"notesId": {
"type": "string",
"description": "Note id."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List customer notes",
"readOnlyHint": true
}
}List quotes with their line items, totals, tax, status and assigned sales rep. Pool Brain Open API: GET /v2/customer_quotes_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| quotesId | string | Quote id. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_quotes",
"title": "List quotes",
"description": "List quotes with their line items, totals, tax, status and assigned sales rep. Pool Brain Open API: GET /v2/customer_quotes_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"quotesId": {
"type": "string",
"description": "Quote id."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List quotes",
"readOnlyHint": true
}
}Read a customer's pool details, including water bodies and their associated data. Pool Brain Open API: GET /v2/customer_pool_details.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| waterBodyId | string | Water body id. |
{
"name": "poolbrain_get_pool_details",
"title": "Get water body details",
"description": "Read a customer's pool details, including water bodies and their associated data. Pool Brain Open API: GET /v2/customer_pool_details.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"waterBodyId": {
"type": "string",
"description": "Water body id."
}
}
},
"annotations": {
"title": "Get water body details",
"readOnlyHint": true
}
}List the products and services of the company. Pool Brain Open API: GET /v2/product_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_products",
"title": "List products and services",
"description": "List the products and services of the company. Pool Brain Open API: GET /v2/product_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List products and services",
"readOnlyHint": true
}
}List product and service categories, with child categories up to level 3. Pool Brain Open API: GET /v2/product_service_category_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
{
"name": "poolbrain_list_product_categories",
"title": "List product categories",
"description": "List product and service categories, with child categories up to level 3. Pool Brain Open API: GET /v2/product_service_category_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
}
}
},
"annotations": {
"title": "List product categories",
"readOnlyHint": true
}
}List invoices with balance due, customer, dates and payment link. Pool Brain Open API: GET /v2/invoice_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_invoices",
"title": "List invoices",
"description": "List invoices with balance due, customer, dates and payment link. Pool Brain Open API: GET /v2/invoice_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List invoices",
"readOnlyHint": true
}
}Read invoice details, including product details, for one invoice or a date window. Pool Brain Open API: GET /v2/invoice_list_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| invoiceId | string | Invoice id. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_get_invoice_details",
"title": "Get invoice details",
"description": "Read invoice details, including product details, for one invoice or a date window. Pool Brain Open API: GET /v2/invoice_list_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"invoiceId": {
"type": "string",
"description": "Invoice id."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Get invoice details",
"readOnlyHint": true
}
}List customer payments, with their method and amount. Pool Brain Open API: GET /v2/payment_List.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_payments",
"title": "List payments",
"description": "List customer payments, with their method and amount. Pool Brain Open API: GET /v2/payment_List.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List payments",
"readOnlyHint": true
}
}List one-time jobs with their dates and status. Pool Brain Open API: GET /v2/one_time_job_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_one_time_jobs",
"title": "List one-time jobs",
"description": "List one-time jobs with their dates and status. Pool Brain Open API: GET /v2/one_time_job_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List one-time jobs",
"readOnlyHint": true
}
}Read one-time job details: job title, instructions, notes, inventory used and schedule status. Pool Brain Open API: GET /v2/one_time_job_list_details.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| oneOfJobId | string | One-time job id. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_get_one_time_job",
"title": "Get one-time job details",
"description": "Read one-time job details: job title, instructions, notes, inventory used and schedule status. Pool Brain Open API: GET /v2/one_time_job_list_details.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"oneOfJobId": {
"type": "string",
"description": "One-time job id."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Get one-time job details",
"readOnlyHint": true
}
}List jobs on route stops within a date range. Pool Brain Open API: GET /v2/route_stops_job_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_route_stop_jobs",
"title": "List route stop jobs",
"description": "List jobs on route stops within a date range. Pool Brain Open API: GET /v2/route_stops_job_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List route stop jobs",
"readOnlyHint": true
}
}Read route stop job details, including chemical readings and chemical status. Pool Brain Open API: GET /v2/route_stops_job_list_details.
| Parameter | Type | Description |
|---|---|---|
| jobId | string | Route stop job id. |
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_get_route_stop_job",
"title": "Get route stop job details",
"description": "Read route stop job details, including chemical readings and chemical status. Pool Brain Open API: GET /v2/route_stops_job_list_details.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"jobId": {
"type": "string",
"description": "Route stop job id."
},
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Get route stop job details",
"readOnlyHint": true
}
}List alerts on jobs, with the alert type and whether it is dismissed. Pool Brain Open API: GET /v2/alerts_list.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| customerId | integer | Filter by customerId. |
| isDismissed | string | 'true' for dismissed alerts, 'false' for open alerts. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_list_alerts",
"title": "List alerts",
"description": "List alerts on jobs, with the alert type and whether it is dismissed. Pool Brain Open API: GET /v2/alerts_list.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Filter by customerId."
},
"isDismissed": {
"type": "string",
"description": "'true' for dismissed alerts, 'false' for open alerts."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "List alerts",
"readOnlyHint": true
}
}Read technician details in a date window, optionally for one technician. Pool Brain Open API: GET /v2/technician_detail.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| technicianId | string | Technician id (string, as the vendor sends it). |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_get_technician",
"title": "Get technician jobs",
"description": "Read technician details in a date window, optionally for one technician. Pool Brain Open API: GET /v2/technician_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"technicianId": {
"type": "string",
"description": "Technician id (string, as the vendor sends it)."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Get technician jobs",
"readOnlyHint": true
}
}Read technician routes, with stops and schedules, for one day or a date range. Pool Brain Open API: GET /v2/technician_route_detail.
| Parameter | Type | Description |
|---|---|---|
| date | string | One day, YYYY-MM-DD. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
{
"name": "poolbrain_get_technician_routes",
"title": "Get technician routes",
"description": "Read technician routes, with stops and schedules, for one day or a date range. Pool Brain Open API: GET /v2/technician_route_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "One day, YYYY-MM-DD."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
}
}
},
"annotations": {
"title": "Get technician routes",
"readOnlyHint": true
}
}Read technician pay and payment history in a date window. Pool Brain Open API: GET /v2/technician_pay.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Records per call (vendor default and maximum 1000). |
| offset | integer | Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on. |
| toDate | string | End date, YYYY-MM-DD. |
| fromDate | string | Start date, YYYY-MM-DD. |
| technicianId | string | Technician id (string, as the vendor sends it). |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_get_technician_pay",
"title": "Get technician pay",
"description": "Read technician pay and payment history in a date window. Pool Brain Open API: GET /v2/technician_pay.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"technicianId": {
"type": "string",
"description": "Technician id (string, as the vendor sends it)."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Get technician pay",
"readOnlyHint": true
}
}Create a customer with contact, address and water body details. Writes a new customer record. Pool Brain Open API: POST /v2/create_customer.
| Parameter | Type | Description |
|---|---|---|
| city | string | |
| string | ||
| state | string | |
| address | string | |
| hasDogs | string | |
| zipcode | string | |
| GateCode | integer | |
| lastName | string | |
| firstName | string | |
| poolTypeId | integer | |
| accessNotes | string | |
| displayName | string | |
| contactNumber | string |
Update a customer's and one property's contact and address details. Pass customerId and addressId with the fields to update. Pool Brain Open API: PUT /v2/update_customer_details.
| Parameter | Type | Description |
|---|---|---|
| city | string | |
| string | ||
| state | string | |
| address | string | |
| hasDogs | string | |
| zipcode | string | |
| GateCode | integer | |
| lastName | string | |
| addressId | integer | Property to update. |
| firstName | string | |
| customerId * | integer | Customer to update. |
| accessNotes | string | |
Add a note to a customer record. Writes a new note. Pool Brain Open API: POST /v2/create_customer_notes.
| Parameter | Type | Description |
|---|---|---|
| notes * | string | Note text. |
| customerId * | integer | Customer to note. |
{
"name": "poolbrain_create_customer_note",
"title": "Add customer note",
"description": "Add a note to a customer record. Writes a new note. Pool Brain Open API: POST /v2/create_customer_notes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customerId",
"notes"
],
"properties": {
"notes": {
"type": "string",
"minLength": 1,
"description": "Note text."
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Customer to note."
}
}
},
"annotations": {
"title": "Add customer note",
"destructiveHint": true
}
}Tools for Pool Brain, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which customers have open alerts on their pools right now?"; "List the route stop jobs for this week and who is assigned to each route."; "Show all unpaid invoices for the last 30 days.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Pool Brain data. Free plan: 50 tool calls per month. Run poolbrain_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run poolbrain_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run poolbrain_upgrade without a plan: it returns both plans, each with a payment link for the user to open. poolbrain_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| Contact phone number. |
| toLastModifiedDate | string | End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate. |
| contactEmailAddress | string | Contact email. |
| customerDisplayName | string | Display name (partial match). |
| fromLastModifiedDate | string | Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate. |
{
"name": "poolbrain_search_customers",
"title": "Search customers",
"description": "Search customers: contact details, addresses and service history. Filter by any field below. Pool Brain Open API: GET /v2/customer_detail.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Records per call (vendor default and maximum 1000)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Paging offset, as the vendor defines it. Check pagination.hasMore in the reply to know when to page on."
},
"toDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End date, YYYY-MM-DD."
},
"fromDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start date, YYYY-MM-DD."
},
"customerId": {
"type": "string",
"description": "Customer id."
},
"allAddresses": {
"type": "string",
"description": "Any property address text."
},
"billingAddress": {
"type": "string",
"description": "Billing address text."
},
"customerStatus": {
"type": "string",
"description": "Customer status as the vendor names it."
},
"primaryAddress": {
"type": "string",
"description": "Primary address text."
},
"routeStopEmail": {
"type": "string",
"description": "Route Stop Email of a property (partial match)."
},
"contactPhoneNumber": {
"type": "string",
"description": "Contact phone number."
},
"toLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the last-modified window, YYYY-MM-DD. Send with fromLastModifiedDate."
},
"contactEmailAddress": {
"type": "string",
"description": "Contact email."
},
"customerDisplayName": {
"type": "string",
"description": "Display name (partial match)."
},
"fromLastModifiedDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the last-modified window, YYYY-MM-DD. Send with toLastModifiedDate."
}
}
},
"annotations": {
"title": "Search customers",
"readOnlyHint": true
}
}| waterBodyName | string |
| waterBodyType | integer |
| serviceLevelId | integer |
| waterBodyGallons | integer |
{
"name": "poolbrain_create_customer",
"title": "Create customer",
"description": "Create a customer with contact, address and water body details. Writes a new customer record. Pool Brain Open API: POST /v2/create_customer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"address": {
"type": "string"
},
"hasDogs": {
"type": "string"
},
"zipcode": {
"type": "string"
},
"GateCode": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"poolTypeId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"accessNotes": {
"type": "string"
},
"displayName": {
"type": "string"
},
"contactNumber": {
"type": "string"
},
"waterBodyName": {
"type": "string"
},
"waterBodyType": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"serviceLevelId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"waterBodyGallons": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
},
"annotations": {
"title": "Create customer",
"destructiveHint": true
}
}| displayName |
| string |
| contactNumber | string |
{
"name": "poolbrain_update_customer",
"title": "Update customer details",
"description": "Update a customer's and one property's contact and address details. Pass customerId and addressId with the fields to update. Pool Brain Open API: PUT /v2/update_customer_details.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customerId"
],
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string"
},
"state": {
"type": "string"
},
"address": {
"type": "string"
},
"hasDogs": {
"type": "string"
},
"zipcode": {
"type": "string"
},
"GateCode": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"lastName": {
"type": "string"
},
"addressId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Property to update."
},
"firstName": {
"type": "string"
},
"customerId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Customer to update."
},
"accessNotes": {
"type": "string"
},
"displayName": {
"type": "string"
},
"contactNumber": {
"type": "string"
}
}
},
"annotations": {
"title": "Update customer details",
"destructiveHint": true
}
}