Docs MCP server
Connect Cursor, Claude, ChatGPT, Codex, and other AI agents to StoreOS documentation over the Model Context Protocol.
StoreOS docs expose a public MCP server so agents can list pages, search, and fetch Markdown without scraping HTML. No API key is required. The server is https://mcp.storeos.dev/docs. On this site it is also https://storeos.dev/api/mcp/docs.
Connect agents
One-click install where the host supports it. Otherwise Install copies the config or command for that agent.
Claude
Claude Code
Codex
ChatGPT
Cursor
VS Code
Gemini CLI
URL
https://mcp.storeos.dev/docs
Public Streamable HTTP · no API key · list_pages, search, get_page
Cursor
Install opens Cursor’s MCP deeplink. Or add to .cursor/mcp.json:
{
"mcpServers": {
"storeos-docs": {
"url": "https://mcp.storeos.dev/docs"
}
}
}$ search "API keys gateway" → /docs/guides/api-keys $ get_page url=/docs/guides/api-keys → # API keys & gateway …
Tools
| Tool | What it does |
|---|---|
list_pages | Index of docs pages (same shape as llms.txt) |
search | Full-text search across docs |
get_page | Markdown for a page by its pathname (for example /docs/guides/api-keys) |
How agents should use the tools
| Goal | Do this |
|---|---|
| Orient in the docs | list_pages once, then pick paths |
| “Where is X documented?” | search with 2–6 keywords |
| Implement against a guide | get_page with the pathname from search |
| Stay accurate | Prefer MCP Markdown over model memory for StoreOS APIs |
| Touch live store data | Use an API key + SDK — not MCP |
Suggested starter prompt (any host):
Use the storeos-docs MCP. Search StoreOS docs before answering.
For API or SDK questions, get_page the matching guide and follow its examples.Prompt recipes for a Fluid theme, a custom storefront, and a custom admin dashboard: AI-driven development.
Related surfaces
| Surface | URL | Use when |
|---|---|---|
| MCP tools | https://mcp.storeos.dev/docs | Agents that speak MCP |
| MCP health | https://mcp.storeos.dev/docs/health | Uptime checks. GET returns { "ok": true } and does not start a session |
| Docs Markdown index | /docs/llm.txt | Simple crawlers / context packs |
| Per-page Markdown | /docs/….md | Fetch one page as Markdown |
Site llms.txt | /llms.txt | Product + docs overview for LLMs |
Build a custom admin dashboard
High-level guidelines for building a merchant admin app like the StoreOS console — overview, orders, inventory, stock, staff, customers, and more on the public API gateway.
StoreOS plugins
How StoreOS plugins work — couriers, payments, notifications, analytics, support, and SEO integrations attached to a tenant.