Salesforce MCP Server

Instructions

Implementation Reference

• src/tools/writeApex.ts:70-179 (handler)

  Core handler function `handleWriteApex` that implements the tool logic: validates inputs, checks class existence, creates or updates Apex classes using Salesforce Tooling API, and returns formatted results or errors.
  export async function handleWriteApex(conn: any, args: WriteApexArgs) { try { // Validate inputs if (!args.className) { throw new Error('className is required'); } if (!args.body) { throw new Error('body is required'); } // Check if the class name in the body matches the provided className const classNameRegex = new RegExp(`\\b(class|interface|enum)\\s+${args.className}\\b`); if (!classNameRegex.test(args.body)) { throw new Error(`The class name in the body must match the provided className: ${args.className}`); } // Handle create operation if (args.operation === 'create') { console.error(`Creating new Apex class: ${args.className}`); // Check if class already exists const existingClass = await conn.query(` SELECT Id FROM ApexClass WHERE Name = '${args.className}' `); if (existingClass.records.length > 0) { throw new Error(`Apex class with name '${args.className}' already exists. Use 'update' operation instead.`); } // Create the new class using the Tooling API const createResult = await conn.tooling.sobject('ApexClass').create({ Name: args.className, Body: args.body, ApiVersion: args.apiVersion || '58.0', // Default to latest if not specified Status: 'Active' }); if (!createResult.success) { throw new Error(`Failed to create Apex class: ${createResult.errors.join(', ')}`); } return { content: [{ type: "text", text: `Successfully created Apex class: ${args.className}\n\n` + `**ID:** ${createResult.id}\n` + `**API Version:** ${args.apiVersion || '58.0'}\n` + `**Status:** Active` }] }; } // Handle update operation else if (args.operation === 'update') { console.error(`Updating Apex class: ${args.className}`); // Find the existing class const existingClass = await conn.query(` SELECT Id FROM ApexClass WHERE Name = '${args.className}' `); if (existingClass.records.length === 0) { throw new Error(`No Apex class found with name: ${args.className}. Use 'create' operation instead.`); } const classId = existingClass.records[0].Id; // Update the class using the Tooling API const updateResult = await conn.tooling.sobject('ApexClass').update({ Id: classId, Body: args.body }); if (!updateResult.success) { throw new Error(`Failed to update Apex class: ${updateResult.errors.join(', ')}`); } // Get the updated class details const updatedClass = await conn.query(` SELECT Id, Name, ApiVersion, Status, LastModifiedDate FROM ApexClass WHERE Id = '${classId}' `); const classDetails = updatedClass.records[0]; return { content: [{ type: "text", text: `Successfully updated Apex class: ${args.className}\n\n` + `**ID:** ${classId}\n` + `**API Version:** ${classDetails.ApiVersion}\n` + `**Status:** ${classDetails.Status}\n` + `**Last Modified:** ${new Date(classDetails.LastModifiedDate).toLocaleString()}` }] }; } else { throw new Error(`Invalid operation: ${args.operation}. Must be 'create' or 'update'.`); } } catch (error) { console.error('Error writing Apex class:', error); return { content: [{ type: "text", text: `Error writing Apex class: ${error instanceof Error ? error.message : String(error)}` }], isError: true, }; } }
• src/tools/writeApex.ts:32-54 (schema)

  Input schema defining the tool parameters: operation (create/update), className, apiVersion (optional), body.
  inputSchema: { type: "object", properties: { operation: { type: "string", enum: ["create", "update"], description: "Whether to create a new class or update an existing one" }, className: { type: "string", description: "Name of the Apex class to create or update" }, apiVersion: { type: "string", description: "API version for the Apex class (e.g., '58.0')" }, body: { type: "string", description: "Full body of the Apex class" } }, required: ["operation", "className", "body"] }
• src/tools/writeApex.ts:57-62 (schema)

  TypeScript interface `WriteApexArgs` for type-safe argument handling.
  export interface WriteApexArgs { operation: 'create' | 'update'; className: string; apiVersion?: string; body: string; }
• src/index.ts:240-255 (registration)

  Tool dispatch case in server request handler: performs additional validation and invokes `handleWriteApex`.
  case "salesforce_write_apex": { const apexArgs = args as Record<string, unknown>; if (!apexArgs.operation || !apexArgs.className || !apexArgs.body) { throw new Error('operation, className, and body are required for writing Apex'); } // Type check and conversion const validatedArgs: WriteApexArgs = { operation: apexArgs.operation as 'create' | 'update', className: apexArgs.className as string, apiVersion: apexArgs.apiVersion as string | undefined, body: apexArgs.body as string }; return await handleWriteApex(conn, validatedArgs); }
• src/index.ts:22-22 (registration)

  Import of the tool definition, handler, and types from writeApex module.
  import { WRITE_APEX, handleWriteApex, WriteApexArgs } from "./tools/writeApex.js";
• src/index.ts:45-63 (registration)

  Registration of WRITE_APEX in the server's list of available tools via ListToolsRequestHandler.
  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 ], }));