Skip to main content
AI tools can help you search BEEQ documentation, compare implementation options, and generate code with current docs as context. Treat the output as a starting point: review it against the component page, source code, accessibility requirements, and your product needs before shipping.

​
What BEEQ exposes to AI tools

BEEQ documentation is built with Mintlify, so the published site can expose AI-friendly entry points that agents and assistants know how to read.
ResourcePathUse it for
MCP server/mcpLet MCP-compatible tools search the published documentation.
llms.txt/llms.txt or /.well-known/llms.txtGive AI tools a structured index of available documentation pages.
llms-full.txt/llms-full.txt or /.well-known/llms-full.txtGive AI tools the full public documentation content in one file.
skill.md/skill.mdDescribe what agents can do with BEEQ and which docs or workflows they should use.
Markdown pagesPage URL with .md when supported by the docs hostLet tools read a specific page as Markdown instead of rendered HTML.
skill.md can be generated by Mintlify from the documentation or replaced later with custom skill files. Use it as agent guidance, not as a replacement for the source code or component API reference.

​
Connect an AI tool

Use the contextual menu on any documentation page to copy AI-friendly resources or connect the docs to supported tools. The menu can expose options for copying page context, opening the page in ChatGPT or Claude, copying the MCP server URL, and connecting the MCP server to Cursor or VS Code. If your tool asks for an MCP server URL, use the published documentation domain with /mcp: 
https://www.beeq.design/mcp
After connecting the MCP server, ask your tool what documentation sources it can access. A healthy connection should expose BEEQ documentation search, and may also expose skill.md resources when the published site supports them.
Use the page actions menu at the top of any documentation page to copy the page as Markdown, open the page in ChatGPT or Claude, copy the MCP server URL, or connect the docs MCP server to Cursor and VS Code.

​
Where AI helps

Ask which BEEQ component fits a task, how to combine slots and props, or which component handles a specific interaction pattern. Link the relevant component page when you already know the component.
Ask for setup steps for Angular, React, Next.js, Vue, or HTML/Web Components. Include your framework and build tool so the answer follows the right integration guide.
Ask for BEEQ token names, CSS custom properties, Tailwind preset utilities, or theme override patterns. Ask the tool to cite the foundation or theming page it used.
Ask the tool to check labels, source order, focus behavior, keyboard support, and semantic structure against the component documentation. Keep a human accessibility review in the workflow.
Ask for help replacing one component pattern with another, moving from custom CSS to BEEQ tokens, or updating examples to match current documentation conventions.

​
Prompting guidance

Good prompts give the assistant enough context to search the right docs and produce reusable output.

Be specific

Include the framework, component, desired behavior, and constraints. For example: “In React, show a BEEQ Select with grouped options and a visible label.”

Ask for source-backed answers

Ask the tool to use BEEQ docs first and name the pages it relied on. This keeps answers closer to current implementation.

Request the right output

Tell the assistant whether you need HTML, React, Angular Standalone, Vue, CSS custom properties, or design guidance.

Ask for checks

Ask the assistant to review the answer for accessibility, token usage, event names, and API alignment before you use it.

​
Example prompts

Use these prompts as starting points.

Create an accessible Angular Standalone alert

Open in Cursor

Choose components for a React form

Open in Cursor

Find tokens for a custom settings panel

Open in Cursor

Review a BEEQ Button example

Open in Cursor
The Copy prompt action copies the full prompt text inside the card, not the short description shown at the top.

​
Limits and responsibilities

AI tools work best when they use current documentation as context. They still need review.
  • Verify generated code against the component page and the source when behavior matters.
  • Test examples in your application, especially events, overlays, forms, and framework wrappers.
  • Review accessibility manually; AI can catch common issues, but it cannot validate the full user experience.
  • Keep product, design, and security decisions with the team responsible for the application.
  • Prefer BEEQ tokens, component CSS variables, and documented APIs over one-off styles or undocumented internals.

​
Resources

Framework guides

Choose the integration path for your stack.

Components

Browse component usage, examples, and API references.

Theming and customization

Learn how BEEQ themes, modes, and tokens work.

Storybook

Explore component states and examples interactively.