brilliant-directories-mcp 5.2.0 → 5.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/openapi/bd-api.json +2 -2
- package/package.json +1 -1
package/openapi/bd-api.json
CHANGED
|
@@ -1539,14 +1539,14 @@
|
|
|
1539
1539
|
}
|
|
1540
1540
|
}
|
|
1541
1541
|
},
|
|
1542
|
-
"description": "Create a new user record. Writes live data.\n\n**Required:** `email`, `password`, `subscription_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `email`, `password`, `subscription_id` are all required together — `subscription_id` must be an existing membership plan (discover via `listMembershipPlans`)\n- `profession_id` + `services` — top-level category and comma-separated sub-category IDs\n- `auto_geocode=1` requires the \"Pretty URLs with Google Maps\" site feature enabled\n- `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\n\n**See also:** `updateUser` (modify existing).\n\n**Writes live data:** confirm intent with the user for bulk operations. Changes are immediately visible on the live site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan (from `listMembershipPlans` / `createMembershipPlan`). Categories (`profession_id` / `profession_name` / `services`) are AUTO-CREATED on `createUser` if the names don't exist (see Category handling below) — they do NOT need to exist beforehand.\n
|
|
1542
|
+
"description": "Create a new user record. Writes live data.\n\n**Required:** `email`, `password`, `subscription_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `email`, `password`, `subscription_id` are all required together — `subscription_id` must be an existing membership plan (discover via `listMembershipPlans`)\n- `profession_id` + `services` — top-level category and comma-separated sub-category IDs\n- `auto_geocode=1` requires the \"Pretty URLs with Google Maps\" site feature enabled\n- `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\n\n**See also:** `updateUser` (modify existing).\n\n**Writes live data:** confirm intent with the user for bulk operations. Changes are immediately visible on the live site.\n\n**Returns:** `{ status: \"success\", message: {...createdRecord} }` — includes the server-assigned ID (e.g., `user_id`, `post_id`). Use this ID for follow-up operations.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan (from `listMembershipPlans` / `createMembershipPlan`). Categories (`profession_id` / `profession_name` / `services`) are AUTO-CREATED on `createUser` if the names don't exist (see Category handling below) — they do NOT need to exist beforehand.\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on create: ALWAYS ON.* `createUser` has `create_new_categories=true` hardcoded in `createActions()`. Unknown category/service/sub-sub names are auto-created automatically — no flag needed.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._"
|
|
1543
1543
|
}
|
|
1544
1544
|
},
|
|
1545
1545
|
"/api/v2/user/update": {
|
|
1546
1546
|
"put": {
|
|
1547
1547
|
"operationId": "updateUser",
|
|
1548
1548
|
"summary": "Update an existing member/user",
|
|
1549
|
-
"description": "Update any user field. Supports special actions: member_tag_action + member_tags, credit_action + credit_amount, images_action, services, auto_geocode.\n\n**Required:** `user_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `member_tag_action=1` + `member_tags` — apply tag changes (comma-separated tag IDs from `listTags`)\n- `credit_action` (`add`/`deduct`/`override`) + `credit_amount` — adjust member credit balance\n- `images_action` — remove stored images: `remove_all`, `remove_cover_image`, `remove_logo_image`, `remove_profile_image`\n- `services` format: `category=>service1,service2` (category ID, then comma-separated service IDs)\n- `auto_geocode=1` requires the \"Pretty URLs with Google - `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\nMaps\" site feature enabled\n\n**See also:** `createUser` (add new), `deleteUser` (remove permanently).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }` — the full updated record after changes applied.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan. For categories, existing IDs/names work by default; to auto-create unknown names during update, pass `create_new_categories=1` (see Category handling below).\n
|
|
1549
|
+
"description": "Update any user field. Supports special actions: member_tag_action + member_tags, credit_action + credit_amount, images_action, services, auto_geocode.\n\n**Required:** `user_id`.\n\n**Enums:** `active`: `1`=Not Active, `2`=Active, `3`=Canceled, `4`=On Hold, `5`=Past Due; `listing_type`: `Individual`=Individual Person, `Company`=Company / Organization; `verified`: `1`=Yes, `0`=No; `nationwide`: `1`=Yes, `0`=No.\n\n**Parameter interactions:**\n- `member_tag_action=1` + `member_tags` — apply tag changes (comma-separated tag IDs from `listTags`)\n- `credit_action` (`add`/`deduct`/`override`) + `credit_amount` — adjust member credit balance\n- `images_action` — remove stored images: `remove_all`, `remove_cover_image`, `remove_logo_image`, `remove_profile_image`\n- `services` format: `category=>service1,service2` (category ID, then comma-separated service IDs)\n- `auto_geocode=1` requires the \"Pretty URLs with Google - `auto_image_import=1` — **fetches external image URLs and saves them to BD site storage.** Applies to the `profile_photo`, `logo`, and `cover_photo` fields when populated with external URLs (e.g. URLs from a web-scrape). Without this flag, BD stores the external URL as-is; images may break if the source host goes down. **Recommended default when supplying image URLs from any external source** — only omit if the user explicitly asks to keep the external reference without local copy. Processing delay: several minutes after create.\nMaps\" site feature enabled\n\n**See also:** `createUser` (add new), `deleteUser` (remove permanently).\n\n**Returns:** `{ status: \"success\", message: {...updatedRecord} }` — the full updated record after changes applied.\n\n**Profile URL:** every user record has a `filename` field. To get the full public profile URL, concatenate: `<site-domain>/<user.filename>`. The `filename` is the complete relative path (e.g., `united-states/monterey-park/doctor/harrison-hasanuddin-d-o`) — DO NOT prepend `/business/`, `/profile/`, `/member/`, or any other segment. BD's router resolves `filename` verbatim.\n\n**Operational rules (from BD support article 12000091105):**\n- `send_email_notifications=1` — set this to trigger the welcome email (based on the membership plan's email settings). Without this flag, no email is sent — API creates are silent by default (since they typically aren't self-signups from the public site).\n- **Email uniqueness:** `email` must be unique UNLESS the site setting `allow_duplicate_member_emails` is enabled. The combination of `email` + `password` must ALWAYS be unique across members regardless of site settings.\n- **`token`** (if supplied): must be exactly 32 alphanumeric characters AND unique across all members.\n- **URL fields** (`website`, `booking_link`, `blog`, `facebook`, `twitter`, `linkedin`, `instagram`, etc.) are validated on write; invalid formats are silently skipped (not rejected). Must start with `http://` or `https://`.\n- **Prerequisites:** `subscription_id` MUST reference an existing membership plan. For categories, existing IDs/names work by default; to auto-create unknown names during update, pass `create_new_categories=1` (see Category handling below).\n\n\n\n**Category handling — IDs OR names, with sub-sub support (source: user.php:1840-1940, verified live 2026-04-18):**\n\n*Top-level category (profession) — pick ONE:*\n- `profession_id` (numeric) — must reference an existing row in `list_professions`\n- `profession_name` (string) — alternative by name\n\n*`services` parameter (sub-categories) supports 4 formats:*\n| Format | Example | Effect |\n|---|---|---|\n| Single by ID or name | `services=\"1823\"` or `services=\"PVC repair\"` | One sub-category |\n| Multiple | `services=\"PVC repair,Water heater\"` or `services=\"1823,1824\"` | Multiple subs |\n| Sub + sub-sub via `=>` | `services=\"Honda=>2022\"` | Creates sub \"Honda\" and sub-sub \"2022\" under Honda |\n| Mixed subs + sub-subs | `services=\"Honda=>2022,Honda=>2023,Toyota\"` | Combine in one call |\n\n*Critical rules:*\n- **`profession_id` (or `profession_name`) is REQUIRED when passing `services`** — without it, service relationships fail silently (`user.php:1876`)\n- **Do NOT mix IDs and names** within a single `services` call — pick one format\n- **Right side of `=>` is NAME-ONLY** — no ID lookup; sub-sub must be passed by name\n- **Whitespace around commas is trimmed** — `\"a, b, c\"` works the same as `\"a,b,c\"`\n\n*Auto-create on update: OFF by default.* Unknown category/service names are silently skipped unless you explicitly pass `create_new_categories=1`.\n\n*Destructive side effect — `user.php:1832`:* **Changing `profession_id` on `updateUser` wipes all existing service (sub-category) relations for that member.** To move a member to a new top-level category without losing their sub-categories, re-send the complete `services` list in the same `updateUser` call.\n\n_Auth: `X-Api-Key` header. Rate limit: 100 req/60s (on 429, back off 60s). Errors: `{ \"status\": \"error\", \"message\": \"...\" }` with standard HTTP codes._",
|
|
1550
1550
|
"tags": [
|
|
1551
1551
|
"Users"
|
|
1552
1552
|
],
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "brilliant-directories-mcp",
|
|
3
3
|
"mcpName": "io.github.brilliantdirectories/brilliant-directories-mcp",
|
|
4
|
-
"version": "5.2.
|
|
4
|
+
"version": "5.2.1",
|
|
5
5
|
"description": "Official MCP server for Brilliant Directories — manage members, posts, leads, reviews, and more.",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|