From 11b5fc6e4376b984f3b0b65bdaef0370cb67be88 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 14:16:15 +1000 Subject: [PATCH 1/7] TINYDOC-3568 - Add AI coding agents page for the documentation MCP server --- modules/ROOT/nav.adoc | 1 + modules/ROOT/pages/ai-coding-agents.adoc | 164 +++++++++++++++++++++++ modules/ROOT/pages/getting-started.adoc | 8 +- 3 files changed, 172 insertions(+), 1 deletion(-) create mode 100644 modules/ROOT/pages/ai-coding-agents.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 6b282b8536..ab6d562f94 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -75,6 +75,7 @@ **** Other Integrations ***** xref:bootstrap-zip.adoc[Bootstrap] ** xref:upgrading.adoc[Upgrading {productname}] +** xref:ai-coding-agents.adoc[AI coding agents] * xref:how-to-guides.adoc[How-to guides] ** Learn the basics *** xref:basic-setup.adoc[Basic setup] diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc new file mode 100644 index 0000000000..818d681a39 --- /dev/null +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -0,0 +1,164 @@ += Using {productname} with AI coding agents +:navtitle: AI coding agents +:description: Connect the {productname} documentation to AI coding agents using the hosted documentation MCP server, markdown pages, and llms.txt files. +:description_short: Connect the documentation to AI coding agents. +:keywords: ai, mcp, model context protocol, coding agent, claude code, cursor, codex, copilot, visual studio code, llms.txt, markdown + +AI coding agents produce better {productname} integrations when they read the current documentation instead of relying on training data. The {productname} documentation is published in three agent-readable forms: a hosted documentation MCP server for semantic search, a markdown version of every page, and `+llms.txt+` files that index the documentation set. + +[NOTE] +==== +This page describes how to give an AI coding agent access to the {productname} documentation. It does not describe the in-editor AI features. For content generation inside the editor, see xref:tinymceai-introduction.adoc[{productname} AI]. +==== + +[[connect-the-documentation-mcp-server]] +== Connect the documentation MCP server + +The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over HTTP can connect to it. + +*Endpoint:* `+https://tinymcedocs.mcp.kapa.ai+` + +*Authentication:* The server is protected by OAuth. On the first connection the agent opens a browser window to complete sign-in, then stores the resulting token. + +[[install-from-the-documentation-site]] +=== Install from the documentation site + +Every page of this documentation includes an *Ask AI* widget. Open the widget and select *Use MCP* in the modal header to open the *Connect to AI Tools* menu, which provides copy-to-clipboard install commands, one-click installs for supported editors, and the raw server URL. + +The remaining sections describe the equivalent manual configuration. + +[[claude-code]] +=== Claude Code + +[source,bash] +---- +claude mcp add --transport http --scope project tinymce-docs https://tinymcedocs.mcp.kapa.ai +---- + +To configure the server manually, add it to `+.mcp.json+`: + +[source,json] +---- +{ + "mcpServers": { + "tinymce-docs": { + "type": "http", + "url": "https://tinymcedocs.mcp.kapa.ai" + } + } +} +---- + +[[cursor]] +=== Cursor + +Add the server to `+.cursor/mcp.json+`: + +[source,json] +---- +{ + "mcpServers": { + "tinymce-docs": { + "url": "https://tinymcedocs.mcp.kapa.ai" + } + } +} +---- + +[[codex]] +=== Codex + +[source,bash] +---- +codex mcp add tinymce-docs --url https://tinymcedocs.mcp.kapa.ai +---- + +To configure the server manually, add it to `+~/.codex/config.toml+`: + +[source,toml] +---- +[mcp_servers.tinymce-docs] +url = "https://tinymcedocs.mcp.kapa.ai" +startup_timeout_sec = 20 +tool_timeout_sec = 60 +enabled = true +---- + +[[visual-studio-code]] +=== Visual Studio Code + +Add the server to `+.vscode/mcp.json+`: + +[source,json] +---- +{ + "servers": { + "tinymce-docs": { + "type": "http", + "url": "https://tinymcedocs.mcp.kapa.ai" + } + } +} +---- + +[[opencode]] +=== OpenCode + +Add the server to `+opencode.json+`: + +[source,json] +---- +{ + "$schema": "https://opencode.ai/config.json", + "mcp": { + "tinymce-docs": { + "type": "remote", + "url": "https://tinymcedocs.mcp.kapa.ai", + "enabled": true + } + } +} +---- + +[[other-agents]] +=== Other agents + +Agents that accept a remote MCP server without a dedicated configuration file — such as Claude and ChatGPT — can connect using the endpoint directly: + +[source,text] +---- +https://tinymcedocs.mcp.kapa.ai +---- + +[[read-the-documentation-as-markdown]] +== Read the documentation as markdown + +Every documentation page is also published as markdown, which is more token-efficient than the rendered HTML page. Append `+index.md+` to any documentation page URL to retrieve it: + +[source,text] +---- +https://www.tiny.cloud/docs/tinymce/latest/basic-setup/index.md +---- + +Each page also includes a *Copy Markdown* button next to the page title, which copies the markdown URL of the current page to the clipboard for pasting into an agent prompt. + +[[llms-txt-files]] +== llms.txt files + +Two plain text files summarize the documentation set for agents that accept a single bulk reference: + +[cols="1,3",options="header"] +|=== +|File |Contents + +|https://www.tiny.cloud/docs/llms.txt[`+llms.txt+`] +|A concise overview of {productname}, with key links and code examples. + +|https://www.tiny.cloud/docs/llms-full.txt[`+llms-full.txt+`] +|A full index of the documentation pages and their URLs. +|=== + +[[feedback]] +== Feedback + +Report inaccurate or outdated documentation by opening an issue in the https://github.com/tinymce/tinymce-docs/issues[`+tinymce-docs+`] repository. diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index d1b13094ef..0e1a614c9a 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -20,8 +20,14 @@ xref:installation.adoc[Installation] Learn how to install {productname} via {cloudname}, package managers, self-hosted zips for various integration options. +| +[.lead] +xref:ai-coding-agents.adoc[AI coding agents] + +Connect the {productname} documentation to AI coding agents using the documentation MCP server, markdown pages, and `+llms.txt+` files. + // Empty cell to even out rows -// | +| |=== From 18200841718e9031d4485f7e7730748012285b55 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 14:17:35 +1000 Subject: [PATCH 2/7] TINYDOC-3568 - Clarify MCP transport, authentication, and markdown version coverage --- modules/ROOT/pages/ai-coding-agents.adoc | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index 818d681a39..3fa7626fb7 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -14,11 +14,16 @@ This page describes how to give an AI coding agent access to the {productname} d [[connect-the-documentation-mcp-server]] == Connect the documentation MCP server -The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over HTTP can connect to it. +The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over streamable HTTP can connect to it. + +[NOTE] +==== +This server provides documentation to an external coding agent. It is not related to the MCP tool calling available to the {productname} AI service, which is described in xref:tinymceai-on-premises-mcp.adoc[MCP and web integrations]. +==== *Endpoint:* `+https://tinymcedocs.mcp.kapa.ai+` -*Authentication:* The server is protected by OAuth. On the first connection the agent opens a browser window to complete sign-in, then stores the resulting token. +*Authentication:* The server is protected by OAuth and requires a one-time sign-in. The first time the agent calls the server, a browser window opens to complete sign-in, after which the agent stores the resulting token. In Claude Code, if no sign-in prompt appears, run `+/mcp+`, select the server, and then select *Authenticate*. [[install-from-the-documentation-site]] === Install from the documentation site @@ -123,7 +128,7 @@ Add the server to `+opencode.json+`: [[other-agents]] === Other agents -Agents that accept a remote MCP server without a dedicated configuration file — such as Claude and ChatGPT — can connect using the endpoint directly: +For any other agent, point its MCP client at the streamable HTTP endpoint and complete the sign-in described above. Agents that accept a remote MCP server without a dedicated configuration file, such as Claude and ChatGPT, can connect using the endpoint directly: [source,text] ---- @@ -133,19 +138,26 @@ https://tinymcedocs.mcp.kapa.ai [[read-the-documentation-as-markdown]] == Read the documentation as markdown -Every documentation page is also published as markdown, which is more token-efficient than the rendered HTML page. Append `+index.md+` to any documentation page URL to retrieve it: +Agents can read the documentation efficiently without the MCP server. Every documentation page is also published as markdown, which is more token-efficient than the rendered HTML page. Append `+index.md+` to any documentation page URL to retrieve it: [source,text] ---- https://www.tiny.cloud/docs/tinymce/latest/basic-setup/index.md ---- +Markdown is available for every documented version of {productname}, not only the latest release. Replace `+latest+` with a version segment to retrieve the markdown for an earlier version: + +[source,text] +---- +https://www.tiny.cloud/docs/tinymce/7/basic-setup/index.md +---- + Each page also includes a *Copy Markdown* button next to the page title, which copies the markdown URL of the current page to the clipboard for pasting into an agent prompt. [[llms-txt-files]] == llms.txt files -Two plain text files summarize the documentation set for agents that accept a single bulk reference: +Two plain text files summarize the documentation set for agents that accept a single bulk reference. Both files index the latest release: [cols="1,3",options="header"] |=== From 50664f764d2ad0c191317449ffc1aee38ed7bafe Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 15:54:06 +1000 Subject: [PATCH 3/7] TINYDOC-3568 - Note that agent MCP configuration files are not interchangeable --- modules/ROOT/pages/ai-coding-agents.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index 3fa7626fb7..fe9d5084f2 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -25,6 +25,11 @@ This server provides documentation to an external coding agent. It is not relate *Authentication:* The server is protected by OAuth and requires a one-time sign-in. The first time the agent calls the server, a browser window opens to complete sign-in, after which the agent stores the resulting token. In Claude Code, if no sign-in prompt appears, run `+/mcp+`, select the server, and then select *Authenticate*. +[IMPORTANT] +==== +Each agent reads its own configuration file, and the files are not interchangeable. Claude Code reads `+.mcp.json+` and expects an `+mcpServers+` object, while Visual Studio Code reads `+.vscode/mcp.json+` and expects a `+servers+` object. An agent given another agent's file or key name reports no error and exposes no tools from the server. Use the section below that matches the agent in use. +==== + [[install-from-the-documentation-site]] === Install from the documentation site From 60e964ee3f3eb2455b899861589dbcd4c1683ef0 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 16:00:04 +1000 Subject: [PATCH 4/7] TINYDOC-3568 - Document the official TinyMCE agent skill --- modules/ROOT/pages/ai-coding-agents.adoc | 54 +++++++++++++++++++++--- 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index fe9d5084f2..680b05a838 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -1,20 +1,60 @@ = Using {productname} with AI coding agents :navtitle: AI coding agents -:description: Connect the {productname} documentation to AI coding agents using the hosted documentation MCP server, markdown pages, and llms.txt files. -:description_short: Connect the documentation to AI coding agents. -:keywords: ai, mcp, model context protocol, coding agent, claude code, cursor, codex, copilot, visual studio code, llms.txt, markdown +:description: Teach AI coding agents to integrate {productname} using the official skill, the documentation MCP server, markdown pages, and llms.txt files. +:description_short: Connect {productname} to AI coding agents. +:keywords: ai, skill, agent skills, mcp, model context protocol, coding agent, claude code, cursor, codex, copilot, visual studio code, llms.txt, markdown -AI coding agents produce better {productname} integrations when they read the current documentation instead of relying on training data. The {productname} documentation is published in three agent-readable forms: a hosted documentation MCP server for semantic search, a markdown version of every page, and `+llms.txt+` files that index the documentation set. +AI coding agents produce better {productname} integrations when they work from the current documentation instead of relying on training data. The official *{productname} skill* teaches an agent how to add {productname} to a project: it selects an installation method, wires up the editor, configures plugins and the toolbar, and sets the credential for the chosen distribution channel. Install it with one command: + +[source,bash] +---- +npx skills add tinymce/skills +---- [NOTE] ==== -This page describes how to give an AI coding agent access to the {productname} documentation. It does not describe the in-editor AI features. For content generation inside the editor, see xref:tinymceai-introduction.adoc[{productname} AI]. +This page covers agent skills that help integrate {productname} into an application. It does not describe the in-editor AI features. For content generation inside the editor, see xref:tinymceai-introduction.adoc[{productname} AI]. ==== +[[what-the-skill-does]] +== What the skill does + +The skill loads when an agent is asked to install, set up, configure, or troubleshoot {productname}. It will: + +* Choose an installation method — {cloudname}, a package manager, or a `+.zip+` package. +* Wire up the editor in vanilla JavaScript or an official React, Vue, Angular, Svelte, jQuery, web component, or Blazor wrapper. +* Configure plugins, the toolbar, the menu bar, and content styles. +* Set the API key or license key correctly for the chosen distribution channel. +* Send version-specific questions to the live documentation instead of guessing. + +The skill deliberately excludes authoring custom plugins, upgrading between major versions, and {productname} 4. For those tasks, see the xref:migration-guides.adoc[migration guides]. + +[[supported-agents]] +== Supported agents + +The skill uses the open https://agentskills.io/home[Agent Skills] format, so it works in any agent that supports it, including Claude Code, Cursor, Codex, OpenCode, GitHub Copilot, Windsurf, Gemini, Cline, AMP, and Zed. The installer detects the agents present in a project and writes the skill to each. + +[[other-ways-to-install]] +== Other ways to install + +[[claude-code-plugin-marketplace]] +=== Claude Code plugin marketplace + +[source,text] +---- +/plugin marketplace add tinymce/skills +/plugin install tinymce@tinymce +---- + +[[manual-installation]] +=== Manual installation + +Copy the `+skills/tinymce/+` directory from the https://github.com/tinymce/skills[`+tinymce/skills+`] repository into the agent's skills directory, for example `+.claude/skills/tinymce/+`. + [[connect-the-documentation-mcp-server]] == Connect the documentation MCP server -The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over streamable HTTP can connect to it. +The skill works on its own, but is more effective when the agent can also search the live documentation. The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over streamable HTTP can connect to it. [NOTE] ==== @@ -178,4 +218,6 @@ Two plain text files summarize the documentation set for agents that accept a si [[feedback]] == Feedback +Report guidance that is wrong, outdated, or missing from the skill by https://github.com/tinymce/skills/issues/new?template=skill-feedback.yml[opening an issue] in the https://github.com/tinymce/skills[`+tinymce/skills+`] repository, using the skill feedback template. Agents are encouraged to file these when the skill contradicts what actually worked. + Report inaccurate or outdated documentation by opening an issue in the https://github.com/tinymce/tinymce-docs/issues[`+tinymce-docs+`] repository. From e98332b8fcd009e027a943d2e5d6734696f54aea Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 16:06:23 +1000 Subject: [PATCH 5/7] TINYDOC-3568 - Tighten the introduction and expand MCP on first use --- modules/ROOT/pages/ai-coding-agents.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index 680b05a838..2dd7e0f66d 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -4,7 +4,7 @@ :description_short: Connect {productname} to AI coding agents. :keywords: ai, skill, agent skills, mcp, model context protocol, coding agent, claude code, cursor, codex, copilot, visual studio code, llms.txt, markdown -AI coding agents produce better {productname} integrations when they work from the current documentation instead of relying on training data. The official *{productname} skill* teaches an agent how to add {productname} to a project: it selects an installation method, wires up the editor, configures plugins and the toolbar, and sets the credential for the chosen distribution channel. Install it with one command: +The official *{productname} skill* teaches an AI coding agent how to add {productname} to a project: it selects an installation method, wires up the editor, configures plugins and the toolbar, loads the content styles, and sets the API key or license key. Install it with one command: [source,bash] ---- @@ -54,7 +54,7 @@ Copy the `+skills/tinymce/+` directory from the https://github.com/tinymce/skill [[connect-the-documentation-mcp-server]] == Connect the documentation MCP server -The skill works on its own, but is more effective when the agent can also search the live documentation. The hosted {productname} documentation MCP server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports the https://modelcontextprotocol.io/[Model Context Protocol] (MCP) over streamable HTTP can connect to it. +The skill works on its own, but is more effective when the agent can also search the live documentation. The hosted {productname} documentation https://modelcontextprotocol.io/[Model Context Protocol] (MCP) server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports MCP over streamable HTTP can connect to it. [NOTE] ==== From 1c682929e6b50108457fb86a495897c327cd52ca Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 16:20:43 +1000 Subject: [PATCH 6/7] TINYDOC-3568 - Fold the AI service MCP distinction into prose --- modules/ROOT/pages/ai-coding-agents.adoc | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index 2dd7e0f66d..ebee7ca2ac 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -54,12 +54,7 @@ Copy the `+skills/tinymce/+` directory from the https://github.com/tinymce/skill [[connect-the-documentation-mcp-server]] == Connect the documentation MCP server -The skill works on its own, but is more effective when the agent can also search the live documentation. The hosted {productname} documentation https://modelcontextprotocol.io/[Model Context Protocol] (MCP) server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports MCP over streamable HTTP can connect to it. - -[NOTE] -==== -This server provides documentation to an external coding agent. It is not related to the MCP tool calling available to the {productname} AI service, which is described in xref:tinymceai-on-premises-mcp.adoc[MCP and web integrations]. -==== +The skill works on its own, but is more effective when the agent can also search the live documentation. The hosted {productname} documentation https://modelcontextprotocol.io/[Model Context Protocol] (MCP) server exposes semantic search across the published documentation, returning relevant extracts with links to their source pages. Any client that supports MCP over streamable HTTP can connect to it. This server supplies documentation to an external coding agent, and is separate from the MCP tool calling available to the {productname} AI service, described in xref:tinymceai-on-premises-mcp.adoc[MCP and web integrations]. *Endpoint:* `+https://tinymcedocs.mcp.kapa.ai+` From 45d6e8f61234faea43508ca688c354d1c6fba559 Mon Sep 17 00:00:00 2001 From: Karl Kemister-Sheppard Date: Tue, 4 Aug 2026 16:28:56 +1000 Subject: [PATCH 7/7] TINYDOC-3568 - Rename the nav entry to Build with AI and move it below the introduction --- modules/ROOT/nav.adoc | 2 +- modules/ROOT/pages/ai-coding-agents.adoc | 2 +- modules/ROOT/pages/getting-started.adoc | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index ab6d562f94..b44520412c 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,5 +1,6 @@ * xref:getting-started.adoc[Getting started] ** xref:introduction-to-tinymce.adoc[Introduction to {productname}] +** xref:ai-coding-agents.adoc[Build with AI] ** xref:installation.adoc[Installation] *** xref:installation-cloud.adoc[Cloud] **** xref:cloud-quick-start.adoc[Quick start guide] @@ -75,7 +76,6 @@ **** Other Integrations ***** xref:bootstrap-zip.adoc[Bootstrap] ** xref:upgrading.adoc[Upgrading {productname}] -** xref:ai-coding-agents.adoc[AI coding agents] * xref:how-to-guides.adoc[How-to guides] ** Learn the basics *** xref:basic-setup.adoc[Basic setup] diff --git a/modules/ROOT/pages/ai-coding-agents.adoc b/modules/ROOT/pages/ai-coding-agents.adoc index ebee7ca2ac..b733f559df 100644 --- a/modules/ROOT/pages/ai-coding-agents.adoc +++ b/modules/ROOT/pages/ai-coding-agents.adoc @@ -1,5 +1,5 @@ = Using {productname} with AI coding agents -:navtitle: AI coding agents +:navtitle: Build with AI :description: Teach AI coding agents to integrate {productname} using the official skill, the documentation MCP server, markdown pages, and llms.txt files. :description_short: Connect {productname} to AI coding agents. :keywords: ai, skill, agent skills, mcp, model context protocol, coding agent, claude code, cursor, codex, copilot, visual studio code, llms.txt, markdown diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 0e1a614c9a..467e46f7c2 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -22,7 +22,7 @@ Learn how to install {productname} via {cloudname}, package managers, self-hoste | [.lead] -xref:ai-coding-agents.adoc[AI coding agents] +xref:ai-coding-agents.adoc[Build with AI] Connect the {productname} documentation to AI coding agents using the documentation MCP server, markdown pages, and `+llms.txt+` files.