Typemark Documentation

Agent-ready docs

Every Typemark site serves Markdown, llms.txt, and an MCP server, so AI tools can read your docs as well as people can.

Updated Nov 19, 20263 min read

Your readers increasingly ask an AI assistant before they open your docs. Every Typemark site is set up for that, on every plan, with nothing to configure: each page has a Markdown version, the site has llms.txt and llms-full.txt, and an MCP server lets coding tools search and read your docs directly.

Private docs are the exception: AI tools can't sign in, so a password-protected site has no MCP server, and its Markdown and llms.txt need the password like everything else.

The examples below use https://docs.acme.com. Swap in your site's address: your custom domain, or {slug}.typemark.dev.

Markdown version of every page

Add .md to any page URL to get it as Markdown:

curl https://docs.acme.com/guides/authentication.md

You get the page title as a heading, the description as a quote, and the page body without frontmatter. Components such as <Callout> stay as they are, and links point to full URLs on your site.

Tools that send Accept: text/markdown get Markdown from the normal page URL. Each HTML page also points to its Markdown version with a Link header.

llms.txt and llms-full.txt

FileWhat's in it
/llms.txtYour site name and summary, then a list of every page with a link to its Markdown version and its description. Follows the llms.txt format.
/llms-full.txtEvery page's Markdown in one file, in navigation order.

The summary line comes from seo.default_description in typemark.json. Pages with hidden: true in their frontmatter are left out of both files.

These files can be cached for up to an hour, so a change may take that long to show up.

MCP server

Every site has a read-only MCP server at /mcp. Add it to an AI tool and the tool can search and read your docs while it works. No sign-in or API key is needed.

https://docs.acme.com/mcp

It has three tools:

ToolWhat it does
search_docsSearches your docs and returns up to 10 matching pages with a snippet each
get_pageReturns a page as Markdown, by path or URL
list_pagesLists every page in navigation order, with its path and description

Connect your tools

Add this to ~/.cursor/mcp.json, or .cursor/mcp.json in a project:

{
  "mcpServers": {
    "acme-docs": {
      "url": "https://docs.acme.com/mcp"
    }
  }
}

Add this to .vscode/mcp.json in your workspace:

{
  "servers": {
    "acme-docs": {
      "type": "http",
      "url": "https://docs.acme.com/mcp"
    }
  }
}

Run this in your terminal:

claude mcp add --transport http acme-docs https://docs.acme.com/mcp

In Claude, open Customize > Connectors, choose Add custom connector, and paste the server URL.

Readers don't need to write this config themselves. Connect to Cursor / VS Code / Claude in the page actions menu shows these snippets with your site's URL filled in.

Limits

Each IP address can make 60 MCP requests a minute, and each site serves up to 600 a minute.

Page actions

Every published page has a Copy page button next to its title, with a menu of AI actions:

ActionWhat it does
Copy pageCopies the page as Markdown, ready to paste into a chat
View as MarkdownOpens the page's .md version
Open in ChatGPTStarts a ChatGPT chat that reads the page
Open in ClaudeStarts a Claude chat that reads the page
Connect to Cursor / VS Code / ClaudeShows the MCP setup for your site

A Use these docs with AI card under the table of contents offers Connect via MCP and Copy llms.txt link.

Page actions are on by default. To hide the button, the menu, and the card, turn off Page actions in Settings > Reader features, or set this in typemark.json:

"features": {
  "page_actions": false
}

Turning page actions off only hides them from readers. The Markdown pages, llms.txt, and MCP server stay available.

What agents see

AI tools get exactly what readers get:

  • Published content only. In manual deploy mode, unpublished edits stay out of Markdown pages, llms.txt, and MCP.
  • Nothing while offline. If your site is offline, these surfaces don't serve your content.
  • Hidden pages stay unlisted. Pages with hidden: true are left out of llms.txt, llms-full.txt, and the MCP server's search and page list. Their Markdown version is marked noindex.
  • The default language. On a site in several languages, llms.txt, llms-full.txt, and the MCP server serve the default language.
  • No previews. Preview deployments and branch previews have no Markdown pages, llms.txt, or MCP server.