Salesforce MCP

🚀 Salesforce MCP サーバー

Salesforce MCP サーバーは、自然言語処理（NLP）を通じてSalesforceデータと対話できるツールです。以下の機能をサポートしています。

✨ 主な機能

• スマートオブジェクト検索：特定のトピックに関連するSalesforceオブジェクトを検索します。
• アーキテクチャ情報検索：Salesforceオブジェクトのフィールド、関係、制約を取得します。
• データクエリ：SOQLクエリを実行して、条件に合致するデータレコードを検索します。
• フィールドタイプフィルタリング：データタイプに基づいてSalesforceオブジェクト内のフィールドをフィルタリングします。
• ドロップダウンリスト値取得：Salesforceのドロップダウンフィールドのすべての可能な値を抽出します。
• デバッグログ管理：特定のユーザーのデバッグログを有効化、無効化、または取得します。
• 検証ルール表示：Salesforceオブジェクト上のすべての検証ルールを確認します。

🚀 クイックスタート

前提条件

Salesforce MCP サーバーを使用するには、以下の条件を満たしていることを確認してください。

1. Python 3.6以上をインストールする。
2. Dockerをインストールして構成する（コンテナ化環境を実行するため）。
3. Salesforce開発者サンドボックスまたは本番環境へのアクセス権を取得する。
4. SalesforceのAPIとSOQLクエリ構文に精通していること。

インストールと構成

Dockerを使用した実行

1. Dockerをダウンロードしてインストールします：https://www.docker.com/get-started
2. プロジェクトリポジトリをクローンします：

   git clone https://github.com/your-username/salesforce-mcp-server.git
   

3. プロジェクトディレクトリに移動します：

   cd salesforce-mcp-server
   

4. Dockerコンテナを起動します：

   docker-compose up --build
   

5. MCPサーバーコンソールにアクセスします。デフォルトのポートは5000です。

VS Codeでの構成

1. VS Codeを開き、以下の拡張機能をインストールします：
   • Python
   • Docker
2. プロジェクトフォルダをVS Codeのワークスペースに追加します。
3. 依存関係をインストールします：

   pip install -r requirements.txt
   

4. サーバーを起動します：

   python server.py
   

💻 使用例

基本的な使用法

オブジェクトの検索

# Accountに関連するオブジェクトを検索する
search_objects("Account")

# 顧客関係管理に関連するオブジェクトを表示する
search_objects("Customer Service")

# 注文管理で利用可能なオブジェクトをリストする
search_objects("Order Management")

アーキテクチャ情報の取得

# Accountオブジェクトのフィールドを取得する
describe_object("Account")

# Caseのステータスのドロップダウン値を表示する
describe_picklist_values("Case", "Status")

# Opportunityの関係フィールドを表示する
describe_relationship_fields("Opportunity")

レコードのクエリ

# 今月作成されたすべてのAccountレコードを検索する
query_records("Account", ["Id", "Name", "Industry"], 
              where="createdDate >= LAST_N_DAYS:30",
              limit=10)

# 高優先度のCaseとそれに関連するContactを表示する
query_records("Case", ["Id", "Subject", "Priority", "ContactId"],
              where="Priority = 'High'", 
              fields=["Account.Name"])

タイプ別のフィールドのフィルタリング

# Leadオブジェクト上のすべてのドロップダウンフィールドをリストする
get_fields_by_type("Lead", "Picklist")

# Opportunity上のすべての参照フィールドを取得する
get_fields_by_type("Opportunity", "Lookup")

# Accountオブジェクト上のすべての必須フィールドを検索する
get_fields_by_type("Account", "Required")

デバッグログの管理

# 特定のユーザーのデバッグログを有効にする
manage_debug_logs(action="enable", user_id="user@example.com")

# 管理者ユーザーの最近のログを取得する
manage_debug_logs(action="retrieve", user_id="admin@company.com")

# 指定されたユーザーのすべてのログ記録を無効にする
manage_debug_logs(action="disable", user_id="developer@organization.com")

検証ルールの取得

# Opportunityオブジェクト上のすべての検証ルールを表示する
get_validation_rules("Opportunity")

# Accountオブジェクトの制約条件を確認する
get_validation_rules("Account")

# カスタムオブジェクトのすべての検証ルールをリストする
get_validation_rules("Custom_Object__c")

📚 ドキュメント

開発ガイド

プロジェクト構造

salesforce-mcp-server/
├── server.py                 # メインサーバーファイル
├── config.py                # 構成管理モジュール
├── routes/                  # ルート定義と処理関数
│   ├── objects.py          # オブジェクト関連のルート
│   └── queries.py          # クエリ関連のルート
└── utils/                  # ユーティリティ関数ライブラリ
    ├── decorators.py       # リクエスト処理デコレータ
    ├── auth.py            # 認証モジュール
    └── db_connection.py   # データベース接続プール管理

開発手順

1. 依存関係のインストール：

   pip install -r requirements.txt
   

2. 環境変数の構成： .env ファイルに以下の内容を追加します。

   SALESFORCE_USERNAME=your_username@example.com
   SALESFORCE_PASSWORD=your_password
   SALESFORCE_SECURITY_TOKEN=your_token
   

3. 開発サーバーの起動：

   python server.py --mode debug
   

4. カスタムルートの作成： routes/ ディレクトリに新しいPythonファイルを追加し、BaseRoute クラスを継承します。
5. デバッグとテスト： VS Codeのデバッグ機能を使用するか、ターミナルでユニットテストを実行します。

   pytest tests/
   

貢献ガイド

コミュニティからの貢献を歓迎します！以下の手順に従ってください。

1. プロジェクトリポジトリをForkする
2. 新しいブランチを作成する：git checkout -b feature/your-feature-name
3. 変更をコミットする：git add . && git commit -m 'あなたのコミットメッセージ'
4. リモートリポジトリにプッシュする：git push origin feature/your-feature-name
5. Pull Requestを送信する

📄 ライセンス

このプロジェクトはMITライセンスに準拠しています。詳細は LICENSE ファイルを参照してください。

連絡先

何か質問がある場合は、以下の方法で連絡してください。

• メール：support@salesforce.com
• GitHubリポジトリ：https://github.com/your-username/salesforce-mcp-server