Brilliant Directories API — ユニバーサルAI統合

1つのAPIキーで、あらゆるAIエージェントにBDサイトへのフルアクセス権を与えます。

32のリソースにわたる170のエンドポイント：会員、リード、投稿、レビュー、カテゴリー、メールテンプレート、ページ（ホームページ、ランディングページ）、301リダイレクト、スマートリスト、ウィジェット、メニュー、フォーム、会員プランなど。

30秒クイックスタート

コマンドは1つ。質問に2つ答えるだけ。完了です。

npx brilliant-directories-mcp --setup

ウィザードがBDサイトのURLとAPIキーを尋ね、接続をテストし、使用しているアプリ（Cursor / Claude Desktop / Windsurf / Claude Code）を確認して、設定を自動的に書き込みます。JSONの編集は不要です。

アプリを再起動し、AIにこう尋ねてください：

"List members on my BD site"（BDサイトの会員をリストアップして）

APIキーは BD管理画面 > Developer Hub > Generate API Key から取得してください。

AIエージェント / スクリプト用（非対話型）

AIエージェントがガイドしている場合、すべてが事前入力された単一のコマンドを貼り付けることができます：

npx brilliant-directories-mcp --setup --url https://your-site.com --api-key YOUR_KEY --client cursor

これにより、プロンプトなしでセットアップが完了します。cursorの部分をclaude-desktop、windsurf、claude-code、またはprint（ファイル書き込みの代わりにJSON設定を出力）に置き換えてください。

プラットフォーム別セットアップ

Claude Code / Cursor / Windsurf / Cline (MCP)

オプションA — npx（推奨、インストール不要）：

claude mcp add bd-api -- npx brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com

オプションB — グローバルインストール：

npm install -g brilliant-directories-mcp
claude mcp add bd-api -- brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com

Cursor / Windsurf / Cline — MCP設定ファイル（~/.cursor/mcp.jsonなど）に追加してください：

{
  "mcpServers": {
    "bd-api": {
      "command": "npx",
      "args": ["-y", "brilliant-directories-mcp", "--api-key", "YOUR_KEY", "--url", "https://your-site.com"]
    }
  }
}

その後、AIにこう尋ねてください："List all members on my BD site" または "Create a new member with email john@example.com"

ChatGPT (GPT Actions)

1. GPTの設定：Configure > Actions > Create new action

2. Schemaの下で Import from URL を選択し、以下を貼り付けます：

   https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

3. bd_site_urlを求められたら、BDサイト（例：https://mysite.com）を入力します

4. 認証設定：API Key、Auth Type：Custom、Header Name：X-Api-Key、キーを貼り付けます

n8n

オプションA — OpenAPI仕様のインポート（推奨）：

仕様URLをカスタムAPI定義としてインポートします：

https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

n8nはインポート時にBDサイトのURLとAPIキーを尋ねます。ファイル編集は不要です。

オプションB — HTTP Requestノードを使用：

1. 新しいワークフローを作成し、HTTP Requestノードを追加します

2. 設定：

   • Method: GET

   • URL: https://your-site.com/api/v2/user/get

   • Header: X-Api-Key: YOUR_KEY

Make / Zapier

Make: OpenAPI仕様を使用してカスタムアプリを作成するか、X-Api-Keyヘッダー付きのHTTPモジュールを使用します。

Zapier: すでにBD Zapierアプリを使用している場合、同じ基盤APIを使用しています。新しいエンドポイントについては、X-Api-Keyヘッダー付きのWebhooks by Zapierを使用してください。

curl / 各種HTTPクライアント

# Verify your API key
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/token/verify

# List members
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/user/get?limit=10

# Create a member
curl -X POST -H "X-Api-Key: YOUR_KEY" \
  -d "email=new@example.com&password=secret123&subscription_id=1&first_name=Jane&last_name=Doe" \
  https://your-site.com/api/v2/user/create

# Search members
curl -X POST -H "X-Api-Key: YOUR_KEY" \
  -d "q=dentist&address=Los Angeles&limit=10" \
  https://your-site.com/api/v2/user/search

# Update a member
curl -X PUT -H "X-Api-Key: YOUR_KEY" \
  -d "user_id=42&company=New Company Name" \
  https://your-site.com/api/v2/user/update

トラブルシューティング

1つのコマンドでセットアップを検証：

npx brilliant-directories-mcp --verify --api-key YOUR_KEY --url https://your-site.com

認証情報が機能すればOK、そうでなければエラーとともにFAILと表示されます。接続の問題が発生した際の最初のステップとして有効です。

デバッグモード — 動作の詳細を確認：

npx brilliant-directories-mcp --debug --verify --api-key YOUR_KEY --url https://your-site.com

すべてのAPIリクエストとレスポンスをstderrにログ出力（APIキーは自動的に隠蔽されます）して終了します。何かがうまくいかず、BDサポートと出力を共有したい場合に便利です。

--verifyを外すと、デバッグログ付きで完全なMCP stdioサーバーが起動します。MCPサーバーはstdio経由でAIクライアントの接続を待ち続けるため、通常のターミナルではハングアップしたように見えます。シェルからのワンショットデバッグには--debug --verifyを使用してください。

一般的な問題：

• 401 Unauthorized — APIキーが間違っている、取り消されている、またはエンドポイントへの権限がない

• 404 Not Found — サイトURLが間違っている（タイプミスを確認してください。https://は欠けている場合自動的に追加されます）

• 429 Too Many Requests — レート制限に達しました（デフォルトは100リクエスト/60秒）。待機するか、BD管理画面で制限を増やしてください

• Unknown tool (Claudeから) — MCPサーバーがOpenAPI仕様を読み込めていません。npm install -g brilliant-directories-mcpで再インストールしてください

認証

すべてのリクエストにはX-Api-Keyヘッダーが必要です：

X-Api-Key: your-api-key-here

APIキーは権限によってスコープが設定されます。各キーがどのエンドポイントにアクセスできるかを制御できます。

レート制限

デフォルト： APIキーごとに60秒あたり100リクエスト。 リクエスト時： 1分あたり最大1,000リクエストまで — Brilliant Directoriesサポートチームに連絡して、サイトの制限を引き上げてもらってください（100〜1,000/分の間で設定可能）。

この制限はBD側でサーバーサイドに設定されるもので、管理画面からセルフサービスで変更できる設定ではありません。大量のAPI利用が予想される場合は、一括操作の前にBDサポートにメールし、一時的または恒久的な引き上げを依頼してください。

制限を超えると、APIはHTTP 429 Too Many Requestsを返します。MCPサーバーはこれをAIエージェントにとってのアクション可能なエラーとして提示します。AIは待機するか、より高い制限をリクエストするよう提案します。

一括操作の計画： エージェントに数百件のレコードのインポート/更新を依頼する場合は、(a) 事前にBDサポートに高い制限をリクエストするか、(b) エージェントにペースを落とすよう指示してください（例："100/分のレート制限を守るために一時停止しながら、これら500人の会員をインポートして"）。

ページネーション

すべてのリストエンドポイントはページネーションをサポートしています：

レスポンスには以下が含まれます：total, current_page, total_pages, next_page, prev_page

フィルタリング

すべてのリストエンドポイントはフィルタリングをサポートしています：

GET /api/v2/user/get?property=city&property_value=Los Angeles&property_operator==

複数のフィルタ：

GET /api/v2/user/get?property[]=city&property_value[]=Los Angeles&property[]=state_code&property_value[]=CA

演算子：=, LIKE, >, <, >=, <=>

ソート

GET /api/v2/user/get?order_column=last_name&order_type=ASC

利用可能なリソース

フィールド探索

一部のエンドポイントは動的なフィールド探索をサポートしています：

# Get all available user fields
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/user/fields

# Get custom fields for a specific post type
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/data_posts/fields?form_name=my-form

ファイル

安定したアセットURL

URLで仕様をインポートするツール（ChatGPT Actions, n8n, Postman）用：

https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

セキュリティ

• APIキーはパッケージに埋め込まれません

• すべてのリクエストはユーザーのPCから直接BDサイトへ送信されます

• サードパーティサーバーを経由するデータはありません

• APIキーの権限でアクセス可能なエンドポイントを制御します

• APIキーはパスワードと同様に扱ってください

サポート

• BDサポート: https://support.brilliantdirectories.com

• APIドキュメント: https://support.brilliantdirectories.com/support/solutions/articles/12000108045