agentleFS
jiten-singh-shahijiten-singh-shahi/salesforce-claude-code/.cursor/skills/sf-docs-lookup/SKILL.md

sf-docs-lookup

Skill15 starsChanged 7 months agoMITView on GitHub

Use when looking up official Salesforce documentation. Apex reference, LWC docs, platform guides, API references, and SF CLI commands via WebSearch.

The file

We split this skill into the rules it gives an agent

10 rules. About 0 are common, 9 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When you need to look up Apex class, method, or interface documentation

    line 13
  2. Distinctive:

    When checking LWC component API, wire service, or lifecycle documentation

    line 14
  3. Distinctive:

    When verifying SOQL/SOSL syntax, functions, or query limits

    line 15
  4. Distinctive:

    When researching REST API, Metadata API, Tooling API, or Bulk API endpoints

    line 16
  5. Distinctive:

    When looking up governor limits, security features, or platform event details

    line 17
  6. Very specific:

    When checking sf CLI command flags and usage

    line 18
  7. Distinctive:

    When verifying whether a feature is deprecated or version-gated

    line 19
  8. Distinctive:

    Use WebSearch with targeted site-scoped queries:

    line 52
  9. Distinctive:

    When presenting documentation results:

    line 66
  10. Distinctive:

    After finding the official docs, check if SCC has relevant skills:

    line 76

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Salesforce Documentation Lookup

Query Salesforce developer documentation for current, accurate answers. Uses WebSearch to find official documentation, then extracts and summarizes the relevant content.

When to Use

  • When you need to look up Apex class, method, or interface documentation
  • When checking LWC component API, wire service, or lifecycle documentation
  • When verifying SOQL/SOSL syntax, functions, or query limits
  • When researching REST API, Metadata API, Tooling API, or Bulk API endpoints
  • When looking up governor limits, security features, or platform event details
  • When checking sf CLI command flags and usage
  • When verifying whether a feature is deprecated or version-gated

Usage

sf-docs-lookup <query>

Workflow

Step 1 — Identify Topic Category

Classify the query into the correct Salesforce documentation area:

CategoryDocumentation SourceSearch Strategy
Apex Classes/InterfacesApex Developer Guidesite:developer.salesforce.com apex <class>
Apex System MethodsApex Referencesite:developer.salesforce.com "System.<method>"
LWC ComponentsLWC Dev Guidesite:developer.salesforce.com lwc <topic>
SOQL/SOSLSOQL and SOSL Referencesite:developer.salesforce.com soql <topic>
REST APIREST API Developer Guidesite:developer.salesforce.com rest api <endpoint>
Metadata APIMetadata API Developer Guidesite:developer.salesforce.com metadata api <type>
Tooling APITooling API Referencesite:developer.salesforce.com tooling api <resource>
Bulk APIBulk API 2.0 Developer Guidesite:developer.salesforce.com bulk api <topic>
Platform EventsPlatform Events Developer Guidesite:developer.salesforce.com platform events <topic>
FlowsFlow Builder Guidesite:help.salesforce.com flow <topic>
AgentforceEinstein/Agentforce Docssite:developer.salesforce.com agentforce <topic>
Governor LimitsApex Developer Guidesite:developer.salesforce.com "execution governors" limits
SecuritySecurity Implementation Guidesite:developer.salesforce.com security <topic>
CLI (sf)Salesforce CLI Referencesite:developer.salesforce.com sf <command>

Step 2 — Search Documentation

Use WebSearch with targeted site-scoped queries:

site:developer.salesforce.com <category-specific terms>

For admin/configuration topics, also check:

site:help.salesforce.com <topic>

Step 3 — Extract and Format Answer

When presenting documentation results:

  1. Lead with the answer -- do not make the user read through preamble
  2. Include code examples -- Apex, LWC, or SOQL snippets when relevant
  3. Note API version -- Salesforce features are version-gated; specify the minimum API version
  4. Link to source -- provide the URL so the user can read more
  5. Flag deprecations -- if the queried feature is deprecated, say so and recommend the replacement

Step 4 — Cross-Reference with SCC Knowledge

After finding the official docs, check if SCC has relevant skills:

  • Skills in skills/ or skills2/ that cover the topic in depth
  • Mention relevant SCC resources: "For best practices on this, see the sf-soql-optimization skill."

Complex Documentation Queries

For complex documentation queries spanning multiple topics, delegate to the deep-researcher agent which can perform multi-step research across documentation sources.

Examples

sf-docs-lookup Wire service in LWC
sf-docs-lookup Database.Batchable interface
sf-docs-lookup Platform Events best practices
sf-docs-lookup SOQL aggregate functions
sf-docs-lookup WITH USER_MODE vs WITH SECURITY_ENFORCED
sf-docs-lookup sf project deploy start flags
sf-docs-lookup Trigger.operationType enum values

Related

  • Agent: sf-docs-lookup -- for multi-step documentation research
  • Constraints: (none -- this is a search tool, no domain constraints apply)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.