mcpField
S
salla-docs

salla-docs

github.com/sallaapp开发297 次安装今天更新
代码仓库

关于 salla-docs

为 Salla 开发者提供按主题查找官方文档的技能，重点是定位范围明确的页面并读取其中的 OpenAPI 契约。它还说明如何验证当前规范、检查升级机会，以及在文档链接失效时重新定位页面。

主要功能

  1. 01按主题跳转至指定文档页面
  2. 02从内嵌 OpenAPI 读取请求与响应结构
  3. 03通过实时规范验证字段和类型
  4. 04对比当前规范与应用以检查升级
  5. 05链接失效时从完整索引重新定位
  6. 06按主题路由至相关 Salla 技能或工具

适用场景

  1. 01确认 API 端点的字段、类型和必填项
  2. 02根据实时规范验证 API 调用
  3. 03检查应用功能与当前 API 规范的差异
  4. 04定位 OAuth、Webhook、应用事件或主题文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/sallaapp/salla-partners-agent-kit --skill salla-docs

安装后在 Claude Code 中输入/salla-docs确认已加载。

附带文件references/docs-map.md

详细介绍

Salla 文档 — 查找正确的参考资料

应用开发只占 Salla 文档的一小部分（文档还涵盖 Merchant/Admin API、Twilight 主题和店面）。请直接前往范围明确的页面，并按以下顺序操作：

1. 优先使用领域技能

每项 Salla 技能都包含自己的深层链接和经过验证的差异。如果某项技能涵盖了相关主题，请按技能中的指引操作，而不是查阅文档（salla-app-expert 会根据意图进行路由）。只有在技能无法解答时，才查看这里。

2. API 结构 → 范围明确的文档页面（内嵌 OpenAPI 架构）

若要查看端点的准确请求／响应，或事件的负载架构，请打开 docs.salla.dev 上范围明确的页面（见下表），在相应主题页面中找到端点或事件，并将已发布的架构作为字段名称和类型的权威依据。

许多端点页面都在 ```yaml 代码块中嵌入了完整的 OpenAPI 3.x 规范，包含顶层的 openapi, info, servers, paths, components, securitySchemes, security，以及请求／响应架构、字段类型、枚举值和必填字段。若要获取端点的准确契约，请打开其 https://docs.salla.dev/<id>.md 页面，并阅读 openapi: YAML 代码块——该代码块是权威依据（例如，https://docs.salla.dev/5394153e0.md = POST /orders/options）。若要据此构建并验证调用，请遵循 salla-api-core 中的闭环流程。

当前参考资料工作流（验证与升级检查）

若要将行为与实时规范对应起来：在 references/docs-map.md 中查找资源 → 获取实时的 https://docs.salla.dev/<id>.md → 阅读其中内嵌的 OpenAPI 代码块。请将其用于：

  • 验证 — 根据实时架构（字段名称、类型、枚举值、必填项）构建／验证；闭环流程见 salla-api-core。
  • 升级检查 — 对比当前规范提供的内容与应用正在使用的内容，然后指出可用的升级选项。
  • 新鲜度保障 — 始终获取实时内容，绝不使用缓存的结构；若出现 404，说明句柄编号已更改，请按第 3／4 步重新定位页面。

3. 主题 → 范围明确的文档入口

请打开范围明确的页面，而非索引。下方的数字 URL 是稳定句柄，但可能会重新编号或移动——请确认页面仍为当前版本；若某个链接返回 404，请按第 4 步从完整索引中重新定位，然后只阅读该页面。

主题入口
OAuth 2.0（Easy 和 Custom 模式）https://docs.salla.dev/421118m0.md
Webhooks 指南 + 事件列表https://docs.salla.dev/421119m0.md
应用事件（生命周期）https://docs.salla.dev/421413m0.md
App Functions — 概览https://docs.salla.dev/1726814m0.md
App Functions — 支持的事件https://docs.salla.dev/1726818m0.md
店面事件（代码片段）https://docs.salla.dev/1724504m0.md
Communication App 负载https://docs.salla.dev/1380572m0.md
嵌入式 SDK 模块https://docs.salla.dev/embedded-sdk/overview.md
Merchant/Admin API 参考https://docs.salla.dev/421117m0.md
应用设置表单（指南）salla-app-settings 技能
React 主题（Twilight 引擎）salla_themes_docs 工具，或 https://docs.salla.dev/twilight/react/llms.txt

4. 最后手段：从完整索引中定位页面

  • https://docs.salla.dev/llms.txt 是完整的 LLM 索引，其中大部分内容（商店 API 资源、主题/Twilight 文档）与应用开发无关。只有当上方的页面句柄返回 404 时，才使用它来_定位_所需页面，然后仅阅读该页面。
  • 商家 API 参考包含数百个端点；只打开你需要的资源（salla-api-core 介绍了调用约定）。
  • React 主题（Twilight 引擎）内部文档——路由、钩子、组件、插槽、商店 API 客户端、Salla CLI——位于单独的文档集中。使用 salla_themes_docs 工具（action=search，然后 action=read；使用 action=list 查看索引），或阅读范围限定的索引 https://docs.salla.dev/twilight/react/llms.txt，然后将单个页面作为 Markdown 阅读 （<page>.md）。切勿加载 llms-full.txt。
  • 对于店面片段 UI 或 原生店面 UI 合规性，请转到 salla-snippets 或 salla-storefront-ui。

社区与升级求助

渠道链接
合作伙伴门户https://portal.salla.partners
开发者博客https://salla.dev/blog/
开发者社区（Telegram）https://t.me/salladev

评论

支持 Markdown