Sign inGet Started

llms.txt 与 Markdown 文档

本文档站的每个页面都有两种形式:你正在阅读的 HTML 和专为机器消费而构建的 Markdown。Agent 需要干净的、富含链接的文本来索引、检索或加载到上下文中。本页介绍三种机器可读形式及其相互关系。

语料库

  • /llms.txt,索引:产品、开发者指南、工具和机器可读参考的精选入口。它遵循 llms.txt 约定,体量足够小,可直接放入上下文。当代理按需检索页面时,以此为起点。
  • /llms-full.txt,英文指南导出:所有人工撰写的英文文档拼接为 Markdown。它不包含生成的 API 操作参考、生成的 SDK 参考以及导入的文档。当你的任务需要一组广泛的指南时使用它。
  • 逐页 Markdown 副本:每个页面也以原始 Markdown 形式提供,agent 无需加载整个语料库即可检索单个页面。
指南导出和 Markdown 副本与其 HTML 页面使用相同的已发布源。精选索引指向这些源。对于特定任务,使用公开 GET 端点搜索文档:将 q 替换为你的问题,然后获取匹配的 markdown_url。搜索返回页面和章节链接以及估算的页面 token 数。

Copy page 功能

你几乎不需要记住这些 URL。指南、API 参考、SDK 和知识库各部分的每个页面都带有 Copy page 菜单,可将机器可读形式直接交给你的工具:
  • Copy page as Markdown:当前页面的 Markdown 副本,可直接粘贴到聊天或上下文文件中。
  • 打开 llms-full.txt:适用于需要多份指南的任务的英文指南合集。
  • Copy MCP install command:一行命令,将托管的 MCP 服务器添加到客户端配置中,使正在阅读页面的 agent 也能连接执行操作所需的工具。
  • Connect to Cursor / Connect to VS Code:为两种常用的 agent 编辑器提供一键 MCP 设置。
仪表盘提供了同一思路的精简版本。在邮件引导页面上,Copy for AI 菜单会将当前代码示例复制为可直接粘贴的提示词,或直接在 Cursor、Claude 或 ChatGPT 中打开。

API 参考始终同步

API 参考部分由验证 API 的 OpenAPI 规范生成,其 Markdown 副本同样来自该规范。要查看操作签名和模式定义,请阅读生成的参考或公开 OpenAPI 规范。英文指南导出不包含生成的操作页面。从 API 参考介绍开始,了解参考的组织方式。

定价页面包含实时价格

定价页面及其 Markdown 副本在同一请求中使用相同的费率数据渲染。/email-api/pricing.md 返回电子邮件套餐和两个用量阶梯,/pricing/email.md 返回每个发送量的发送套餐表格,/pricing/sms.md 返回按目的地的费率卡,/pricing/voice/us.md 返回某目的地的每分钟通话费率,/pricing/sms/fees.md 返回运营商和 10DLC 费用。从 /pricing.md 开始:它列出每个发布费率的产品、其定价页面以及费率所在的 .md URL。来自计费目录的费率在你请求时实时获取,而非复制到文件中,因此副本不会引用页面已变更的价格。表格标注了发布的货币和计费单位。请使用定价来源提供的货币。

选择形式

你希望代理……提供……
发现可用内容并按需获取页面/llms.txt
一起阅读所有人工撰写的英文指南/llms-full.txt
精确理解某一个主题通过 Copy page 获取该页面的 Markdown
在阅读 Bird 的同时对其执行操作MCP 服务器;仅靠文档无法发送邮件
如需端到端的引导式设置来安装 MCP 服务器、连接编辑器并接入语料库,请参阅 AI 引导。

后续步骤

  • AI 引导:安装 MCP 服务器、连接编辑器并接入语料库。
  • MCP 服务器:让你的 agent 不仅能阅读 Bird 的文档,还能对其执行操作。
  • Agent 技能:预构建的工作流,帮助编程 agent 学习 Bird 接口。