跳转到内容

向 AI 提供哪些内容

查看 Markdown

Sudomimus 以多种机器可读形式发布文档。喂哪一个给助手,取决于你能腾出多少上下文窗口,以及你要的是散文式说明还是正式的 API 契约。

三个纯文本端点遵循 llmstxt.org 约定:

URL它是什么
https://docs.sudomimus.com/llms.txt索引 —— 一份简短清单,链接到下面两份语料。适合那种「按需抓取页面」而非一次性全抓的助手。
https://docs.sudomimus.com/llms-full.txt完整语料 —— 所有英文文档页拼接成的单个文件。
https://docs.sudomimus.com/llms-small.txt精简语料 —— 同一套英文文档,但裁掉了最重的参考材料。

这三份聚合语料只包含英文内容。如需让助手读取中文文档,请提供对应 /zh-cn/ 页面追加 .md 后的链接。

两份语料覆盖的范围相同 —— 平台共享概念、彼此独立的 Connect/OIDC/原生流程,以及三层规则模型。区别只在深度:

  • llms-full.txt 包含一切,连那些超长的逐方法、逐 payload 参考表(每个 OAuth 提供商、每种规则方法、每个边界情况)都在内。它的体量大约是精简版的三倍。当你的助手上下文窗口够大、又想要一次性完成完整集成时,用它。
  • llms-small.txt 砍掉了那些详尽的表格和边角说明,保留概念模型与核心流程。当上下文紧张、或你想让助手先快速把握模型、细节再单独指页给它时,用它。

拿不准就先用 llms-full.txt—— 大多数现代助手都能轻松装下。

在任意文档页 URL 后面追加 .md,即可只抓取这一页的原始 Markdown —— 例如 /zh-cn/connect/three-key-model.md。这是「只给助手一页、而非整套语料」的精确做法。

要拿到 Sudomimus 产品 API 的正式请求/响应契约,把助手指向 OpenAPI 3.1 参考,它直接由已发布的规范生成:

  • Connect API —— Inquiry 端点(/establish/status-poll/redeem/info),每个 operation 都有独立页面。
  • Session API —— 普通应用会话端点(/refresh/introspect/logout/revoke-all)。
  • Native API —— 面向原生客户端的 direct-issue 端点(/direct-issue/steam-ticket/direct-issue/access-key)。
  • Device API —— 面向公开客户端的 device authorization 端点(/device-authorize/device-token)。

这些页面是精确路径、参数、请求体与状态码的真实来源 —— 当你要的是强类型客户端代码、而非从散文推断出来的猜测时,把它们喂给助手。

OIDC 使用自身原生的机器可读契约,不重复提供 OpenAPI schema。请向助手提供 issuer https://oidc.sudomimus.com,让它使用 OIDC 库读取 discovery,并附上 OIDC 接入指南以确认 Sudomimus 支持的 profile 与平台约束。 底层协议语义仍由 OpenID Connect 和 OAuth 标准定义。

llms*.txt 端点和 OpenAPI 参考都会随文档每次更新一起重建 —— 没有滞后的「AI 版本」。如果助手缓存了旧版本,让它重新抓一次即可。