AI 与机器可读文档
文档提供同源 Markdown、结构化索引和真实协议契约,供开发者与自动化工具使用。
获取 Markdown
每篇文章都有稳定原文路径,例如:
curl https://auth.kai.com/docs/authorization-code/index.md
curl -H 'Accept: text/markdown' https://auth.kai.com/docs/authorization-code
普通浏览器读取同一路径得到 SSR HTML。内容协商按媒体类型与 q 值选择,响应使用 Vary: Accept 区分表示形式;/index.md 始终返回 Markdown。React Router 的内部 .data 请求保持框架格式。
发现内容
/llms.txt与/docs/llms.txt提供标题、说明和每篇原文 URL。/llms-full.txt与/docs/llms-full.txt汇总当前全部正文。/sitemap.xml列出产品首页与文档页面;/robots.txt说明索引范围,不包含授权回调或个人控制台页面。- 页面有 canonical、原文链接和
Link响应头,HTML 与 Markdown 由同一份 Git 内容生成。
这些入口提供公开文档,不包含账号信息、授权码、secret 或真实令牌。抓取约定不是访问控制,私有页面仍必须由服务端鉴权。
协议与 API
读取根路径 OIDC Discovery、OAuth Discovery和 OpenAPI。OpenAPI 来自 KAI 自有 API 的 Effect Schema 生成产物;OAuth/OIDC 不应根据 OpenAPI 中的缺项臆造,应读取 Discovery 并使用相应协议。
本站没有发布 MCP server;不把普通文档链接包装成不存在的工具能力。
内容维护
正文位于仓库 apps/frontend/src/content/docs/,每篇使用 Markdown,配合服务端目录注册。增删文章时同步目录并运行文档契约测试,索引、原文和 HTML 一起变化。正文目前为简体中文,界面支持中文和英文。
这些做法参考 Cloudflare 的 AI consumability 指南及其 Agent Readiness 说明,并不要求文档必须托管于 Cloudflare,也不代表所有所谓 AI 标准已经成为统一行业协议。