@snokam/mcp-salesforce 1.124.0 → 1.125.0

package/src/index.ts

@@ -1,400 +1,15 @@
 #!/usr/bin/env node
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { z } from "zod";
-
-// Auth: prefer a ready per-business OAuth access token (provisioned by the
-// platform); fall back to the client-credentials flow with a connected app's
-// consumer key/secret. Instance URL comes from the OAuth response (or env).
-const SF_ACCESS_TOKEN = process.env.SALESFORCE_ACCESS_TOKEN;
-const SF_CONSUMER_KEY = process.env.SALESFORCE_CONSUMER_KEY;
-const SF_CONSUMER_SECRET = process.env.SALESFORCE_CONSUMER_SECRET;
-const SF_INSTANCE_URL =
-  process.env.SALESFORCE_INSTANCE_URL || "https://snokam.my.salesforce.com";
-const SF_API_VERSION = "v62.0";
-
-let accessToken: string | null = SF_ACCESS_TOKEN ?? null;
-
-async function getAccessToken(): Promise<string> {
-  if (accessToken) {
-    return accessToken;
-  }
-
-  if (!SF_CONSUMER_KEY || !SF_CONSUMER_SECRET) {
-    throw new Error(
-      "Set SALESFORCE_ACCESS_TOKEN, or SALESFORCE_CONSUMER_KEY + SALESFORCE_CONSUMER_SECRET"
-    );
-  }
-
-  const params = new URLSearchParams({
-    client_id: SF_CONSUMER_KEY,
-    client_secret: SF_CONSUMER_SECRET,
-    grant_type: "client_credentials",
-  });
-
-  const response = await fetch(`${SF_INSTANCE_URL}/services/oauth2/token`, {
-    method: "POST",
-    headers: { "Content-Type": "application/x-www-form-urlencoded" },
-    body: params,
-  });
-
-  if (!response.ok) {
-    const error = await response.text();
-    throw new Error(
-      `Failed to get access token: ${response.status} - ${error}`
-    );
-  }
-
-  const data = await response.json();
-  accessToken = data.access_token;
-  return accessToken!;
-}
-
-async function sfQuery<T = unknown>(soql: string): Promise<T[]> {
-  const token = await getAccessToken();
-  const url = `${SF_INSTANCE_URL}/services/data/${SF_API_VERSION}/query?q=${encodeURIComponent(soql)}`;
-
-  const response = await fetch(url, {
-    headers: { Authorization: `Bearer ${token}` },
-  });
-
-  if (!response.ok) {
-    const error = await response.text();
-    throw new Error(`Salesforce query failed: ${response.status} - ${error}`);
-  }
-
-  const data = await response.json();
-  return data.records as T[];
-}
+import { registerTools } from "./tools/index.js";
 
 const server = new McpServer({
   name: "salesforce-mcp",
   version: "1.0.0",
 });
 
-// Tool: Search Contacts
-server.tool(
-  "search_contacts",
-  "Search for contacts in Salesforce by name, email, or company",
-  {
-    query: z.string().describe("Search query (name, email, or company)"),
-    limit: z.number().default(10).describe("Maximum number of results"),
-  },
-  async ({ query, limit }) => {
-    const escapedQuery = query.replace(/'/g, "\\'");
-    const soql = `
-      SELECT Id, Name, Email, Phone, Title, Account.Name, Account.Strategic_Priority__c, LastActivityDate
-      FROM Contact
-      WHERE Name LIKE '%${escapedQuery}%' OR Email LIKE '%${escapedQuery}%' OR Account.Name LIKE '%${escapedQuery}%'
-      ORDER BY LastActivityDate DESC NULLS LAST
-      LIMIT ${limit}
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Search Leads
-server.tool(
-  "search_leads",
-  "Search for leads in Salesforce",
-  {
-    query: z.string().describe("Search query"),
-    status: z
-      .string()
-      .optional()
-      .describe("Lead status filter (e.g., Open, Working, Closed)"),
-    limit: z.number().default(10).describe("Maximum number of results"),
-  },
-  async ({ query, status, limit }) => {
-    const escapedQuery = query.replace(/'/g, "\\'");
-    let whereClause = `Name LIKE '%${escapedQuery}%' OR Email LIKE '%${escapedQuery}%' OR Company LIKE '%${escapedQuery}%'`;
-    if (status) {
-      whereClause = `(${whereClause}) AND Status = '${status}'`;
-    }
-    const soql = `
-      SELECT Id, Name, Email, Phone, Company, Status, LeadSource, CreatedDate
-      FROM Lead
-      WHERE ${whereClause}
-      ORDER BY CreatedDate DESC
-      LIMIT ${limit}
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Get Opportunities
-server.tool(
-  "get_opportunities",
-  "Get opportunities from Salesforce pipeline",
-  {
-    stage: z
-      .string()
-      .optional()
-      .describe("Filter by stage (e.g., Prospecting, Negotiation, Closed Won)"),
-    accountId: z.string().optional().describe("Filter by account ID"),
-    limit: z.number().default(20).describe("Maximum number of results"),
-  },
-  async ({ stage, accountId, limit }) => {
-    const conditions: string[] = [];
-    if (stage) conditions.push(`StageName = '${stage}'`);
-    if (accountId) conditions.push(`AccountId = '${accountId}'`);
-
-    const whereClause =
-      conditions.length > 0 ? `WHERE ${conditions.join(" AND ")}` : "";
-    const soql = `
-      SELECT Id, Name, StageName, Amount, CloseDate, Account.Name, Owner.Name, Probability
-      FROM Opportunity
-      ${whereClause}
-      ORDER BY CloseDate ASC
-      LIMIT ${limit}
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Get Account Details
-server.tool(
-  "get_account",
-  "Get detailed information about a Salesforce account",
-  {
-    accountId: z.string().describe("Salesforce Account ID"),
-  },
-  async ({ accountId }) => {
-    const soql = `
-      SELECT Id, Name, Industry, Website, Phone, BillingCity, BillingCountry,
-             Description, NumberOfEmployees, AnnualRevenue, Owner.Name, Type,
-             Strategic_Priority__c, Technology__c, LastActivityDate,
-             (SELECT Id, Name, Email, Title FROM Contacts LIMIT 10),
-             (SELECT Id, Name, StageName, Amount, CloseDate FROM Opportunities ORDER BY CloseDate DESC LIMIT 5)
-      FROM Account
-      WHERE Id = '${accountId}'
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records[0], null, 2) }],
-    };
-  }
-);
-
-// Tool: Search Accounts
-server.tool(
-  "search_accounts",
-  "Search for accounts/companies in Salesforce",
-  {
-    query: z.string().describe("Search query (company name)"),
-    type: z
-      .string()
-      .optional()
-      .describe("Account type filter (e.g., Prospect, Customer)"),
-    limit: z.number().default(10).describe("Maximum number of results"),
-  },
-  async ({ query, type, limit }) => {
-    const escapedQuery = query.replace(/'/g, "\\'");
-    let whereClause = `Name LIKE '%${escapedQuery}%'`;
-    if (type) {
-      whereClause += ` AND Type = '${type}'`;
-    }
-    const soql = `
-      SELECT Id, Name, Industry, Website, Phone, BillingCity, Owner.Name, Type, 
-             Strategic_Priority__c, Technology__c, LastActivityDate
-      FROM Account
-      WHERE ${whereClause}
-      ORDER BY Name ASC
-      LIMIT ${limit}
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Get Strategic Contacts (for follow-up)
-server.tool(
-  "get_strategic_contacts",
-  "Get contacts from strategic priority accounts that need follow-up",
-  {
-    priority: z
-      .enum(["A", "B", "C", "D"])
-      .default("D")
-      .describe("Strategic priority filter"),
-    daysInactive: z.number().default(90).describe("Days since last activity"),
-    limit: z.number().default(20).describe("Maximum number of results"),
-  },
-  async ({ priority, daysInactive, limit }) => {
-    const cutoffDate = new Date(Date.now() - daysInactive * 24 * 60 * 60 * 1000)
-      .toISOString()
-      .split("T")[0];
-    const soql = `
-      SELECT Id, Name, Title, Email, Account.Name, Account.Strategic_Priority__c, 
-             Account.Technology__c, Account.Description, Account.LastActivityDate
-      FROM Contact
-      WHERE Account.Type = 'Prospect'
-      AND Account.Strategic_Priority__c = '${priority}'
-      AND Email != null
-      AND (Account.LastActivityDate < ${cutoffDate} OR Account.LastActivityDate = null)
-      LIMIT ${limit}
-    `;
-    const records = await sfQuery(soql);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Execute SOQL Query
-server.tool(
-  "soql_query",
-  "Execute a custom SOQL query against Salesforce (read-only)",
-  {
-    query: z.string().describe("SOQL query to execute"),
-  },
-  async ({ query }) => {
-    // Basic safety check - only allow SELECT queries
-    if (!query.trim().toUpperCase().startsWith("SELECT")) {
-      return {
-        content: [
-          { type: "text", text: "Error: Only SELECT queries are allowed" },
-        ],
-        isError: true,
-      };
-    }
-    const records = await sfQuery(query);
-    return {
-      content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
-    };
-  }
-);
-
-// Tool: Get Recent Activities for Contact
-server.tool(
-  "get_contact_activities",
-  "Get recent activities (events and tasks) for a specific contact",
-  {
-    contactId: z.string().describe("Salesforce Contact ID"),
-    daysBack: z.number().default(90).describe("Number of days to look back"),
-  },
-  async ({ contactId, daysBack }) => {
-    const cutoffDate = new Date(
-      Date.now() - daysBack * 24 * 60 * 60 * 1000
-    ).toISOString();
-
-    // Get events
-    const eventsSoql = `
-      SELECT Id, Subject, Description, ActivityDateTime
-      FROM Event
-      WHERE WhoId = '${contactId}'
-      AND ActivityDateTime > ${cutoffDate}
-      ORDER BY ActivityDateTime DESC
-    `;
-
-    // Get tasks
-    const tasksSoql = `
-      SELECT Id, Subject, Description, ActivityDate, Status
-      FROM Task
-      WHERE WhoId = '${contactId}'
-      AND ActivityDate > ${cutoffDate.split("T")[0]}
-      ORDER BY ActivityDate DESC
-    `;
-
-    const [events, tasks] = await Promise.all([
-      sfQuery(eventsSoql),
-      sfQuery(tasksSoql),
-    ]);
-
-    return {
-      content: [
-        {
-          type: "text",
-          text: JSON.stringify({ events, tasks }, null, 2),
-        },
-      ],
-    };
-  }
-);
-
-// Tool: Get Comprehensive Contact Info (like existing chatgpt-function)
-server.tool(
-  "get_comprehensive_contact",
-  "Get comprehensive contact information including account details and recent activities",
-  {
-    contactId: z.string().describe("Salesforce Contact ID"),
-    daysBack: z
-      .number()
-      .default(90)
-      .describe("Number of days to look back for activities"),
-  },
-  async ({ contactId, daysBack }) => {
-    // Get contact details
-    const contactSoql = `
-      SELECT Id, Name, Title, Email, Phone, Description,
-             Account.Name, Account.Strategic_Priority__c, Account.Technology__c, 
-             Account.Description, Account.Industry, Account.Website
-      FROM Contact
-      WHERE Id = '${contactId}'
-    `;
-
-    const contacts = await sfQuery(contactSoql);
-    const contact = contacts[0];
-
-    if (!contact) {
-      return {
-        content: [
-          { type: "text", text: `No contact found with ID: ${contactId}` },
-        ],
-        isError: true,
-      };
-    }
-
-    const cutoffDate = new Date(
-      Date.now() - daysBack * 24 * 60 * 60 * 1000
-    ).toISOString();
-
-    // Get events and tasks
-    const eventsSoql = `
-      SELECT Id, Subject, Description, ActivityDateTime
-      FROM Event
-      WHERE WhoId = '${contactId}'
-      AND ActivityDateTime > ${cutoffDate}
-      ORDER BY ActivityDateTime DESC
-      LIMIT 20
-    `;
-
-    const tasksSoql = `
-      SELECT Id, Subject, Description, ActivityDate, Status
-      FROM Task
-      WHERE WhoId = '${contactId}'
-      AND ActivityDate > ${cutoffDate.split("T")[0]}
-      ORDER BY ActivityDate DESC
-      LIMIT 20
-    `;
-
-    const [events, tasks] = await Promise.all([
-      sfQuery(eventsSoql),
-      sfQuery(tasksSoql),
-    ]);
-
-    return {
-      content: [
-        {
-          type: "text",
-          text: JSON.stringify({ contact, events, tasks }, null, 2),
-        },
-      ],
-    };
-  }
-);
+registerTools(server);
 
-// Start the server
 async function main() {
   const transport = new StdioServerTransport();
   await server.connect(transport);

package/src/salesforce-client.ts

@@ -0,0 +1,60 @@
+const SF_ACCESS_TOKEN = process.env.SALESFORCE_ACCESS_TOKEN;
+const SF_CONSUMER_KEY = process.env.SALESFORCE_CONSUMER_KEY;
+const SF_CONSUMER_SECRET = process.env.SALESFORCE_CONSUMER_SECRET;
+const SF_INSTANCE_URL =
+  process.env.SALESFORCE_INSTANCE_URL || "https://snokam.my.salesforce.com";
+const SF_API_VERSION = "v62.0";
+
+let accessToken: string | null = SF_ACCESS_TOKEN ?? null;
+
+async function getAccessToken(): Promise<string> {
+  if (accessToken) {
+    return accessToken;
+  }
+
+  if (!SF_CONSUMER_KEY || !SF_CONSUMER_SECRET) {
+    throw new Error(
+      "Set SALESFORCE_ACCESS_TOKEN, or SALESFORCE_CONSUMER_KEY + SALESFORCE_CONSUMER_SECRET"
+    );
+  }
+
+  const params = new URLSearchParams({
+    client_id: SF_CONSUMER_KEY,
+    client_secret: SF_CONSUMER_SECRET,
+    grant_type: "client_credentials",
+  });
+
+  const response = await fetch(`${SF_INSTANCE_URL}/services/oauth2/token`, {
+    method: "POST",
+    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+    body: params,
+  });
+
+  if (!response.ok) {
+    const error = await response.text();
+    throw new Error(
+      `Failed to get access token: ${response.status} - ${error}`
+    );
+  }
+
+  const data = await response.json();
+  accessToken = data.access_token;
+  return accessToken!;
+}
+
+export async function sfQuery<T = unknown>(soql: string): Promise<T[]> {
+  const token = await getAccessToken();
+  const url = `${SF_INSTANCE_URL}/services/data/${SF_API_VERSION}/query?q=${encodeURIComponent(soql)}`;
+
+  const response = await fetch(url, {
+    headers: { Authorization: `Bearer ${token}` },
+  });
+
+  if (!response.ok) {
+    const error = await response.text();
+    throw new Error(`Salesforce query failed: ${response.status} - ${error}`);
+  }
+
+  const data = await response.json();
+  return data.records as T[];
+}

package/src/tools/accounts.ts

@@ -0,0 +1,60 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import { sfQuery } from "../salesforce-client.js";
+
+export function registerAccountTools(server: McpServer): void {
+  server.tool(
+    "get_account",
+    "Get detailed information about a Salesforce account",
+    {
+      accountId: z.string().describe("Salesforce Account ID"),
+    },
+    async ({ accountId }) => {
+      const soql = `
+      SELECT Id, Name, Industry, Website, Phone, BillingCity, BillingCountry,
+             Description, NumberOfEmployees, AnnualRevenue, Owner.Name, Type,
+             Strategic_Priority__c, Technology__c, LastActivityDate,
+             (SELECT Id, Name, Email, Title FROM Contacts LIMIT 10),
+             (SELECT Id, Name, StageName, Amount, CloseDate FROM Opportunities ORDER BY CloseDate DESC LIMIT 5)
+      FROM Account
+      WHERE Id = '${accountId}'
+    `;
+      const records = await sfQuery(soql);
+      return {
+        content: [{ type: "text", text: JSON.stringify(records[0], null, 2) }],
+      };
+    }
+  );
+
+  server.tool(
+    "search_accounts",
+    "Search for accounts/companies in Salesforce",
+    {
+      query: z.string().describe("Search query (company name)"),
+      type: z
+        .string()
+        .optional()
+        .describe("Account type filter (e.g., Prospect, Customer)"),
+      limit: z.number().default(10).describe("Maximum number of results"),
+    },
+    async ({ query, type, limit }) => {
+      const escapedQuery = query.replace(/'/g, "\\'");
+      let whereClause = `Name LIKE '%${escapedQuery}%'`;
+      if (type) {
+        whereClause += ` AND Type = '${type}'`;
+      }
+      const soql = `
+      SELECT Id, Name, Industry, Website, Phone, BillingCity, Owner.Name, Type,
+             Strategic_Priority__c, Technology__c, LastActivityDate
+      FROM Account
+      WHERE ${whereClause}
+      ORDER BY Name ASC
+      LIMIT ${limit}
+    `;
+      const records = await sfQuery(soql);
+      return {
+        content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
+      };
+    }
+  );
+}

package/src/tools/contacts.ts

@@ -0,0 +1,175 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import { sfQuery } from "../salesforce-client.js";
+
+export function registerContactTools(server: McpServer): void {
+  server.tool(
+    "search_contacts",
+    "Search for contacts in Salesforce by name, email, or company",
+    {
+      query: z.string().describe("Search query (name, email, or company)"),
+      limit: z.number().default(10).describe("Maximum number of results"),
+    },
+    async ({ query, limit }) => {
+      const escapedQuery = query.replace(/'/g, "\\'");
+      const soql = `
+      SELECT Id, Name, Email, Phone, Title, Account.Name, Account.Strategic_Priority__c, LastActivityDate
+      FROM Contact
+      WHERE Name LIKE '%${escapedQuery}%' OR Email LIKE '%${escapedQuery}%' OR Account.Name LIKE '%${escapedQuery}%'
+      ORDER BY LastActivityDate DESC NULLS LAST
+      LIMIT ${limit}
+    `;
+      const records = await sfQuery(soql);
+      return {
+        content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
+      };
+    }
+  );
+
+  server.tool(
+    "get_strategic_contacts",
+    "Get contacts from strategic priority accounts that need follow-up",
+    {
+      priority: z
+        .enum(["A", "B", "C", "D"])
+        .default("D")
+        .describe("Strategic priority filter"),
+      daysInactive: z.number().default(90).describe("Days since last activity"),
+      limit: z.number().default(20).describe("Maximum number of results"),
+    },
+    async ({ priority, daysInactive, limit }) => {
+      const cutoffDate = new Date(
+        Date.now() - daysInactive * 24 * 60 * 60 * 1000
+      )
+        .toISOString()
+        .split("T")[0];
+      const soql = `
+      SELECT Id, Name, Title, Email, Account.Name, Account.Strategic_Priority__c,
+             Account.Technology__c, Account.Description, Account.LastActivityDate
+      FROM Contact
+      WHERE Account.Type = 'Prospect'
+      AND Account.Strategic_Priority__c = '${priority}'
+      AND Email != null
+      AND (Account.LastActivityDate < ${cutoffDate} OR Account.LastActivityDate = null)
+      LIMIT ${limit}
+    `;
+      const records = await sfQuery(soql);
+      return {
+        content: [{ type: "text", text: JSON.stringify(records, null, 2) }],
+      };
+    }
+  );
+
+  server.tool(
+    "get_contact_activities",
+    "Get recent activities (events and tasks) for a specific contact",
+    {
+      contactId: z.string().describe("Salesforce Contact ID"),
+      daysBack: z.number().default(90).describe("Number of days to look back"),
+    },
+    async ({ contactId, daysBack }) => {
+      const cutoffDate = new Date(
+        Date.now() - daysBack * 24 * 60 * 60 * 1000
+      ).toISOString();
+
+      const eventsSoql = `
+      SELECT Id, Subject, Description, ActivityDateTime
+      FROM Event
+      WHERE WhoId = '${contactId}'
+      AND ActivityDateTime > ${cutoffDate}
+      ORDER BY ActivityDateTime DESC
+    `;
+
+      const tasksSoql = `
+      SELECT Id, Subject, Description, ActivityDate, Status
+      FROM Task
+      WHERE WhoId = '${contactId}'
+      AND ActivityDate > ${cutoffDate.split("T")[0]}
+      ORDER BY ActivityDate DESC
+    `;
+
+      const [events, tasks] = await Promise.all([
+        sfQuery(eventsSoql),
+        sfQuery(tasksSoql),
+      ]);
+
+      return {
+        content: [
+          {
+            type: "text",
+            text: JSON.stringify({ events, tasks }, null, 2),
+          },
+        ],
+      };
+    }
+  );
+
+  server.tool(
+    "get_comprehensive_contact",
+    "Get comprehensive contact information including account details and recent activities",
+    {
+      contactId: z.string().describe("Salesforce Contact ID"),
+      daysBack: z
+        .number()
+        .default(90)
+        .describe("Number of days to look back for activities"),
+    },
+    async ({ contactId, daysBack }) => {
+      const contactSoql = `
+      SELECT Id, Name, Title, Email, Phone, Description,
+             Account.Name, Account.Strategic_Priority__c, Account.Technology__c,
+             Account.Description, Account.Industry, Account.Website
+      FROM Contact
+      WHERE Id = '${contactId}'
+    `;
+
+      const contacts = await sfQuery(contactSoql);
+      const contact = contacts[0];
+
+      if (!contact) {
+        return {
+          content: [
+            { type: "text", text: `No contact found with ID: ${contactId}` },
+          ],
+          isError: true,
+        };
+      }
+
+      const cutoffDate = new Date(
+        Date.now() - daysBack * 24 * 60 * 60 * 1000
+      ).toISOString();
+
+      const eventsSoql = `
+      SELECT Id, Subject, Description, ActivityDateTime
+      FROM Event
+      WHERE WhoId = '${contactId}'
+      AND ActivityDateTime > ${cutoffDate}
+      ORDER BY ActivityDateTime DESC
+      LIMIT 20
+    `;
+
+      const tasksSoql = `
+      SELECT Id, Subject, Description, ActivityDate, Status
+      FROM Task
+      WHERE WhoId = '${contactId}'
+      AND ActivityDate > ${cutoffDate.split("T")[0]}
+      ORDER BY ActivityDate DESC
+      LIMIT 20
+    `;
+
+      const [events, tasks] = await Promise.all([
+        sfQuery(eventsSoql),
+        sfQuery(tasksSoql),
+      ]);
+
+      return {
+        content: [
+          {
+            type: "text",
+            text: JSON.stringify({ contact, events, tasks }, null, 2),
+          },
+        ],
+      };
+    }
+  );
+}

package/src/tools/index.ts

@@ -0,0 +1,10 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { registerAccountTools } from "./accounts.js";
+import { registerContactTools } from "./contacts.js";
+import { registerPipelineTools } from "./pipeline.js";
+
+export function registerTools(server: McpServer): void {
+  registerContactTools(server);
+  registerAccountTools(server);
+  registerPipelineTools(server);
+}