AI 智能体机读接口指南 (For Agents)

本文档旨在介绍 docs.griptapenodes.com 面向 AI 编码智能体（AI Coding Agents）、MCP（Model Context Protocol）能力工具以及需要基于 Griptape Nodes 执行引擎真实 API 进行代码生成的自动化工具所开放的机器可读接口。

构建本站点的所有 Markdown 源文件均同步以“后处理纯 Markdown”格式对外分发。这意味着智能体可以直接通过 HTTP 请求抓取这些文件：其中所有的代码片段导入、宏展开以及 mkdocstrings 动态生成的 API 文档均已完成预编译展开，远比直接抓取 GitHub 上的 raw.githubusercontent.com 更加完整和精确。

开放的机读资源表面 (Surface)

/llms.txt：遵循 llms.txt 规范构建的高价值导航索引。它将最核心的文档（脚本编写、项目系统、自定义算子开发、MCP 集成与节点参考手册）按主题划分为各个区块，并附带简要描述与绝对 URL 地址；
/llms-full.txt：站点导航中所有页面拼接而成的完整单体 Markdown 文档。当你拥有足够充裕的长上下文窗口（Context Window），希望一次性将全量引擎文档全部注入模型时，请使用该文件；
独立的单页 Markdown：站点上的每一个 HTML 文档页面均在同级提供了纯 Markdown 版本。访问路径为在渲染后的 HTML URL 末尾追加 /index.md，例如：
- /development/custom_nodes/parameters/index.md
- /development/retained_mode/index.md 顶层页面位于 /<page>/index.md，嵌套页面的路径与渲染后的 URL 严格保持 1:1 镜像。

各类接口的最佳适用场景 (When to use which)

调用 /llms.txt：当你希望快速发现文档体系中包含哪些能力、而无需耗费大量 Token 拉取全文时使用。该索引极为精炼，其分类描述能帮助智能体精准定位目标主题位于哪一个页面；
调用 /llms-full.txt：当你需要一次性将整个引擎知识库作为 Grounding 事实基础灌入模型、且模型拥有超大上下文窗口时使用。其内容与各个单页 Markdown 拼接完全一致，并按照 llms.txt 中声明的模块顺序组织；
直接获取单页 .md：当你已明确知晓所需知识的具体页面时使用（例如正在编写自定义节点时仅需抓取参数规范 parameters/index.md，或编写自动化控制脚本时仅抓取 retained_mode.md）。

引擎知识引导的核心高价值文档推荐

若你需要为 AI 智能体指定极小集合的核心引导文档，以下五篇文档覆盖了引擎绝大多数的第一方核心 API 交互面：

版本与稳定性保证 (Stability)

机读文档接口通过现有的文档部署流水线严格紧跟 main 主分支。目前提供唯一的在线活跃接口；暂未针对旧版本发布带版本前缀的固定归档（如 /v0.40/llms.txt）；
文档集合受 mkdocs.yml 中的 llmstxt 插件配置驱动。新创建的文档页面不会自动编入 /llms.txt 或 /llms-full.txt，必须显式在配置文件对应的 section 区块中声明注册；nodes/ 下的各类具体算子参考文档则通过通配符 glob 自动批量收录。