brilliant-directories-mcp 5.1.0 → 5.2.0
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 +26 -2
- package/package.json +1 -1
package/openapi/bd-api.json
CHANGED
|
@@ -1509,6 +1509,18 @@
|
|
|
1509
1509
|
"0"
|
|
1510
1510
|
],
|
|
1511
1511
|
"description": "If YES, system will import user images and save them to your website. Processing may take several minutes after import.\\n\\nValid values:\\n 1 = Yes\\n 0 = No"
|
|
1512
|
+
},
|
|
1513
|
+
"profession_name": {
|
|
1514
|
+
"type": "string",
|
|
1515
|
+
"description": "Alternative to `profession_id` — pass the top-level category NAME as a string. BD looks it up in `list_professions`. On `createUser`, unknown names are auto-created. On `updateUser`, unknown names are silently skipped unless `create_new_categories=1` is also passed."
|
|
1516
|
+
},
|
|
1517
|
+
"send_email_notifications": {
|
|
1518
|
+
"type": "integer",
|
|
1519
|
+
"enum": [
|
|
1520
|
+
0,
|
|
1521
|
+
1
|
|
1522
|
+
],
|
|
1523
|
+
"description": "Set to `1` to trigger the welcome email on member creation (based on the membership plan's configured email). Default: off — API creates are silent because they typically aren't self-signups. Only set this when you WANT the member notified."
|
|
1512
1524
|
}
|
|
1513
1525
|
}
|
|
1514
1526
|
}
|
|
@@ -1527,14 +1539,14 @@
|
|
|
1527
1539
|
}
|
|
1528
1540
|
}
|
|
1529
1541
|
},
|
|
1530
|
-
"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`
|
|
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- **Category-name references:** when referencing a category or service by NAME (not ID) in any field, wrap the value in SINGLE QUOTES — e.g. `'25-30'`, `'Cosmetic Dentistry'`. Avoids parser confusion on values with dashes/spaces.\n\n**Category handling — you can pass IDs OR NAMES (verified live 2026-04-18):**\n\nTop-level category:\n- `profession_id` — numeric ID (from `listTopCategories`)\n- `profession_name` — OR pass the category name as a string. If the name doesn't exist, BD auto-creates it (auto-create is ALWAYS ON during createUser — hardcoded in `createActions()`).\n\nSub-categories (services):\n- `services` — CSV of either numeric IDs or names. BD checks each value with `is_numeric()`: numeric → lookup by `service_id`, non-numeric → lookup by name in `list_services`. Names that don't exist get auto-created under the current top-level category (`master_id=0`).\n\nTips:\n- Quote names containing special chars — e.g. `'25-30'`, `'Cosmetic Dentistry'`.\n- Sub-sub categories by name are not auto-created by this endpoint — use `createSubCategory` directly with `master_id=<parent service_id>` if you need deeper nesting.\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._"
|
|
1531
1543
|
}
|
|
1532
1544
|
},
|
|
1533
1545
|
"/api/v2/user/update": {
|
|
1534
1546
|
"put": {
|
|
1535
1547
|
"operationId": "updateUser",
|
|
1536
1548
|
"summary": "Update an existing member/user",
|
|
1537
|
-
"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`
|
|
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- **Category-name references:** when referencing a category or service by NAME (not ID) in any field, wrap the value in SINGLE QUOTES — e.g. `'25-30'`, `'Cosmetic Dentistry'`. Avoids parser confusion on values with dashes/spaces.\n- `create_new_categories=1` (update only) — allows `updateUser` to inline-create new sub and sub-sub categories under the member's current top-level category, instead of requiring them to exist first. Sub-categories must match the parent top category; sub-sub must match the parent sub.\n\n**Category handling — IDs or NAMES, with an explicit opt-in for auto-create (verified live 2026-04-18):**\n\n- `profession_id` or `profession_name` — same as `createUser`; pass either.\n- `services` — CSV of IDs or names. BD does `is_numeric()` to decide: numeric → ID lookup, non-numeric → name lookup in `list_services`.\n- **Unknown names silently SKIP by default during update** (unlike create).\n- To auto-create unknown names during update, pass `create_new_categories=1`. Sub-categories created this way go under the member's current top-level category with `master_id=0`.\n- `create_new_categories` has NO effect on create (create auto-creates always — this flag is only meaningful for update).\n- Sub-sub categories by name are not auto-created — use `createSubCategory` with `master_id=<parent service_id>` for deeper nesting.\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._",
|
|
1538
1550
|
"tags": [
|
|
1539
1551
|
"Users"
|
|
1540
1552
|
],
|
|
@@ -1791,6 +1803,18 @@
|
|
|
1791
1803
|
"0"
|
|
1792
1804
|
],
|
|
1793
1805
|
"description": "If YES, system will import user images and save them to your website. Processing may take several minutes after import.\\n\\nValid values:\\n 1 = Yes\\n 0 = No"
|
|
1806
|
+
},
|
|
1807
|
+
"profession_name": {
|
|
1808
|
+
"type": "string",
|
|
1809
|
+
"description": "Alternative to `profession_id` — pass the top-level category NAME as a string. BD looks it up in `list_professions`. On `createUser`, unknown names are auto-created. On `updateUser`, unknown names are silently skipped unless `create_new_categories=1` is also passed."
|
|
1810
|
+
},
|
|
1811
|
+
"create_new_categories": {
|
|
1812
|
+
"type": "integer",
|
|
1813
|
+
"enum": [
|
|
1814
|
+
0,
|
|
1815
|
+
1
|
|
1816
|
+
],
|
|
1817
|
+
"description": "Set to `1` to enable auto-creation of unknown category/service names during this `updateUser` call. Without this flag, unknown names in `services` or `profession_name` are silently skipped. Has no effect on `createUser` (which always auto-creates). Auto-created sub-categories go under the member's current top-level category with `master_id=0`; deeper nesting requires a separate `createSubCategory` call."
|
|
1794
1818
|
}
|
|
1795
1819
|
}
|
|
1796
1820
|
}
|
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.
|
|
4
|
+
"version": "5.2.0",
|
|
5
5
|
"description": "Official MCP server for Brilliant Directories — manage members, posts, leads, reviews, and more.",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"bin": {
|