From b8e7226ff534316578c474129dd5a91d1ec17c5b Mon Sep 17 00:00:00 2001 From: mrholek Date: Fri, 3 Jul 2026 19:20:31 +0200 Subject: [PATCH 1/3] docs: expand AI Tools (MCP) page with per-client setup and examples --- .../content/docs/getting-started/ai-tools.mdx | 92 +++++++++++++++++-- 1 file changed, 84 insertions(+), 8 deletions(-) diff --git a/packages/docs/src/content/docs/getting-started/ai-tools.mdx b/packages/docs/src/content/docs/getting-started/ai-tools.mdx index 738a793f..beb0031e 100644 --- a/packages/docs/src/content/docs/getting-started/ai-tools.mdx +++ b/packages/docs/src/content/docs/getting-started/ai-tools.mdx @@ -4,25 +4,78 @@ name: "AI Tools (MCP)" description: "Bring the CoreUI for React documentation into your AI coding assistant with the @coreui/docs-mcp Model Context Protocol server." --- -## What is the CoreUI Docs MCP server? +## Introduction -[Model Context Protocol (MCP)](https://modelcontextprotocol.io) is an open standard that lets AI assistants connect to external tools and data sources. The **`@coreui/docs-mcp`** server exposes the official CoreUI documentation — components, props, events, slots, and examples — so your assistant answers from the current docs instead of relying on stale training data. +[Model Context Protocol (MCP)](https://modelcontextprotocol.io) is an open standard that lets AI assistants connect to external tools and data sources. The **`@coreui/docs-mcp`** server gives your assistant direct access to the official CoreUI documentation, so it answers from the current docs instead of relying on stale training data. -It covers Bootstrap, React, and Vue, and reads the live documentation from `coreui.io` on demand, so it always reflects the latest release. +It provides: -## Installation +- **Component documentation** — pages, props, events, and slots. +- **Live content** — read on demand from `coreui.io`, always matching the latest release. +- **Cross-framework links** — where each component is documented for Angular, Bootstrap, React, and Vue. +- **Coverage of Bootstrap, React, and Vue** from a single server. + +The server runs locally over stdio via `npx` — no global install required. -The server runs over stdio via `npx` — no global install required. +## Installation ### Claude Code +Add the server with the CLI, then start a new session and run `/mcp` to verify the connection: + ```bash -claude mcp add coreui-docs -- npx -y @coreui/docs-mcp --framework react +claude mcp add coreui-docs -s user -- npx -y @coreui/docs-mcp --framework react +``` + +### Cursor + +Create `.cursor/mcp.json` in your project (or `~/.cursor/mcp.json` for global configuration): + +```json +{ + "mcpServers": { + "coreui-docs": { + "command": "npx", + "args": ["-y", "@coreui/docs-mcp", "--framework", "react"] + } + } +} +``` + +### VS Code + +Create `.vscode/mcp.json` in your project. Note that VS Code uses the `servers` key: + +```json +{ + "servers": { + "coreui-docs": { + "type": "stdio", + "command": "npx", + "args": ["-y", "@coreui/docs-mcp", "--framework", "react"] + } + } +} +``` + +### Windsurf + +Edit `~/.codeium/windsurf/mcp_config.json`: + +```json +{ + "mcpServers": { + "coreui-docs": { + "command": "npx", + "args": ["-y", "@coreui/docs-mcp", "--framework", "react"] + } + } +} ``` -### Cursor, Windsurf, VS Code, and Claude Desktop +### Claude Desktop -Add the server to your MCP configuration (`.cursor/mcp.json`, `.vscode/mcp.json`, `claude_desktop_config.json`, and similar): +Edit `claude_desktop_config.json` (Settings → Developer → Edit Config): ```json { @@ -35,6 +88,20 @@ Add the server to your MCP configuration (`.cursor/mcp.json`, `.vscode/mcp.json` } ``` +### OpenAI Codex + +Add it with the CLI, or edit `~/.codex/config.toml` directly: + +```bash +codex mcp add coreui-docs -- npx -y @coreui/docs-mcp --framework react +``` + +```toml +[mcp_servers.coreui-docs] +command = "npx" +args = ["-y", "@coreui/docs-mcp", "--framework", "react"] +``` + ## Tools Once connected, your assistant can call the following tools: @@ -56,4 +123,13 @@ Once connected, your assistant can call the following tools: | `--ttl ` | `COREUI_DOCS_TTL_MINUTES` | `360` | Cache freshness window. | | — | `COREUI_DOCS_CACHE_DIR` | OS cache directory | On-disk cache location. | +## Example prompts + +Once installed, try asking your AI assistant: + +- "How do I use the CoreUI React Multi Select component?" +- "What props does the CoreUI React Date Picker accept?" +- "Show me the CoreUI React Modal documentation." +- "Where is the Accordion documented across CoreUI frameworks?" + The package is open source and published as [`@coreui/docs-mcp`](https://www.npmjs.com/package/@coreui/docs-mcp). From 903aafa661271bfbaa51408dbbe6ac8ede2a2972 Mon Sep 17 00:00:00 2001 From: mrholek Date: Fri, 3 Jul 2026 19:30:37 +0200 Subject: [PATCH 2/3] docs: add LLMs.txt getting-started page --- .../content/docs/getting-started/llms-txt.mdx | 29 +++++++++++++++++++ packages/docs/src/data/sidebar.yml | 2 ++ 2 files changed, 31 insertions(+) create mode 100644 packages/docs/src/content/docs/getting-started/llms-txt.mdx diff --git a/packages/docs/src/content/docs/getting-started/llms-txt.mdx b/packages/docs/src/content/docs/getting-started/llms-txt.mdx new file mode 100644 index 00000000..c24710f5 --- /dev/null +++ b/packages/docs/src/content/docs/getting-started/llms-txt.mdx @@ -0,0 +1,29 @@ +--- +title: "LLMs.txt" +name: "LLMs.txt" +description: "LLM-optimized documentation endpoints for CoreUI for React — llms.txt, llms-full.txt, and a Markdown version of every page." +--- + +## Introduction + +[llms.txt](https://llmstxt.org) is an emerging standard that helps AI models understand and navigate documentation. The CoreUI for React docs expose three LLM-friendly endpoints so assistants can retrieve accurate, up-to-date content straight from the source. + +For a richer, tool-based integration, see [AI Tools (MCP)](/react/docs/getting-started/ai-tools/). + +## /llms.txt + +A structured index of the documentation — every page as a titled, described link, grouped by section. It gives an LLM a compact map of what exists and where. + +[Open llms.txt](/react/docs/llms.txt) + +## /llms-full.txt + +The entire documentation concatenated into a single Markdown file, so a model can ingest the whole set in one request. + +[Open llms-full.txt](/react/docs/llms-full.txt) + +## Markdown version of any page + +Append `.md` to any documentation page URL to get its clean Markdown version, without the site chrome. + +For example: [/react/docs/components/accordion.md](/react/docs/components/accordion.md) diff --git a/packages/docs/src/data/sidebar.yml b/packages/docs/src/data/sidebar.yml index 3ee21fc7..5a87aa77 100644 --- a/packages/docs/src/data/sidebar.yml +++ b/packages/docs/src/data/sidebar.yml @@ -5,6 +5,8 @@ to: /getting-started/introduction/ - title: Accessibility to: /getting-started/accessibility/ + - title: LLMs.txt + to: /getting-started/llms-txt/ - title: AI Tools (MCP) to: /getting-started/ai-tools/ - title: Customize From 7cdb23683d2664f99decf773fd2cd57a4f90c237 Mon Sep 17 00:00:00 2001 From: mrholek Date: Fri, 3 Jul 2026 19:41:16 +0200 Subject: [PATCH 3/3] docs: group MCP + LLMs.txt under a dedicated AI Tools section --- .../docs/{getting-started => ai-tools}/llms-txt.mdx | 2 +- .../{getting-started/ai-tools.mdx => ai-tools/mcp.mdx} | 4 ++-- packages/docs/src/data/sidebar.yml | 9 ++++++--- 3 files changed, 9 insertions(+), 6 deletions(-) rename packages/docs/src/content/docs/{getting-started => ai-tools}/llms-txt.mdx (91%) rename packages/docs/src/content/docs/{getting-started/ai-tools.mdx => ai-tools/mcp.mdx} (98%) diff --git a/packages/docs/src/content/docs/getting-started/llms-txt.mdx b/packages/docs/src/content/docs/ai-tools/llms-txt.mdx similarity index 91% rename from packages/docs/src/content/docs/getting-started/llms-txt.mdx rename to packages/docs/src/content/docs/ai-tools/llms-txt.mdx index c24710f5..4cfa4a8d 100644 --- a/packages/docs/src/content/docs/getting-started/llms-txt.mdx +++ b/packages/docs/src/content/docs/ai-tools/llms-txt.mdx @@ -8,7 +8,7 @@ description: "LLM-optimized documentation endpoints for CoreUI for React — llm [llms.txt](https://llmstxt.org) is an emerging standard that helps AI models understand and navigate documentation. The CoreUI for React docs expose three LLM-friendly endpoints so assistants can retrieve accurate, up-to-date content straight from the source. -For a richer, tool-based integration, see [AI Tools (MCP)](/react/docs/getting-started/ai-tools/). +For a richer, tool-based integration, see [MCP Server](/react/docs/ai-tools/mcp/). ## /llms.txt diff --git a/packages/docs/src/content/docs/getting-started/ai-tools.mdx b/packages/docs/src/content/docs/ai-tools/mcp.mdx similarity index 98% rename from packages/docs/src/content/docs/getting-started/ai-tools.mdx rename to packages/docs/src/content/docs/ai-tools/mcp.mdx index beb0031e..9d657eed 100644 --- a/packages/docs/src/content/docs/getting-started/ai-tools.mdx +++ b/packages/docs/src/content/docs/ai-tools/mcp.mdx @@ -1,6 +1,6 @@ --- -title: "AI Tools (MCP)" -name: "AI Tools (MCP)" +title: "MCP Server" +name: "MCP Server" description: "Bring the CoreUI for React documentation into your AI coding assistant with the @coreui/docs-mcp Model Context Protocol server." --- diff --git a/packages/docs/src/data/sidebar.yml b/packages/docs/src/data/sidebar.yml index 5a87aa77..786c4513 100644 --- a/packages/docs/src/data/sidebar.yml +++ b/packages/docs/src/data/sidebar.yml @@ -5,10 +5,13 @@ to: /getting-started/introduction/ - title: Accessibility to: /getting-started/accessibility/ +- title: AI Tools + icon: + pages: - title: LLMs.txt - to: /getting-started/llms-txt/ - - title: AI Tools (MCP) - to: /getting-started/ai-tools/ + to: /ai-tools/llms-txt/ + - title: MCP Server + to: /ai-tools/mcp/ - title: Customize icon: pages: