Agentforce (Salesforce)

🚀 Agentforce Proxy Server Guide

This guide provides detailed instructions on configuring and using the Agentforce proxy server, including environment variable setup, GitHub push script usage, and step-by-step procedures for obtaining necessary IDs and URLs from Salesforce.

🚀 Quick Start

Environment Variable Configuration

To configure environment variables, follow these steps:

1. Open the terminal.
2. Run the command: source ~/.bash_profile.

Using the GitHub Push Script

To simplify the process of pushing changes to GitHub, we've provided a convenient script. Follow these steps:

1. Give the script execution permissions:

   chmod +x github_push.sh
   

2. Execute the script:

   ./github_push.sh
   

The script performs the following actions:

• Checks if Git is installed on the system.
• Ensures sensitive files (e.g., .env) are not pushed to GitHub (these files are added to .gitignore).
• Prompts the user to enter the GitHub repository URL.
• Initializes the Git repository or updates the remote repository URL.
• Displays the files to be committed for user confirmation.
• Automatically generates a commit message and pushes the changes.

✨ Features

Step-by-Step Instructions

Creating a Connected App

1. Log in to the Salesforce organization using an administrator account.
2. Navigate to Setup.
3. Enter "App Manager" in the quick search bar and click to enter.
4. Click New Connected App.
5. Fill in the basic information:
   • App Name: e.g., "Agentforce MCP Integration".
   • API Name: Will be automatically filled.
   • Contact Email: Enter your email address.
6. Enable the OAuth settings option.
7. Set the callback URL to https://localhost/oauth/callback.
8. In Selected OAuth Scopes, add:
   • Manage user data (api).
   • Perform requests at any time (refresh_token, offline_access).
9. Click Save.
10. Record the Consumer Key (Client ID) on the connected app details page.
11. Click Show next to the Consumer Secret to obtain the client password.

Obtaining the Proxy ID

1. Log in to the Salesforce organization.
2. Navigate to Einstein Agent Builder.
3. Select the agent to use.
4. Check the URL in the browser address bar, which should be in the format https://your-salesforce-instance.lightning.force.com/lightning/r/Agent__c/0XxXXXXXXXXXXXXX/view.
5. Extract the 18-character ID (e.g., 0XxXXXXXXXXXXXXX) as the proxy ID.

Obtaining the Salesforce My Domain URL

1. Log in to the Salesforce organization.
2. Navigate to Setup.
3. Enter "My Domain" in the quick search bar and click to enter.
4. Check the displayed domain name in the format DOMAIN-NAME.my.salesforce.com.
5. Use this URL (without the "https://" prefix) in the .env file.

Obtaining the Organization ID

1. Log in to the Salesforce organization.
2. Navigate to Setup.
3. Enter "Company Information" in the quick search bar and click to enter.
4. Check the "Organization ID" field, which is your Salesforce organization ID.
5. It will be a 15 or 18-character code.

📦 Installation

Prerequisites

• Operating System: Linux/MacOS/Windows (Linux or MacOS recommended).
• Java Version: JDK 8 or higher.
• Git Tool: It's recommended to install Git for Windows if using Windows.

Downloading the Source Code

git clone https://github.com/agentforce/server.git
cd server

Configuring Environment Variables

Edit the ~/.bash_profile file and add the following content:

export AGENTFORCE_HOME=$(pwd)
source ~/.bash_profile

Installing Dependencies

After entering the project directory, run:

mvn clean install

💻 Usage Examples

Starting the Server

cd $AGENTFORCE_HOME/bin
./start.sh

Stopping the Server

cd $AGENTFORCE_HOME/bin
./stop.sh

Using the github_push.sh Script

This script helps push the local repository to GitHub, especially useful for initializing new projects.

Steps:

1. Add the script to the project root directory:

   wget https://raw.githubusercontent.com/agentforce/server/master/bin/github_push.sh
   

2. Give execution permissions and run:

   chmod +x github_push.sh
   ./github_push.sh
   

Parameter Explanation:

• The script doesn't require additional parameters and automatically detects Git configuration.
• After prompting for the repository URL, it automatically completes the push.

📚 Documentation

Troubleshooting

When encountering issues, check the following:

• Authentication Failure: Confirm that the connected app settings are correct.
• Proxy ID Retrieval Error: Check the URL in Einstein Agent Builder.
• Organization ID Error: Verify on the company information page.
• Callback URL Issue: Ensure the correct local callback address is set.

Frequently Asked Questions

Q: How to handle SSH connection issues?

A: Ensure that an SSH key has been generated locally and added to GitHub's SSH Keys settings. Run the following command to test:

ssh -T git@github.com

Q: What if the push fails?

A: Check the network connection, confirm the repository URL is correct, and then run the script again.

Complete Example

# Download the source code
git clone https://github.com/agentforce/server.git
cd server

# Configure environment variables
echo 'export AGENTFORCE_HOME=$(pwd)' >> ~/.bash_profile
source ~/.bash_profile

# Install dependencies
mvn clean install

# Start the server
cd $AGENTFORCE_HOME/bin
./start.sh

After running the above commands, you will successfully deploy and start the Agentforce proxy server.