brilliant-directories-mcp 6.3.1 → 6.3.3

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.
Files changed (2) hide show
  1. package/README.md +50 -24
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,7 +38,9 @@ Once set up, you get new MCP versions automatically the next time you fully-quit
38
38
 
39
39
  ### What you can ask the AI to do
40
40
 
41
- Once connected, your AI can read AND write to your BD site. Examples: *"list all members who signed up this month"*, *"create a new member named Jane Doe with email jane@...,"* *"add a blog post by member 42 titled Welcome,"* *"show me unpaid invoices,"* *"add Jane to the VIP tag."* If the AI can do something on the site, it can probably do it via your agent now — 164 operations across members, posts, leads, reviews, pages, menus, widgets, and more.
41
+ Once connected, your AI can READ and WRITE to your BD site. Examples: *"list all members who signed up this month"*, *"create a new member named Jane Doe with email jane@…"*, *"add a blog post by member 42 titled Welcome"*, *"show me unpaid invoices"*, *"add Jane to the VIP tag"*. 164 operations across members, posts, leads, reviews, pages, menus, widgets, and more.
42
+
43
+ > ⚠️ **The AI can also DELETE and MODIFY live data** — members, posts, pages, tags, etc. Writes go directly to your live site with no undo. Before running bulk or destructive operations, test on ONE record first, and consider taking a backup. If you're unsure, ask the AI to *preview* (list/show) before it *acts*.
42
44
 
43
45
  ### For AI agents / scripts (non-interactive)
44
46
 
@@ -56,20 +58,23 @@ This runs the full setup end-to-end with no prompts. Replace `cursor` with `clau
56
58
 
57
59
  ### Claude Code / Cursor / Windsurf / Cline (MCP)
58
60
 
59
- **Option A — `npx` (recommended, no install needed):**
61
+ **Easiest path: use the wizard** from the [30-Second Quickstart](#30-second-quickstart) above — it handles all of this automatically.
62
+
63
+ If you prefer to wire things up by hand, here's how per app. Replace `YOUR_KEY` with your BD API key and `https://your-site.com` with your BD site URL (include `https://`, no trailing slash).
64
+
65
+ **Claude Code** — paste this one line in your terminal (Mac: Terminal.app · Windows: PowerShell):
60
66
 
61
67
  ```bash
62
68
  claude mcp add bd-api -- npx brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com
63
69
  ```
64
70
 
65
- **Option B — Global install:**
71
+ Then fully quit and reopen Claude Code.
66
72
 
67
- ```bash
68
- npm install -g brilliant-directories-mcp
69
- claude mcp add bd-api -- brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com
70
- ```
73
+ **Cursor** — open the MCP config file at `~/.cursor/mcp.json` (create it if missing: on Mac/Linux `mkdir -p ~/.cursor && touch ~/.cursor/mcp.json`; on Windows that path is `%USERPROFILE%\.cursor\mcp.json`). Paste the block below into the file, then save. Fully quit and reopen Cursor.
71
74
 
72
- **Cursor / Windsurf / Cline** — add to your MCP config file (`~/.cursor/mcp.json`, etc.):
75
+ **Windsurf** — same JSON format; the file is `~/.codeium/windsurf/mcp_config.json` on Mac/Linux, `%USERPROFILE%\.codeium\windsurf\mcp_config.json` on Windows.
76
+
77
+ **Cline** — same JSON format; the file is `~/Library/Application Support/Cline/MCP/cline_mcp_settings.json` on Mac, `%APPDATA%\Cline\MCP\cline_mcp_settings.json` on Windows.
73
78
 
74
79
  ```json
75
80
  {
@@ -82,6 +87,8 @@ claude mcp add bd-api -- brilliant-directories-mcp --api-key YOUR_KEY --url http
82
87
  }
83
88
  ```
84
89
 
90
+ After saving, **fully quit and reopen** the app (not just close the window — Mac `Cmd+Q`; Windows right-click taskbar → Quit).
91
+
85
92
  Then ask your AI: *"List all members on my BD site"* or *"Create a new member with email john@example.com"*
86
93
 
87
94
  ---
@@ -128,6 +135,8 @@ n8n will prompt for your BD site URL and API key on import. No file editing requ
128
135
 
129
136
  ### curl / Any HTTP Client
130
137
 
138
+ Paste these in a terminal (Mac: Terminal.app · Windows: PowerShell). Replace `YOUR_KEY` and `https://your-site.com` with real values.
139
+
131
140
  ```bash
132
141
  # Verify your API key
133
142
  curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/token/verify
@@ -155,7 +164,7 @@ curl -X PUT -H "X-Api-Key: YOUR_KEY" \
155
164
 
156
165
  ## Troubleshooting
157
166
 
158
- **Verify your setup with one command:**
167
+ **Verify your setup with one command.** Paste in a terminal (Mac: Terminal.app · Windows: PowerShell). Replace `YOUR_KEY` and `https://your-site.com` with real values:
159
168
  ```bash
160
169
  npx brilliant-directories-mcp --verify --api-key YOUR_KEY --url https://your-site.com
161
170
  ```
@@ -225,7 +234,7 @@ Multiple filters:
225
234
  GET /api/v2/user/get?property[]=city&property_value[]=Los Angeles&property[]=state_code&property_value[]=CA
226
235
  ```
227
236
 
228
- Operators: `=`, `LIKE`, `>`, `<`, `>=`, `<=`
237
+ Operators: `=`, `>`, `<`, `>=`, `<=`. Additional operators (`LIKE`, `!=`, `in`, `not_in`, `not_like`, `is_null`, `is_not_null`, `between`) are in QA and rolling out across endpoints shortly. For now, stick with `=` for string match, or enumerate and filter client-side.
229
238
 
230
239
  ## Sorting
231
240
 
@@ -281,18 +290,7 @@ curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/user/fields
281
290
  curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/data_posts/fields?form_name=my-form
282
291
  ```
283
292
 
284
- ## Files
285
-
286
- | File | Purpose |
287
- |------|---------|
288
- | [`openapi/bd-api.json`](openapi/bd-api.json) | OpenAPI 3.1 spec (single source of truth) |
289
- | [`mcp/index.js`](mcp/index.js) | MCP server for Claude/Cursor |
290
- | [`mcp/package.json`](mcp/package.json) | npm package definition |
291
- | [`docs/*.md`](docs/) | Raw API endpoint documentation |
292
- | [`LICENSE`](LICENSE) | MIT License |
293
- | [`CHANGELOG.md`](CHANGELOG.md) | Release history |
294
-
295
- ### Stable asset URLs
293
+ ## Stable asset URLs
296
294
 
297
295
  For tools that import specs by URL (ChatGPT Actions, n8n, Postman):
298
296
 
@@ -308,7 +306,35 @@ https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp
308
306
  - API key permissions control which endpoints are accessible
309
307
  - Treat your API key like a password
310
308
 
309
+ ## FAQ
310
+
311
+ **Does this cost anything?**
312
+ The MCP server is free (MIT license, open source). Your AI agent's subscription (Claude, Cursor, etc.) is separate. API calls to your BD site count against your site's rate limit but don't cost extra.
313
+
314
+ **Is my data sent to Anthropic / OpenAI / third parties?**
315
+ Your BD site data passes from your BD site directly to the AI client on your machine, then to the AI provider you use (Anthropic, OpenAI, etc.) as part of your conversation with the AI. The MCP server itself doesn't relay data anywhere else — no telemetry, no third-party servers in between.
316
+
317
+ **Can I connect more than one BD site?**
318
+ Yes. Add multiple entries under `mcpServers` with different names (e.g. `bd-site-a`, `bd-site-b`), each with its own API key and URL. Your AI will see tools from both.
319
+
320
+ **Can my team share one key, or should everyone have their own?**
321
+ Each person should generate their own API key (BD Admin → Developer Hub). Keys are per-user so revoking one doesn't break anyone else.
322
+
323
+ **How do I disconnect / remove the MCP?**
324
+ - Claude Code: `claude mcp remove bd-api`
325
+ - Cursor / Windsurf / Cline: delete the `bd-api` entry from the MCP config JSON file, save, fully quit and reopen the app.
326
+
327
+ **How do I undo something the AI did?**
328
+ BD's API doesn't have a universal undo. For members, prefer `updateUser active=3` (Canceled) over `deleteUser` — it's reversible. For destructive operations, back up first or test on one record.
329
+
330
+ **Can I try this safely on a test site before production?**
331
+ Yes. Generate a separate API key on a BD staging/dev site, set that URL + key in your MCP config. Once you trust the workflow, switch to production.
332
+
333
+ **How do I know which endpoints my API key has permission for?**
334
+ Check your key in BD Admin → Developer Hub. When you hit `403 API Key does not have permission to access this endpoint`, the error names the denied endpoint — enable it on the key, save, retry.
335
+
311
336
  ## Support
312
337
 
313
- - BD Support: https://support.brilliantdirectories.com
314
- - API Docs: https://support.brilliantdirectories.com/support/solutions/articles/12000108045
338
+ - **Bug reports / feature requests:** https://github.com/brilliantdirectories/brilliant-directories-mcp/issues
339
+ - **BD Support:** https://support.brilliantdirectories.com
340
+ - **API Docs:** https://support.brilliantdirectories.com/support/solutions/articles/12000108045
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": "6.3.1",
4
+ "version": "6.3.3",
5
5
  "description": "Official MCP server for Brilliant Directories — manage members, posts, leads, reviews, and more.",
6
6
  "main": "index.js",
7
7
  "bin": {