Skip to main content

​
What is this?

Tools that let the assistant look up how to do something in the product documentation and answer from it. These tools belong to the Workspace MCP. Each tool below shows its Mode (Read runs immediately; Write asks your MCP client to confirm first) and the Permission needed for it to appear for your key — “None” means every connected key sees it.

​
What can I do here?

  • Search the documentation
  • Read a documentation page as Markdown

​
Tools

​
search_docs

Search the product documentation (how-to guides for every feature: channels, inbox, automation, AI agents, templates, campaigns, integrations, settings, API). Use it for any “how do I…”, “where is…”, “what does … mean” or setup question, then read the best page with read_doc before answering. Returns page paths, titles, short descriptions and links. Mode: Read · Permission needed: None

​
read_doc

Read one documentation page (from search_docs, or the current page’s docs path) as Markdown. Answer from it, and link the page with its url so the user can open the full guide. Mode: Read · Permission needed: None

​
Where it searches

search_docs and read_doc read this documentation site — the same guides you are reading now. They don’t search the web or your own data.
  • The assistant looks up the site’s llms.txt index (a list of every documentation page with its title and description) and searches the page titles, descriptions and text. It returns page paths, titles, short descriptions and links.
  • read_doc then fetches one page as Markdown, so the assistant can answer from it and link you to the full guide. Long pages are cut after about 9,000 characters with a link to the rest.
  • Each platform searches its own docs site — the address set as Documentation base URL in Platform Settings → General Setting. The tools request <that address>/llms.txt, which Mintlify generates automatically from the site’s navigation, so a page that isn’t in the navigation isn’t found. If no address is set, a generic default docs site is used instead — so set it.
  • The index is kept for about an hour (a stale copy is served for up to a day if the site is down), so new or changed pages can take a while to show up.
  • Who sees what: pages under the Workspace and API tabs are available to everyone. Platform and Self-Host pages are only returned to platform or instance staff.
  • Only pages listed in that index are ever fetched, so the assistant can’t be pointed at an arbitrary address.
If the docs site can’t be reached, the tools say so and the assistant answers from what it already knows.

​
Troubleshooting / Technical Notes

  • A tool I expect isn’t offered. The MCP server only offers tools whose required permission your API key’s owner holds, re-checked on every call. Grant the permission shown on the tool — see Team.
  • A Write tool never seems to run. Your MCP client asks you to approve every Write tool call. Check for a pending approval prompt.
  • A call returns an error. See MCP errors.
Last modified on October 29, 2026