mcpField
S
sf-integration

sf-integration

github.com/jaganproDevelopment4241.4k installsUpdated 26w ago
Repository

About sf-integration

sf-integration is a Salesforce skill for planning integration architecture and runtime patterns. It covers credential design, API callouts, and event-driven options, with operational safeguards such as retries and timeout handling.

Key features

  1. 01Choose sync or async patterns
  2. 02Plan REST and SOAP callouts
  3. 03Configure credential architecture
  4. 04Use Platform Events and CDC
  5. 05Review retries, timeouts, and logging

Use cases

  1. 01Design an authenticated outbound API call
  2. 02Register an API from an OpenAPI spec
  3. 03Choose an event-driven change stream

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/jaganpro/sf-skills --skill sf-integration

After installing, type/sf-integrationin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

CREDITS.md
README.md
assets/callouts/
callout-retry-handler.cls
http-response-handler.cls
rest-queueable-callout.cls
rest-sync-callout.cls
assets/cdc/
cdc-handler.cls
cdc-subscriber-trigger.trigger
assets/endpoint-security/
example.cspTrustedSite-meta.xml
example.remoteSite-meta.xml
assets/external-credentials/
jwt-external-credential.externalCredential-meta.xml
oauth-external-credential.externalCredential-meta.xml
assets/external-services/
external-service-operations.md
openapi-registration.externalServiceRegistration-meta.xml
assets/named-credentials/
certificate-auth.namedCredential-meta.xml
custom-auth.namedCredential-meta.xml
oauth-client-credentials.namedCredential-meta.xml
oauth-jwt-bearer.namedCredential-meta.xml
assets/platform-events/
event-publisher.cls
event-subscriber-action.cls
event-subscriber-trigger.trigger
platform-event-definition.object-meta.xml
assets/soap/
soap-callout-service.cls
wsdl2apex-guide.md
hooks/scripts/
suggest_credential_setup.py
validate_integration.py
references/
callout-patterns.md
cdc-guide.md
cli-reference.md
event-driven-architecture-guide.md

Details

From the project README

sf-integration: Salesforce Integration Patterns Expert

Use this skill when the user needs integration architecture and runtime plumbing: Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, CDC, and event-driven integration design.

When This Skill Owns the Task

Use sf-integration when the work involves:

  • .namedCredential-meta.xml or External Credential metadata
  • outbound REST/SOAP callouts
  • External Service registration from OpenAPI specs
  • Platform Events, CDC, and event-driven architecture
  • choosing sync vs async integration patterns

Delegate elsewhere when the user is:


Required Context to Gather First

Ask for or infer:

  • integration style: outbound callout, inbound event, External Service, CDC, platform event
  • auth method
  • sync vs async requirement
  • system endpoint / spec details
  • rate limits, retry expectations, and failure tolerance
  • whether this is net-new design or repair of an existing integration

Recommended Workflow

1. Choose the integration pattern
NeedDefault pattern
authenticated outbound API callNamed Credential / External Credential + Apex or Flow
spec-driven API clientExternal Service
trigger-originated calloutasync callout pattern
decoupled event publishingPlatform Events
change-stream consumptionCDC
2. Choose the auth model

Prefer secure runtime-managed auth:

  • Named Credentials / External Credentials
  • OAuth or JWT via the right credential model
  • no hardcoded secrets in code
3. Generate from the right templates

Use the provided assets under:

  • assets/named-credentials/
  • assets/external-credentials/
  • assets/external-services/
  • assets/callouts/
  • assets/platform-events/
  • assets/cdc/
  • assets/soap/
4. Validate operational safety

Check:

  • timeout and retry handling
  • async strategy for trigger-originated work
  • logging / observability
  • event retention and subscriber implications
5. Hand off deployment or implementation details

Use:

  • sf-deploy for deployment
  • sf-apex for deeper service / retry code
  • sf-flow for declarative HTTP callout orchestration

High-Signal Rules

  • never hardcode credentials
  • do not do synchronous callouts from triggers
  • define timeout behavior explicitly
  • plan retries for transient failures
  • use middleware / event-driven patterns when outbound volume is high
  • prefer External Credentials architecture for new development when supported

Common anti-patterns:

  • sync trigger callouts
  • no retry or dead-letter strategy
  • no request/response logging
  • mixing auth setup responsibilities with runtime integration design

Output Format

When finishing, report in this order:

  1. Integration pattern chosen
  2. Auth model chosen
  3. Files created or updated
  4. Operational safeguards
  5. Deployment / testing next step

Suggested shape:

Integration: <summary>
Pattern: <named credential / external service / event / cdc / callout>
Files: <paths>
Safety: <timeouts, retries, async, logging>
Next step: <deploy, register, test, or implement>

Cross-Skill Integration

NeedDelegate toReason
OAuth app setupsf-connected-appsconsumer key / cert / app config
advanced callout service codesf-apexApex implementation
declarative HTTP callout / Flow wrappersf-flowFlow orchestration
deploy integration metadatasf-deployvalidation and rollout
use integration from Agentforcesf-ai-agentscriptagent action composition

Reference Map

Start here
Event-driven / platform patterns
CLI / automation / scoring

Score Guide

ScoreMeaning
108+strong production-ready integration design
90–107good design with some hardening left
72–89workable but needs architectural review
< 72unsafe / incomplete for deployment

Comments

Markdown supported