Docs for AI Agents
Your AI agent can read the Buildpad docs directly. Use this when you want the agent to look up how a platform feature, a data service API or a UI component works, instead of guessing.
There are two ways to give an agent the docs:
- The docs MCP server: the agent searches the docs and reads the pages that it needs. This is the best choice for an AI IDE.
- Plain files:
llms.txt, one Markdown file per page, and one file with all pages. Use these for a tool that cannot connect to an MCP server.
Both cover all three Buildpad docs sites:
| Site | Docs | What it covers |
|---|---|---|
platform | app.buildpad.ai/docs | Organizations, projects, microapps, workers, connectors, AI IDE setup, specs, tutorials |
daas | docs.daas.buildpad.ai | The project data service (Buildpad Engine or Supabase): collections, the APIs, auth, roles and policies, the Studio, automation |
ui | ui.buildpad.ai/docs | The React component library, the CLI and the design system |
The Docs MCP Server
| URL | https://app.buildpad.ai/api/docs/mcp |
| Transport | Streamable HTTP |
| Authentication | None. The server gives only what the public docs sites show. |
| Server name | buildpad-docs |
The server is read-only. It has three tools:
| Tool | What it does |
|---|---|
search_docs | Finds the sections that match a query, in all sites or in one site (platform, daas or ui). Each result has a page id and a URL. It returns 5 results, or up to 10 with limit. |
get_doc_page | Returns the full Markdown of one page. Give a page id from a search result (for example daas:connect/items), a docs URL, or a path. |
list_doc_pages | Lists every page, grouped by site and section, with its id and description. Give a site to list one site only. |
The platform docs on the server change when the platform is deployed. The DaaS and UI docs update within an hour of their own sites. If a site cannot be reached, the results say that the site was not searched, and the other sites still answer.
Connect It to Your AI IDE
The starter projects (Claude Code, GitHub Copilot, Kiro, Antigravity) do not include the docs server. Add it to the MCP configuration of your IDE, next to the servers that the starter set up. It needs no token, so you can commit it.
Claude Code
From a terminal in your project:
claude mcp add --transport http buildpad-docs https://app.buildpad.ai/api/docs/mcpOr add it to .mcp.json:
{
"mcpServers": {
"buildpad-docs": {
"type": "http",
"url": "https://app.buildpad.ai/api/docs/mcp"
}
}
}Keep the other servers in the file. The examples show only the buildpad-docs entry.
Then ask the agent a question about Buildpad, for example:
Use the Buildpad docs to find out how a worker reads its RabbitMQ credentials.Plain Files
Each docs site publishes its pages as Markdown, built from the same pages as the site. Pages that the site hides are not included.
| File | Platform docs URL |
|---|---|
| An index of every page, grouped like the sidebar (llms.txt ) | https://app.buildpad.ai/docs/llms.txt |
| Every page in one Markdown file | https://app.buildpad.ai/docs/llms-full.txt |
One page as Markdown: add .md to the page path | https://app.buildpad.ai/docs/projects.md |
https://app.buildpad.ai/llms.txt and https://app.buildpad.ai/llms-full.txt give the same files.
The DaaS and UI docs sites have the same files at their own addresses, for example https://docs.daas.buildpad.ai/llms.txt.
llms-full.txt is large. For an agent with a small context window, give it llms.txt and let it open only the pages it needs.
Related
- Ask Buildpad: the assistant in the platform header answers questions from these docs.
- Claude Code, GitHub Copilot, Kiro and Antigravity: the starter projects and their MCP servers.