salesforce_search_objects

Instructions

Implementation Reference

• src/tools/search.ts:19-59 (handler)

  The handler function that executes the salesforce_search_objects tool. It uses conn.describeGlobal() to get all objects, filters them based on the searchPattern by splitting into terms and checking name/label, formats results.

  export async function handleSearchObjects(conn: any, searchPattern: string) {
    // Get list of all objects
    const describeGlobal = await conn.describeGlobal();
    
    // Process search pattern to create a more flexible search
    const searchTerms = searchPattern.toLowerCase().split(' ').filter(term => term.length > 0);
    
    // Filter objects based on search pattern
    const matchingObjects = describeGlobal.sobjects.filter((obj: SalesforceObject) => {
      const objectName = obj.name.toLowerCase();
      const objectLabel = obj.label.toLowerCase();
      
      // Check if all search terms are present in either the API name or label
      return searchTerms.every(term => 
        objectName.includes(term) || objectLabel.includes(term)
      );
    });
  
    if (matchingObjects.length === 0) {
      return {
        content: [{
          type: "text",
          text: `No Salesforce objects found matching "${searchPattern}".`
        }],
        isError: false,
      };
    }
  
    // Format the output
    const formattedResults = matchingObjects.map((obj: SalesforceObject) => 
      `${obj.name}${obj.custom ? ' (Custom)' : ''}\n  Label: ${obj.label}`
    ).join('\n\n');
  
    return {
      content: [{
        type: "text",
        text: `Found ${matchingObjects.length} matching objects:\n\n${formattedResults}`
      }],
      isError: false,
    };
  }

• src/tools/search.ts:4-17 (schema)

  The Tool object defining the schema for salesforce_search_objects, including name, description, and inputSchema with searchPattern parameter.

  export const SEARCH_OBJECTS: Tool = {
    name: "salesforce_search_objects",
    description: "Search for Salesforce standard and custom objects by name pattern. Examples: 'Account' will find Account, AccountHistory; 'Order' will find WorkOrder, ServiceOrder__c etc.",
    inputSchema: {
      type: "object",
      properties: {
        searchPattern: {
          type: "string",
          description: "Search pattern to find objects (e.g., 'Account Coverage' will find objects like 'AccountCoverage__c')"
        }
      },
      required: ["searchPattern"]
    }
  };

• src/index.ts:73-77 (registration)

  Registration in the CallToolRequestSchema handler switch statement that extracts searchPattern from args and calls handleSearchObjects.

  case "salesforce_search_objects": {
    const { searchPattern } = args as { searchPattern: string };
    if (!searchPattern) throw new Error('searchPattern is required');
    return await handleSearchObjects(conn, searchPattern);
  }

• src/index.ts:45-63 (registration)

  Registration in ListToolsRequestSchema handler that includes SEARCH_OBJECTS in the list of available tools.

  server.setRequestHandler(ListToolsRequestSchema, async () => ({
    tools: [
      SEARCH_OBJECTS, 
      DESCRIBE_OBJECT, 
      QUERY_RECORDS, 
      AGGREGATE_QUERY,
      DML_RECORDS,
      MANAGE_OBJECT,
      MANAGE_FIELD,
      MANAGE_FIELD_PERMISSIONS,
      SEARCH_ALL,
      READ_APEX,
      WRITE_APEX,
      READ_APEX_TRIGGER,
      WRITE_APEX_TRIGGER,
      EXECUTE_ANONYMOUS,
      MANAGE_DEBUG_LOGS
    ],
  }));

• src/index.ts:12-12 (helper)

  Import of the SEARCH_OBJECTS schema and handleSearchObjects handler from the search tool file.

  import { SEARCH_OBJECTS, handleSearchObjects } from "./tools/search.js";