Skip to main content
Glama
PasinduGunarathne

wso2-bi-salesforce-mcp-server

Salesforce + Ballerina Quickstart (One-Shot Setup)

sf_quickstart

Validates Salesforce credentials, auto-detects sandbox or production, and scaffolds a Ballerina integration project in WSO2 BI workspace with pre-built types for standard and custom objects.

Instructions

End-to-end setup in a single call:

  1. Validates your Salesforce credentials.

  2. Auto-detects sandbox vs. production from sf_base_url hostname.

  3. Scaffolds a Ballerina project in your WSO2 BI workspace.

    • Standard SObjects use pre-built types from ballerinax/salesforce.types (no describe API calls, no generated boilerplate).

    • Custom (__c) objects are described and typed automatically.

  4. Optionally runs 'bal build' to verify compilation.

This is the recommended entry point — most users only need to call this tool.

If you don't yet have credentials, call sf_setup_guide first.

All inputs except the 4 credential fields have sensible defaults:

  • project_name: salesforce_integration

  • org_name: wso2bi

  • bi_path: ~/WSO2Integrator (mac/linux) or %USERPROFILE%\WSO2Integrator

  • target_objects: ["Account", "Contact", "Lead", "Opportunity"]

  • port: 9090

  • build: false (set true to compile after scaffolding)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sf_client_idYesSalesforce Connected App Consumer Key (Client ID)
sf_client_secretYesSalesforce Connected App Consumer Secret (Client Secret)
sf_refresh_tokenYesSalesforce OAuth2 Refresh Token obtained after authorization
sf_base_urlYesSalesforce org instance URL, e.g. https://myorg.my.salesforce.com (sandbox auto-detected from hostname)
project_nameNoBallerina package name (default: salesforce_integration)salesforce_integration
org_nameNoBallerina org name (default: wso2bi)wso2bi
bi_pathNoWSO2 BI workspace path (default: ~/WSO2Integrator)~/WSO2Integrator
target_objectsNoSObject API names (default: Account, Contact, Lead, Opportunity)
buildNoRun 'bal build' after scaffolding to verify the project compiles. Adds 30-90s but catches credential or version mismatches early.
cdc_listenersNoOptional CDC / Platform Event listeners to scaffold alongside the REST service.
portNoHTTP listener port (default: 9090)
sandboxNoForce sandbox mode (test.salesforce.com). Usually inferred from sf_base_url, set this only to override detection.
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses all steps (validation, auto-detection, scaffolding, optional build) with side-effect details (e.g., file creation, compilation time). Annotations already indicate non-read-only and non-destructive, so the description adds context about what the tool does without contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with numbered steps and bullet points for defaults. It is concise, front-loading the core purpose, and every sentence serves a purpose without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (12 parameters, no output schema, open world), the description is complete. It explains default behavior, the flow, and when to use this tool versus alternatives, making it fully actionable for an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds value by listing sensible defaults and explaining the sandbox auto-detection override. It also provides context for the cdc_listeners array structure, going beyond the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it performs an end-to-end setup in a single call, listing step-by-step actions (validate, detect, scaffold, optional build). It distinguishes itself as the recommended entry point among sibling tools, mentioning when to use alternatives like sf_setup_guide.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'most users only need to call this tool' and advises calling sf_setup_guide first if credentials are missing. The description also implies this is the starting point, with other tools for later customization.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/PasinduGunarathne/wso2-bi-salesforce-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server