Salesforce Lite

Um servidor simples e leve para conectar assistentes de IA aos dados do Salesforce.

Documentação

mcp-salesforce-lite

Servidor MCP Salesforce simples e leve para conectar assistentes de IA aos dados do Salesforce. Ideal para prototipagem e projetos pequenos.

PyPI version Python License: MIT GitHub stars

📦 Instalar via PyPI: pip install mcp-salesforce-lite

🔗 Pacote PyPI: https://pypi.org/project/mcp-salesforce-lite/

📚 Repositório GitHub: https://github.com/luvl/mcp-salesforce-lite

Demonstração

Veja o servidor MCP Salesforce Lite em ação com o Claude Desktop:

Salesforce MCP Demo

A demonstração mostra o Claude Desktop usando o servidor MCP para interagir com dados do Salesforce - consultando objetos, recuperando registros e realizando operações CRUD de forma integrada.

Visão Geral

Este servidor MCP (Model Context Protocol) fornece aos assistentes de IA, como o Claude, acesso seguro aos dados e operações do Salesforce. Ele implementa o padrão MCP para permitir integração perfeita entre aplicações de IA e o CRM Salesforce.

Recursos

  • 🔐 Autenticação segura do Salesforce via OAuth 2.0
  • 📊 Acesso a objetos do Salesforce (Contas, Contatos, Oportunidades, etc.)
  • 🔍 Execução de consultas SOQL
  • 📝 Operações CRUD em registros do Salesforce
  • 🛡️ Segurança integrada e limitação de taxa
  • 🚀 Configuração e instalação fáceis

Uso Rápido

# Install the package
pip install mcp-salesforce-lite

# Use with Claude Desktop (recommended)
uvx --from mcp-salesforce-lite mcp-salesforce-lite

# Or run directly
mcp-salesforce-lite

Funciona com: Claude Desktop, qualquer assistente de IA compatível com MCP

Início Rápido com Claude Desktop

Uso em Produção (Recomendado)

A maneira mais fácil de usar este servidor MCP é instalá-lo diretamente do PyPI e configurá-lo com o Claude Desktop.

Passo 1: Configurar o Claude Desktop

Adicione a seguinte configuração ao arquivo de configurações do Claude Desktop:

Localização do Arquivo de Configuração:

  • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Configuração:

{
  "mcpServers": {
    "salesforce-lite": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-salesforce-lite",
        "mcp-salesforce-lite"
      ],
      "env": {
        "SALESFORCE_ACCESS_TOKEN": "your_access_token",
        "SALESFORCE_INSTANCE_URL": "your_instance_url"
      }
    }
  }
}

Passo 2: Configurar Credenciais do Salesforce

Substitua as variáveis de ambiente na configuração:

  • SALESFORCE_ACCESS_TOKEN: Seu token de acesso do Salesforce
  • SALESFORCE_INSTANCE_URL: URL da sua instância do Salesforce (ex.: https://yourcompany.my.salesforce.com)

Passo 3: Reiniciar o Claude Desktop

Após salvar a configuração, reinicie o Claude Desktop. Você deve ver um ícone de martelo indicando que as ferramentas estão disponíveis.

Passo 4: Testar a Integração

Tente perguntar ao Claude:

  • "Liste os objetos disponíveis do Salesforce"
  • "Descreva o objeto Account"
  • "Execute uma consulta SOQL para obter leads recentes"

Pré-requisitos

  • Python 3.10 ou superior
  • Organização Salesforce Developer/Production
  • Connected App configurado no Salesforce

Configuração de Desenvolvimento

Se você deseja modificar ou contribuir com este servidor MCP, siga estas instruções de configuração de desenvolvimento.

Instalação

Opção 1: Usando uv (Recomendado para desenvolvimento)

# Install uv if you haven't already
brew install uv  # macOS
# or
curl -LsSf https://astral.sh/uv/install.sh | sh  # Linux/macOS

# Clone and install the server
git clone https://github.com/luvl/mcp-salesforce-lite.git
cd mcp-salesforce-lite
uv sync

Opção 2: Usando Poetry

git clone https://github.com/luvl/mcp-salesforce-lite.git
cd mcp-salesforce-lite
poetry install

Configuração de Desenvolvimento do Salesforce

Crie um arquivo .env na raiz do projeto:

SALESFORCE_ACCESS_TOKEN=your_access_token
SALESFORCE_INSTANCE_URL=your_instance_url

Uso

Modo de Desenvolvimento

Primeiro, certifique-se de ter suas credenciais do Salesforce configuradas no seu arquivo .env.

Método 1: Execução Direta em Python

# Run the server directly
python src/mcp_salesforce_lite/server.py

Método 2: Usando Poetry

# Run with Poetry
poetry run python src/mcp_salesforce_lite/server.py

Método 3: Usando UV (Recomendado)

# Run with UV
uv run python src/mcp_salesforce_lite/server.py

Testando com o MCP Inspector

Se você tiver o MCP CLI instalado, pode testar seu servidor:

# Test with MCP Inspector
mcp inspector

# Or run in development mode
mcp dev src/mcp_salesforce_lite/server.py

Como Publicar o Servidor como Pacote Pip

O servidor pode ser empacotado e distribuído via PyPI usando a configuração pyproject.toml incluída.

Ferramentas Disponíveis

O servidor fornece as seguintes ferramentas que os assistentes de IA podem usar:

Ferramentas de Consulta

  • soql_query: Executar consultas SOQL (o schema deve ser definido para solicitar confirmação cuidadosamente para operações UPDATE e DELETE)
  • search_records: Pesquisar registros em vários objetos com limite e paginação
  • get_record: Recuperar um registro específico por ID com limite e paginação

Operações CRUD

  • create_record: Criar novos registros (certifique-se de descrever o objeto primeiro e encontrar os campos de referência dos objetos)
  • update_record: Atualizar registros existentes
  • delete_record: Excluir registros

Ferramentas de Metadados

  • describe_object_definition: Obter metadados do objeto e informações de campos com paginação
  • list_avail_objects: Listar objetos disponíveis do Salesforce com limite e paginação

Integração de Desenvolvimento com Claude Desktop

Se você está desenvolvendo ou executando o servidor a partir do código-fonte, pode usar estas configurações alternativas:

💡 Dica: Arquivos de configuração de exemplo são fornecidos no diretório examples/:

  • examples/claude_config_direct.json - Execução direta em Python
  • examples/claude_config_poetry.json - Execução com Poetry
  • examples/claude_config_uv.json - Execução com UV (recomendado)

Opção 1: Execução Direta em Python

{
  "mcpServers": {
    "salesforce-lite": {
      "command": "python",
      "args": ["/ABSOLUTE/PATH/TO/mcp-salesforce-lite/src/mcp_salesforce_lite/server.py"],
      "env": {
        "SALESFORCE_ACCESS_TOKEN": "your_access_token",
        "SALESFORCE_INSTANCE_URL": "your_instance_url"
      }
    }
  }
}

Opção 2: Execução com Poetry

{
  "mcpServers": {
    "salesforce-lite": {
      "command": "poetry",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/mcp-salesforce-lite",
        "run",
        "python",
        "src/mcp_salesforce_lite/server.py"
      ],
      "env": {
        "SALESFORCE_ACCESS_TOKEN": "your_access_token",
        "SALESFORCE_INSTANCE_URL": "your_instance_url"
      }
    }
  }
}

Opção 3: Execução com UV (Recomendado para Desenvolvimento)

{
  "mcpServers": {
    "salesforce-lite": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/mcp-salesforce-lite",
        "run",
        "python",
        "src/mcp_salesforce_lite/server.py"
      ],
      "env": {
        "SALESFORCE_ACCESS_TOKEN": "your_access_token",
        "SALESFORCE_INSTANCE_URL": "your_instance_url"
      }
    }
  }
}

Estrutura do Projeto

mcp-salesforce-lite/
├── src/
│   └── mcp_salesforce_lite/
│       ├── __init__.py
│       ├── server.py          # Main MCP server
│       ├── client.py          # Salesforce client wrapper
│       ├── config.py          # Configuration management
│       └── tools/
│           ├── __init__.py
│           ├── query.py       # SOQL query tools
│           ├── crud.py        # Create, Read, Update, Delete tools
│           └── metadata.py    # Object metadata tools
├── examples/
│   ├── basic_usage.py
│   └── claude_config.json
├── assets/
│   └── sf-demo.gif           # Demo GIF showing usage
├── .env.example
├── pyproject.toml
├── poetry.lock
└── uv.lock

Publicação

Pré-requisitos

  1. Registre-se no PyPI Production: Acesse https://pypi.org/account/register/
  2. Ative a 2FA: Configure a autenticação de dois fatores nas configurações da sua conta
  3. Crie um Token de API: Acesse https://pypi.org/manage/account/token/ e crie um token
  4. Atualize o .pypirc: Substitua pypi-YOUR_PRODUCTION_TOKEN_FROM_PYPI_ORG_HERE pelo seu token real

Processo de Publicação

  1. Teste no TestPyPI primeiro:
# Build the package
uv build
# or: poetry build

# Upload to TestPyPI
twine upload --repository testpypi --config-file .pypirc dist/*

# Test install from TestPyPI
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ mcp-salesforce-lite
  1. Publique no PyPI Production:
# Upload to production PyPI
twine upload --repository pypi --config-file .pypirc dist/*

# Test install from production PyPI
pip install mcp-salesforce-lite

Gerenciamento de Versão

Para publicar uma nova versão:

  1. Atualize a versão em pyproject.toml
  2. Reconstrua: uv build ou poetry build
  3. Envie: twine upload --repository pypi --config-file .pypirc dist/*