Skip to content

Commit d0d3b64

Browse files
authored
docs(shell-docs): add CopilotKit Skills section to build-with-agents page (CopilotKit#5039)
## Summary Adds the Skills installation section to the shell-docs `/build-with-agents` page ## Changes **`showcase/shell-docs/src/content/snippets/shared/guides/build-with-agents.mdx`** (new) - Single source of truth for the page content - Intro paragraph, `## CopilotKit Skills` section (Callout + Steps: install + starter prompt), `<MCPSetup />` as second section **`showcase/shell-docs/src/content/docs/build-with-agents.mdx`** - Replaced inline content with `<BuildWithAgents />` — delegates to the shared snippet - Icon updated to `BrainCircuit`, description updated to keyword-rich copy, `hideTOC: true` removed **`showcase/shell-docs/src/content/docs/integrations/built-in-agent/build-with-agents.mdx`** - Replaced `<SharedContent />` with `<BuildWithAgents />` so the skills section appears here too (built-in-agent uses `docs_mode: authored` and never falls through to the root page) **`showcase/shell-docs/src/content/snippets/shared/guides/mcp-server-setup.mdx`** - `## Overview` → `## MCP Docs Server` **`showcase/shell-docs/src/lib/docs-render.tsx`** + **`mdx-registry.tsx`** - Register `BuildWithAgents` in `SNIPPET_MAP` and component registry ## Acceptance criteria status - [x] `/coding-agents` redirects to `/build-with-agents` (PR CopilotKit#5023) - [x] React Native moved to Platforms section (PR CopilotKit#4927 / CopilotKit#5023) - [x] `npx skills add` flow documented with skills link and starter prompt - [x] MCP server install instructions present (existing content, now labeled correctly) - [x] Page structure follows Mastra "Build with AI" reference
2 parents bfbd074 + 94f473b commit d0d3b64

6 files changed

Lines changed: 48 additions & 10 deletions

File tree

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Build with agents"
3-
icon: "lucide/Code"
4-
description: "Use our MCP server to connect your AI agents and backends to CopilotKit."
5-
hideTOC: true
3+
icon: "lucide/BrainCircuit"
4+
description: "Give your AI coding agent up-to-date knowledge of CopilotKit's APIs, patterns, and best practices."
65
---
7-
<MCPSetup />
6+
<BuildWithAgents />
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: "Build with agents"
3-
icon: "lucide/Code"
4-
description: "Use our MCP server to connect your Built-in Agent to CopilotKit."
3+
icon: "lucide/BrainCircuit"
4+
description: "Give your AI coding agent up-to-date knowledge of CopilotKit's APIs, patterns, and best practices."
55
---
6-
import SharedContent from "@/snippets/shared/coding-agents.mdx";
7-
8-
<SharedContent components={props.components} />
6+
<BuildWithAgents />
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
AI coding agents may not have up-to-date knowledge of CopilotKit's APIs, patterns, and best practices. The resources on this page give them accurate, current knowledge directly in their context.
2+
3+
## CopilotKit Skills
4+
5+
Skills are folders of instructions, references, and scripts that coding agents can discover and use to work with CopilotKit accurately. Installing them gives your agent authoritative guidance on setup, development, debugging, integration, and upgrades — without relying on potentially outdated training data.
6+
7+
<Callout type="info">
8+
Skills are the recommended way to give your agent CopilotKit knowledge. They work natively in Claude Code, Cursor, Codex, Gemini CLI, and any tool supporting the [agentskills.io](https://agentskills.io) standard.
9+
</Callout>
10+
11+
<Steps>
12+
<Step>
13+
### Install the skills
14+
15+
Run the following command to install CopilotKit skills into your agent environment:
16+
17+
```bash
18+
npx skills add CopilotKit/CopilotKit
19+
```
20+
21+
This pulls the latest skills directly from the CopilotKit repository and installs them into your tool's skills directory (e.g. `~/.claude/skills/` for Claude Code). The CopilotKit MCP server is also auto-wired so your agent has live documentation access.
22+
23+
Skills cover project setup, building AI features, connecting agent frameworks, debugging, and version upgrades. The full list is in the [CopilotKit skills directory](https://github.com/CopilotKit/CopilotKit/tree/main/skills).
24+
25+
</Step>
26+
<Step>
27+
### Start building
28+
29+
Open a new agent session and use a starter prompt to put the skills to work:
30+
31+
```
32+
Help me build a CopilotKit app. Use the copilotkit-setup skill to get started.
33+
```
34+
35+
Your agent will discover the installed skills and use the right one for each task — setup, development, debugging, or integration.
36+
</Step>
37+
</Steps>
38+
39+
<MCPSetup />

showcase/shell-docs/src/content/snippets/shared/guides/mcp-server-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Overview
1+
## MCP Docs Server
22

33
The CopilotKit MCP server equips AI coding agents with deep knowledge about CopilotKit's APIs, patterns, and best practices. When connected to your
44
development environment, it enables AI assistants to:

showcase/shell-docs/src/lib/docs-render.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,7 @@ export const SNIPPET_MAP: Record<string, string> = {
769769
A2UI: "shared/generative-ui/a2ui.mdx",
770770
AgUI: "shared/backend/ag-ui.mdx",
771771
AGUI: "shared/backend/ag-ui.mdx", // alias of AgUI
772+
BuildWithAgents: "shared/guides/build-with-agents.mdx",
772773
CodingAgents: "shared/coding-agents.mdx",
773774
CommonIssues: "shared/troubleshooting/common-issues.mdx",
774775
CopilotRuntime: "copilot-runtime.mdx",

showcase/shell-docs/src/lib/mdx-registry.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ export const docsComponents = {
541541
/>
542542
),
543543
InstallSDKSnippet: stubWithPartial("InstallSDKSnippet"),
544+
BuildWithAgents: stubWithPartial("BuildWithAgents"),
544545
MCPApps: stubWithPartial("MCPApps"),
545546
MCPSetup: stubWithPartial("MCPSetup"),
546547
Overview: stubWithPartial("Overview"),

0 commit comments

Comments
 (0)