AI 编码代理仅在其训练数据范围内工作,除非提供更有用的信息。本文档介绍了四种将当前 TinyMCE 文档呈现给代理的方法。它们是替代方案而非步骤,可以单独使用或组合使用。每种方法适用于任何 TinyMCE 安装,无论是通过 Tiny Cloud 托管还是自托管。

  • TinyMCE 文档 MCP 服务器 — 一个托管的 Model Context Protocol (MCP) 服务器,专门用于提供本套文档。适用于支持 MCP 的任何代理。

  • Context7 — 一个通用的文档 MCP 服务器,同时也索引了 TinyMCE 文档。适用于已经为其他库使用 Context7 的代理。

  • Markdown 页面 — 每篇文档页面都以 Markdown 格式发布在独立的 URL 上。适用于不支持 MCP 的代理,或已指定页面名称的提示。

  • llms.txt 文件 — 两份纯文本摘要,涵盖整个文档集,适用于接受单一批量引用的代理。

要将 TinyMCE 添加到使用 AI 编码代理的项目中,请参阅 Tiny Cloud AI 快速入门指南。

连接 TinyMCE 文档 MCP 服务器

TinyMCE 文档 MCP 服务器由 Tiny 托管,仅服务于本套文档。它提供对已发布页面的语义搜索功能,返回包含指向源链接的相关片段。任何支持通过流式 HTTP 进行 MCP 通信的客户端均可连接。

端点: https://tinymcedocs.mcp.kapa.ai

身份验证: 该服务器受 OAuth 保护,需要一次性登录。当代理首次调用服务器时,会打开一个浏览器窗口完成登录,随后代理将存储生成的令牌。如果未出现登录提示,请按照下方对应代理的条目描述,从代理自身的 MCP 配置中触发身份验证。

每个代理读取其自己的配置文件,这些文件不可互换。Claude Code 读取 .mcp.json 并期望存在 mcpServers 对象,而 Visual Studio Code 读取 .vscode/mcp.json 并期望存在 servers 对象。若向代理提供其他代理的文件或键名,不会报错且无法暴露来自服务器的工具。请展开下方与所用代理匹配的条目。

从文档站点安装

本套文档的每一页都包含一个Ask AI小部件。打开该小部件,并在模态框头部选择Use MCP以打开Connect to AI Tools菜单,其中提供复制剪贴板安装命令、支持编辑器的单点击安装以及原始服务器 URL。

下方条目描述了等效的手动配置。

按代理手动配置

下方每个代理均独立配置。请展开所用代理的条目。

Claude Code

如果未出现登录提示,请运行 /mcp,选择服务器,然后选择Authenticate。

claude mcp add --transport http --scope project tinymce-docs https://tinymcedocs.mcp.kapa.ai

若要手动配置服务器,请将其添加到 .mcp.json:

{
  "mcpServers": {
    "tinymce-docs": {
      "type": "http",
      "url": "https://tinymcedocs.mcp.kapa.ai"
    }
  }
}
Cursor

将服务器添加到 .cursor/mcp.json:

{
  "mcpServers": {
    "tinymce-docs": {
      "url": "https://tinymcedocs.mcp.kapa.ai"
    }
  }
}
Codex
codex mcp add tinymce-docs --url https://tinymcedocs.mcp.kapa.ai

若要手动配置服务器,请将其添加到 ~/.codex/config.toml:

[mcp_servers.tinymce-docs]
url = "https://tinymcedocs.mcp.kapa.ai"
startup_timeout_sec = 20
tool_timeout_sec = 60
enabled = true
Visual Studio Code

将服务器添加到 .vscode/mcp.json:

{
  "servers": {
    "tinymce-docs": {
      "type": "http",
      "url": "https://tinymcedocs.mcp.kapa.ai"
    }
  }
}
OpenCode

将服务器添加到 opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "tinymce-docs": {
      "type": "remote",
      "url": "https://tinymcedocs.mcp.kapa.ai",
      "enabled": true
    }
  }
}
其他代理

对于任何其他代理,请将其 MCP 客户端指向流式 HTTP 端点并完成上述登录。接受远程 MCP 服务器而无需专用配置文件的代理(如 Claude 和 ChatGPT)可以直接使用端点进行连接:

https://tinymcedocs.mcp.kapa.ai

连接 Context7

Context7 是一个通用的文档 MCP 服务器,它为包括 TinyMCE 在内的许多项目提供特定版本的库文档,且仅需单个服务器。若代理已为其他库使用 Context7,则可直接访问 TinyMCE 文档,而无需添加第二个服务器。

库: /tinymce/tinymce-docs,位于 context7.com/tinymce/tinymce-docs

按照 Context7 自身说明进行配置后,请在提示中引用 /tinymce/tinymce-docs 库,以便代理针对该库解析 TinyMCE 相关问题。

以 Markdown 格式阅读文档

代理可以在不使用 MCP 服务器的情况下高效地阅读文档。每篇文档页面均以 Markdown 格式发布,这比渲染后的 HTML 页面更节省 token。只需在任何文档页面 URL 后追加 index.md 即可获取该页面:

https://www.tiny.cloud/docs/tinymce/latest/basic-setup/index.md

Markdown 格式适用于 TinyMCE 的所有已记录版本,不仅限于最新版本。将 latest 替换为版本号段即可获取早期版本的 Markdown:

https://www.tiny.cloud/docs/tinymce/7/basic-setup/index.md

当前主版本始终通过 latest 提供服务。若按数字请求该版本(例如 /docs/tinymce/{productmajorversion}/basic-setup/index.md),将重定向至其 latest 地址。因此,按版本号获取 Markdown 的代理需要遵循重定向。早期版本则直接提供服务。

每篇页面标题旁还包含一个Copy Markdown按钮,可将当前页面的 Markdown URL 复制到剪贴板,以便粘贴到代理提示中。

反馈

如发现文档内容不准确或已过时,请在 tinymce-docs GitHub 仓库 中提交问题。当文档与实际运行情况相矛盾时,鼓励代理提交此类反馈。