> ## Documentation Index > Fetch the complete documentation index at: https://docs.byom.co/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the current public BYOM documentation and cite the relevant page. Preserve availability, permission and undo limits. > The public documentation MCP retrieves guides. Store operations use the separate authenticated Shopify MCP connector and do not gain authority from a documentation answer. > If a contract, capability or price is not documented, say so. Do not invent endpoints, tools, availability or merchant outcomes. # Connect to the documentation MCP > Give your AI assistant access to the BYOM documentation, with source links and a clear separation from your store. Connect your AI assistant to the BYOM documentation so it can find a workflow, check a developer contract and link you to the source. The documentation MCP reads the public guides on this site through Mintlify's hosted service. It has no access to company or store records and cannot approve Actions. The public server is available at **`https://docs.byom.co/mcp`**. It was checked on 2 October 2026 with a real remote HTTP MCP client: connection, tool discovery, retrieval across all 29 published articles and source-linked searches passed. Use the articles directly if your client cannot connect, and cite the current page when applying an answer. ## Choose the right MCP | You want to… | Use | | - | - | | Understand BYOM, a workflow, a supported contract or a limitation | This **public documentation MCP** | | Read permitted Shopify information or prepare an operation for a store | The **authenticated [Shopify connector](/developers/mcp)**, with the merchant's consent | The documentation MCP needs no store credentials. Never paste Shopify tokens, BYOM credentials or customer records into a documentation search or feedback tool. Access to public docs does not grant access to the product. ## Connect your assistant Add a remote HTTP MCP server in your client's connector or MCP settings: ```text theme={"dark"} https://docs.byom.co/mcp ``` Use a client that supports remote MCP over HTTP. The client performs the MCP initialisation handshake and discovers the tools with `tools/list`. Tool names are supplied by the server; discover them instead of hard-coding a name from another Mintlify site. Mintlify supports hosted-server discovery at [`/.well-known/mcp`](https://docs.byom.co/.well-known/mcp). Mintlify provides a JSON alias at `/.well-known/mcp.json` and tool descriptions through `/.well-known/mcp/server-card.json`. These routes are available. The platform may advertise an equivalent hosted alias; use **`https://docs.byom.co/mcp`** when configuring BYOM directly. A discovery card alone does not prove that your particular client has connected successfully. The server provides documentation search and a read-only virtual documentation filesystem. The filesystem is the public article corpus, not BYOM's server or your computer. A separate feedback tool can submit a documentation-quality report; it does not perform a store operation. Read each discovered tool's description before using it. ## Use your preferred client The **More actions** menu beside **Copy page** offers two different kinds of handoff. **Open in ChatGPT**, **Open in Claude** and **Open in Perplexity** provide context about the current page. **Connect to Cursor** and **Connect to VS Code** prepare the remote documentation MCP connection, which can retrieve across the public corpus. Review the connection your client proposes before adding it. | Client | Whole-documentation connection | | - | - | | Claude | Add the server URL as a custom remote connector where your account or workspace allows it. Claude Code also supports remote MCP servers. | | ChatGPT | Use a custom MCP app where developer mode and your workspace policy allow it. The page-handoff button alone does not install the connector. | | Codex | Add a remote HTTP MCP server using the command below, then check that tools are available in your session. | | Cursor | Use **Connect to Cursor**, or add the server URL in its MCP settings. | | VS Code with GitHub Copilot | Use **Connect to VS Code**, or add an HTTP server to the supported MCP configuration. Organisation policies may restrict installation. | | Gemini CLI | Configure a remote MCP server with `httpUrl` set to the URL above. Gemini's CLI configuration is separate from a browser page handoff. | For a current Codex CLI, the registration command is: ```bash theme={"dark"} codex mcp add byom-docs --url https://docs.byom.co/mcp ``` This command changes your local client configuration. It does not log in to BYOM, connect a store or verify that the remote server is healthy. After adding the server, ask a question from the examples below and check the returned source. Client features and account permissions vary; an unsupported client can still use **Copy page** or the article's Markdown version. For current client-specific controls, see the official guides for [Claude connectors](https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp), [Claude Code](https://code.claude.com/docs/en/mcp), [ChatGPT MCP apps](https://help.openai.com/en/articles/12584461-developer-mode-and-mcp-apps-in-chatgpt), [Cursor](https://prod.cursor.com/help/customization/mcp), [VS Code](https://code.visualstudio.com/docs/agent-customization/mcp-servers) and [Gemini CLI](https://geminicli.com/docs/tools/mcp-server/). ## Read without a connector Copy an individual page as Markdown, or append `.md` to its article URL. The hosted site also provides a documentation index at `/llms.txt` and a full-text export at `/llms-full.txt`. The public `/skill.md` explains the main workflows and the boundaries an assistant should preserve. These are public reading formats; they do not require access to your merchant account. ## Ask questions that lead to useful sources For example: * “How does BYOM separate approval from execution? Link to the relevant guide.” * “Which MCP transport does the Shopify connector support, and what does a 202 notification mean?” * “What should I check when a tool is missing from my connector?” * “When can an operation be undone? Include the limits.” * “How do HQ and Workspace differ?” Ask your assistant to cite the pages it used and preserve the limitations in those pages. For implementation work, read the linked contract and confirm the current tools and permissions in your enabled account. A documentation answer is not evidence that a feature is enabled for a particular company. ## What is included The public corpus covers the product, task guides, developer documentation, trust, availability and documentation updates. Private product source, internal plans and account-specific data are excluded. The public documentation is the source of truth for this server; it does not inspect BYOM's private repositories. ## If an answer or connection is missing Check the server URL and your client's remote-HTTP support first. If a recent page is absent from search, open the page directly and use its **Copy page** menu; search indexing may lag a documentation update. Do not repeatedly retry an unchanged failure. Report the page URL and a non-sensitive description to [hello@byom.co](mailto:hello@byom.co). If the docs do not answer your question, ask the assistant to say what is missing. Confirm an undocumented endpoint, permission or availability claim with BYOM before relying on it. Reviewed 2 October 2026. ## Related guides * [Developer overview](/developers/overview) * [Shopify MCP connector](/developers/mcp) * [Authentication and consent](/developers/authentication) * [Availability](/reference/availability) ## Related topics - [Developer overview](/developers/overview.md) - [MCP connector](/developers/mcp.md) - [Documentation updates](/changelog.md) - [Billing and usage](/reference/billing.md) - [Authentication and consent](/developers/authentication.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.