Salesforce MCP

🚀 Salesforce MCP 服務器

Salesforce MCP 服務器是一款藉助自然語言處理（NLP）技術，實現與 Salesforce 數據交互的工具。它提供了智能對象搜索、架構信息檢索、數據查詢等一系列實用功能，能有效提升與 Salesforce 數據交互的效率。

🚀 快速開始

要使用 Salesforce MCP 服務器，需先滿足以下先決條件，再根據自身需求選擇合適的安裝與配置方式。

先決條件

• 安裝 Python 3.6 或更高版本。
• 安裝並配置 Docker（用於運行容器化環境）。
• 獲取 Salesforce 開發者沙盒或生產環境的訪問權限。
• 熟悉 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
   

✨ 主要特性

• 智能對象搜索：查找與特定主題相關的 Salesforce 對象。
• 架構信息檢索：獲取 Salesforce 對象的字段、關係及約束。
• 數據查詢：執行 SOQL 查詢以檢索符合條件的數據記錄。
• 字段類型篩選：按數據類型篩選 Salesforce 對象中的字段。
• 下拉列表值獲取：提取 Salesforce 下拉字段的所有可能值。
• 調試日誌管理：啟用、禁用或檢索特定用戶的調試日誌。
• 驗證規則查看：瞭解 Salesforce 對象上的所有驗證規則。

💻 使用示例

基礎用法

搜索對象

# 搜索與 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