Sf Documentation Knowledge

Collect, process, and serve Salesforce documentation for LLM agents — using Context Engineering + MCP, not RAG.

______________________________________________________________________

概述

该系统以编程方式收集 全部 Salesforce文档来自 developer.salesforce.com （129个域名，35000多页），将其处理成结构化、精心策划的知识文件，并通过以下方式将其提供给LLM代理：

1. 语境工程 --预编译的Markdown文件 _index.md 路由表
2. MCP服务器 --通过模型上下文协议提供12个工具+4个提示+5个资源
3. 知识图谱 --53000+节点和450000+边连接SF概念、命名空间、服务和交叉引用

没有嵌入。没有矢量存储。没有盲目的分块。

______________________________________________________________________

快速开始

克劳德桌面版

添加 ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "sf-docs": {
      "command": "npx",
      "args": ["-y", "-p", "@sfdxy/sf-documentation-knowledge", "sf-docs-mcp"],
      "env": {
        "SF_ACTIVE_DOMAINS": "apex-guide,apex-reference,lwc"
      }
    }
  }
}

移除 env 阻止搜索所有129个域。看 域限制 了解详情。

重新启动克劳德桌面。

VS代码（GitHub副本）

添加 .vscode/mcp.json 在您的工作区中（或全局在VS Code设置中）：

{
  "servers": {
    "sf-docs": {
      "command": "npx",
      "args": ["-y", "-p", "@sfdxy/sf-documentation-knowledge", "sf-docs-mcp"],
      "env": {
        "SF_ACTIVE_DOMAINS": "apex-guide,apex-reference,lwc"
      }
    }
  }
}

然后使用 @sf-docs 在Copilot Chat中查询Salesforce文档。

Gemini代码辅助/Gemini CLI

添加到MCP配置(~/.gemini/settings.json 或项目 .gemini/settings.json):

{
  "mcpServers": {
    "sf-docs": {
      "command": "npx",
      "args": ["-y", "-p", "@sfdxy/sf-documentation-knowledge", "sf-docs-mcp"],
      "env": {
        "SF_ACTIVE_DOMAINS": "apex-guide,apex-reference,lwc"
      }
    }
  }
}

光标

加入 Settings -> MCP Servers -> Add Server:

• 名称: sf-docs
• 命令: npx -y -p @sfdxy/sf-documentation-knowledge sf-docs-mcp
• 运输: stdio
• 环境: SF_ACTIVE_DOMAINS=apex-guide,apex-reference,lwc

帆板运动

添加 ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "sf-docs": {
      "command": "npx",
      "args": ["-y", "-p", "@sfdxy/sf-documentation-knowledge", "sf-docs-mcp"],
      "env": {
        "SF_ACTIVE_DOMAINS": "apex-guide,apex-reference,lwc"
      }
    }
  }
}

OpenCode

添加到您的OpenCode配置(~/.config/opencode/config.json 或项目 .opencode/config.json):

{
  "mcpServers": {
    "sf-docs": {
      "command": "npx",
      "args": ["-y", "-p", "@sfdxy/sf-documentation-knowledge", "sf-docs-mcp"],
      "env": {
        "SF_ACTIVE_DOMAINS": "apex-guide,apex-reference,lwc"
      }
    }
  }
}

任何MCP客户端（通用）

将您的MCP客户端指向：

npx -y -p @sfdxy/sf-documentation-knowledge sf-docs-mcp

服务器使用 标准 传输，并与任何MCP客户端兼容。

为什么 -p + sf-docs-mcp?\ 该软件包附带了两个二进制文件： sf-knowledge （数据管道CLI）和 sf-docs-mcp （MCP服务器）。使用 -p 安装包，然后显式调用 sf-docs-mcp 二进制文件，确保您获得的是MCP服务器而不是CLI。

从源头使用

git clone https://github.com/Avinava/sf-documentation-knowledge.git
cd sf-documentation-knowledge
npm install
npm run build
npm run mcp:start

______________________________________________________________________

MCP服务器

MCP服务器在启动时（约5秒）将完整的53k节点知识图和18000多个代码片段加载到内存中，并立即提供所有查询。

直接从源代码运行：

npm run mcp:start

或者通过npx（不需要克隆）：

npx -y -p @sfdxy/sf-documentation-knowledge sf-docs-mcp

工具（12）

提示模板（4）

资源（5）

客服可以在不调用工具的情况下阅读这些内容：

______________________________________________________________________

域限制

在处理特定的Salesforce产品领域（例如，Revenue Cloud、Apex开发）时，您可以将所有工具限制为仅在相关域内搜索。这降低了噪声并提高了结果质量。

运作原理

• 启动时：设置 SF_ACTIVE_DOMAINS 作为MCP客户端配置中以逗号分隔的域ID列表
• 在运行时：使用 sf_set_active_domains 在不重新启动的情况下更改活动域
• 未设置：搜索全部129个域（默认，无重大更改）
• 活动集外的每个呼叫域筛选器：返回带警告的空结果（不是错误）
• sf_read_topic位于活动集之外：显示温和的音符，但仍允许阅读

发现域名

# Let the AI suggest domains for your task
sf_suggest_domains("building LWC components with Apex backend")
→ Suggests: lwc, apex-guide, apex-reference, lightning

# Set the suggested domains
sf_set_active_domains(domains: ["lwc", "apex-guide", "apex-reference", "lightning"])

# Check current state
sf_set_active_domains()

# Clear restrictions
sf_set_active_domains(clear: true)

工具行为

所有129个域ID

看 docs/domains.md 按服务类别或用途组织的完整列表 sf_list_domains 在运行时。

______________________________________________________________________

知识库

存储库预装了 35000多个精选降价文件 和一个 知识图谱 （53000+节点，450000+边）覆盖 129个域名 Salesforce文档。

选项A：上下文工程（基于文件）

将您的AI代理指向 _index.md 任何域文件夹中的文件。索引充当路由表，告诉AI哪些文件包含哪些主题：

knowledge/current//_index.md

每个域文件夹也有一个 SKILL.md 在 skills//SKILL.md 它教人工智能代理如何导航知识。

选项B：知识图谱

图表位于 knowledge/current/graph.json 将所有文档与语义关系联系起来：

用以下方法检查：

npm run graph:stats

看 图形模式文档 对于具有节点/边类型、ID约定和可视化图表的完整模式。

______________________________________________________________________

数据管道

要使用最新的Salesforce版本更新知识库，请按以下顺序运行管道：

第一步：发现可用交付成果

npm run discover

列出Salesforce Index API中提供的所有文档可交付成果（约127个可交付成果）。

第二步：收集原始数据

# Collect a specific domain
npm run collect -- --domain cli-commands

# Collect all configured (P0) domains
npm run collect

# Collect ALL deliverables from the SF index API (121 domains, ~31k pages)
npm run collect -- --discover

步骤3：将HTML转换为Markdown

# Process a specific domain
npm run process -- --domain cli-commands

# Process ALL collected domains
npm run process -- --discover

自动清理HTML、去除噪声、解析表格、格式化代码块、创建干净的Markdown，以及 编辑 任何Salesforce令牌或秘密。

步骤4：生成知识文件和图表

# Generate ALL collected domains and rebuild the full Knowledge Graph
npm run generate -- --discover

构建知识图（交叉引用、名称空间、服务类别、doctype集群），生成上下文文件，并更新库存文档。

步骤5：检查图表

npm run graph:stats

完整管道（一个衬里）

npm run collect -- --discover && npm run process -- --discover && npm run generate -- --discover

______________________________________________________________________

CLI参考

支持所有管道命令 --domain 用于单域处理和 --discover 用于所有域处理。

______________________________________________________________________

CI/CD

______________________________________________________________________

文档

______________________________________________________________________

许可证

MIT© 阿维纳瓦

______________________________________________________________________

库存

*129个域名|35391个知识档案*

______________________________________________________________________

Built with Antigravity