Skip to content

Commit a2dcf3a

Browse files
feat(onboarding): add cli and button options for including carbon-mcp (carbon-design-system#4836)
1 parent 035928b commit a2dcf3a

File tree

2 files changed

+179
-43
lines changed

2 files changed

+179
-43
lines changed

src/pages/developing/carbon-mcp/onboarding-and-setup.mdx

Lines changed: 19 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -164,35 +164,19 @@ current Bob session.
164164

165165
<AccordionItem title="Claude Code">
166166

167-
- Edit the Claude Code configuration file if it exists, else create the file.
168-
For macOS/Linux, the configuration file is located
169-
`~/.config/claude-code/config.json`
170-
- Insert the following configuration into your config.json file:
171-
<br />
172-
<br />
167+
- Use the Claude Code CLI and replace the `<TOKEN>` and `<SESSION>` with your
168+
Carbon MCP auth credentials
173169

174-
```markdown
175-
{ "mcpServers": { "carbon-mcp": { "type":"streamable-http", "url":
176-
"https://mcp.carbondesignsystem.com/mcp", "disabled": false, "timeout": 600,
177-
"headers": { "Authorization": "Bearer <TOKEN>", "X-MCP-Session": "<SESSION>" },
178-
"alwaysAllow": ["code_search", "docs_search"] } } }
179-
```
180-
181-
<br />
182170
<br />
183171

184-
- Replace `<TOKEN>` and `<SESSION>` with your actual Carbon MCP auth credentials
185-
- Save and close the file
186-
- Quit and relaunch Claude Code
187-
- Verify that Claude Code recognizes Carbon MCP by running this command: <br/>
188-
`claude-code --list-mcp-servers`
189-
- You should see Carbon MCP listed:
172+
```bash
173+
claude mcp add-json carbon-mcp '{"type":"http","url":"https://mcp.carbondesignsystem.com/mcp","headers":{"Authorization":"Bearer <TOKEN>","X-MCP-Session":"<SESSION>"}}'
174+
```
190175

191176
<br />
192-
![Carbon MCP Claude connected to Claude desktop](./images/carbon-mcp-connected-to-claude-code.png)
193177

194-
<br />
195-
<br />
178+
- Verify that Claude Code recognizes Carbon MCP by running `claude mcp list`
179+
196180
</AccordionItem>
197181

198182
<AccordionItem title="Claude Desktop">
@@ -238,8 +222,9 @@ This section describes how to make both connections.
238222
</AccordionItem>
239223

240224
<AccordionItem title="Cursor">
225+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=carbon-mcp&config=eyJ0eXBlIjoic3RyZWFtYWJsZS1odHRwIiwidXJsIjoiaHR0cHM6Ly9tY3AuY2FyYm9uZGVzaWduc3lzdGVtLmNvbS9tY3AiLCJkaXNhYmxlZCI6ZmFsc2UsInRpbWVvdXQiOjYwMCwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiIiwiWC1NQ1AtU2Vzc2lvbiI6IiJ9LCJhbHdheXNBbGxvdyI6WyJjb2RlX3NlYXJjaCIsImRvY3Nfc2VhcmNoIl19)
241226

242-
- Open the command palette
227+
- Or manually open the command palette
243228
- Select “View: Open MCP Settings”
244229
- Click on “Add custom MCP”
245230
- It will open a file with your MCP servers where you can add the following
@@ -287,32 +272,19 @@ This section describes how to make both connections.
287272

288273
<AccordionItem title="VS Code">
289274

290-
_Support for MCP in VS Code requires a recent version of VS Code that comes with
291-
Copilot Chat installed. Go to Settings and search for “Copilot” to confirm
292-
Copilot Chat is enabled._
275+
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_carbon--mcp-0098FF?style=flat&logo=visualstudiocode&logoColor=ffffff)](vscode:mcp/install?%7B%22name%22%3A%22carbon-mcp%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.carbondesignsystem.com%2Fmcp%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20%24%7Binput%3Atoken%7D%22%2C%22X-MCP-Session%22%3A%22%24%7Binput%3Asession%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Carbon%20MCP%20Token%22%2C%22password%22%3Atrue%7D%2C%7B%22id%22%3A%22session%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Carbon%20MCP%20Session%20ID%22%7D%5D%7D)
293276

294-
- Open the Command Palette
295-
- Select “Copilot: Open MCP Settings”
296-
- Click on “Add custom MCP”
297-
- It will open a JSON file with your MCP servers where you can add the following
298-
configuration:
277+
- Or use VS Code CLI and replace the `<TOKEN>` and `<SESSION>` with your Carbon
278+
MCP auth credentials
299279

300-
<br />
280+
<br />
301281

302-
```markdown
303-
{ "mcpServers": { "carbon-mcp": { "type":"streamable-http", "url":
304-
"https://mcp.carbondesignsystem.com/mcp", "disabled": false, "timeout": 600,
305-
"headers": { "Authorization": "Bearer <TOKEN>", "X-MCP-Session": "<SESSION>" },
306-
"alwaysAllow": ["code_search", "docs_search"] } } }
282+
```bash
283+
code --add-mcp '{"name":"carbon-mcp","type":"http","url":"https://mcp.carbondesignsystem.com/mcp","headers":{"Authorization":"Bearer <TOKEN>","X-MCP-Session":"<SESSION>"}}'
307284
```
308285

309-
<br />
310286
<br />
311287

312-
- Replace `<TOKEN>` and `<SESSION>` with your actual Carbon MCP auth credentials
313-
- Save and close the file
314-
- Quit and relaunch VS Code
315-
316288
</AccordionItem>
317289

318290
<AccordionItem title="Other clients">
@@ -323,6 +295,10 @@ If the MCP client you are using is not listed, refer to their documentation for
323295
</AccordionItem>
324296
</Accordion>
325297

298+
Additionally, an `llms.txt` file is available [here](/llms.txt) — a structured
299+
index of Carbon Design System documentation, components, and source repositories
300+
for AI tools and LLMs.
301+
326302
## Step 4: Adding the client system prompt
327303

328304
Some MCP clients let you set a Carbon MCP system prompt. When available, enable

static/llms.txt

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Carbon Design System
2+
3+
> Carbon is IBM's open source design system for products and digital experiences. Built on the IBM Design Language, it provides working code, design tools, resources, and guidelines for creating consistent UI.
4+
5+
## Getting Started
6+
7+
- [Overview](https://carbondesignsystem.com/): Introduction to Carbon Design System
8+
- [All Systems](https://carbondesignsystem.com/all-systems/): Overview of all IBM design systems
9+
- [Designing](https://carbondesignsystem.com/designing/get-started/): Getting started for designers
10+
- [Developing](https://carbondesignsystem.com/developing/get-started/): Getting started for developers
11+
12+
## Foundations
13+
14+
- [Color](https://carbondesignsystem.com/foundations/color/overview/): Color usage and tokens
15+
- [Grid](https://carbondesignsystem.com/foundations/grid/overview/): Layout grid system
16+
- [Icons](https://carbondesignsystem.com/foundations/icons/library/): Icon library
17+
- [Motion](https://carbondesignsystem.com/foundations/motion/overview/): Animation and motion guidelines
18+
- [Pictograms](https://carbondesignsystem.com/foundations/pictograms/library/): Pictogram library
19+
- [Shape](https://carbondesignsystem.com/foundations/shape/overview/): Shape tokens and usage
20+
- [Spacing](https://carbondesignsystem.com/foundations/spacing/overview/): Spacing scale and tokens
21+
- [Themes](https://carbondesignsystem.com/foundations/themes/overview/): Theming and tokens
22+
- [Typography](https://carbondesignsystem.com/foundations/typography/overview/): Type scale and usage
23+
- [2x Grid](https://carbondesignsystem.com/foundations/2x-grid/overview/): 2x Grid system
24+
25+
## Components
26+
27+
- [Overview](https://carbondesignsystem.com/components/overview/components/): All components overview
28+
- [Accordion](https://carbondesignsystem.com/components/accordion/usage/): Expandable/collapsible sections
29+
- [AI Label](https://carbondesignsystem.com/components/ai-label/usage/): AI-generated content label
30+
- [AI Skeleton](https://carbondesignsystem.com/components/ai-skeleton/usage/): Skeleton loader for AI content
31+
- [Breadcrumb](https://carbondesignsystem.com/components/breadcrumb/usage/): Navigation breadcrumb trail
32+
- [Button](https://carbondesignsystem.com/components/button/usage/): Button variants and usage
33+
- [Checkbox](https://carbondesignsystem.com/components/checkbox/usage/): Checkbox input
34+
- [Code Snippet](https://carbondesignsystem.com/components/code-snippet/usage/): Inline and block code display
35+
- [Combobox](https://carbondesignsystem.com/components/combobox/usage/): Searchable dropdown
36+
- [Content Switcher](https://carbondesignsystem.com/components/content-switcher/usage/): Toggle between content views
37+
- [Context Menu](https://carbondesignsystem.com/components/context-menu/usage/): Right-click context menu
38+
- [Data Table](https://carbondesignsystem.com/components/data-table/usage/): Tabular data display
39+
- [Date Picker](https://carbondesignsystem.com/components/date-picker/usage/): Date selection input
40+
- [Dropdown](https://carbondesignsystem.com/components/dropdown/usage/): Select from a list
41+
- [File Uploader](https://carbondesignsystem.com/components/file-uploader/usage/): File upload component
42+
- [Form](https://carbondesignsystem.com/components/form/usage/): Form layout and structure
43+
- [Inline Loading](https://carbondesignsystem.com/components/inline-loading/usage/): Inline loading state
44+
- [Link](https://carbondesignsystem.com/components/link/usage/): Hyperlink component
45+
- [List](https://carbondesignsystem.com/components/list/usage/): Ordered and unordered lists
46+
- [Loading](https://carbondesignsystem.com/components/loading/usage/): Loading spinner
47+
- [Menu](https://carbondesignsystem.com/components/menu/usage/): Menu and menu items
48+
- [Modal](https://carbondesignsystem.com/components/modal/usage/): Dialog overlay
49+
- [Multiselect](https://carbondesignsystem.com/components/multi-select/usage/): Select multiple items
50+
- [Notification](https://carbondesignsystem.com/components/notification/usage/): Alert and notification banners
51+
- [Number Input](https://carbondesignsystem.com/components/number-input/usage/): Numeric input field
52+
- [Overflow Menu](https://carbondesignsystem.com/components/overflow-menu/usage/): Additional options menu
53+
- [Pagination](https://carbondesignsystem.com/components/pagination/usage/): Page navigation
54+
- [Popover](https://carbondesignsystem.com/components/popover/usage/): Floating content panel
55+
- [Progress Bar](https://carbondesignsystem.com/components/progress-bar/usage/): Task progress indicator
56+
- [Progress Indicator](https://carbondesignsystem.com/components/progress-indicator/usage/): Multi-step progress
57+
- [Radio Button](https://carbondesignsystem.com/components/radio-button/usage/): Single-select radio input
58+
- [Search](https://carbondesignsystem.com/components/search/usage/): Search input field
59+
- [Select](https://carbondesignsystem.com/components/select/usage/): Native select dropdown
60+
- [Side Panel](https://carbondesignsystem.com/components/side-panel/usage/): Sliding side panel
61+
- [Skeleton](https://carbondesignsystem.com/components/skeleton/usage/): Loading skeleton placeholder
62+
- [Slider](https://carbondesignsystem.com/components/slider/usage/): Range slider input
63+
- [Stack](https://carbondesignsystem.com/components/stack/usage/): Layout stack utility
64+
- [Structured List](https://carbondesignsystem.com/components/structured-list/usage/): Structured data list
65+
- [Tabs](https://carbondesignsystem.com/components/tabs/usage/): Tabbed content navigation
66+
- [Tag](https://carbondesignsystem.com/components/tag/usage/): Label and category tags
67+
- [Text Area](https://carbondesignsystem.com/components/text-area/usage/): Multi-line text input
68+
- [Text Input](https://carbondesignsystem.com/components/text-input/usage/): Single-line text input
69+
- [Tile](https://carbondesignsystem.com/components/tile/usage/): Clickable tile component
70+
- [Time Picker](https://carbondesignsystem.com/components/time-picker/usage/): Time selection input
71+
- [Toggle](https://carbondesignsystem.com/components/toggle/usage/): On/off toggle switch
72+
- [Toggletip](https://carbondesignsystem.com/components/toggletip/usage/): Interactive tooltip
73+
- [Toolbar](https://carbondesignsystem.com/components/toolbar/usage/): Action toolbar
74+
- [Tooltip](https://carbondesignsystem.com/components/tooltip/usage/): Hover tooltip
75+
- [Tree View](https://carbondesignsystem.com/components/tree-view/usage/): Hierarchical tree navigation
76+
- [UI Shell](https://carbondesignsystem.com/components/UI-shell-header/usage/): App shell header, side nav, and footer
77+
78+
## Patterns
79+
80+
- [Common Actions](https://carbondesignsystem.com/patterns/common-actions/): Standard UI actions
81+
- [Dialogs](https://carbondesignsystem.com/patterns/dialog-patterns/): Dialog and modal patterns
82+
- [Disclosures](https://carbondesignsystem.com/patterns/disclosures/): Disclosure patterns
83+
- [Empty States](https://carbondesignsystem.com/patterns/empty-states-pattern/): No content state handling
84+
- [Filtering](https://carbondesignsystem.com/patterns/filtering/): Data filtering patterns
85+
- [Forms](https://carbondesignsystem.com/patterns/forms-pattern/): Form design patterns
86+
- [Global Header](https://carbondesignsystem.com/patterns/global-header/): Site-wide header pattern
87+
- [Loading](https://carbondesignsystem.com/patterns/loading-pattern/): Loading state patterns
88+
- [Login](https://carbondesignsystem.com/patterns/login-pattern/): Authentication patterns
89+
- [Notifications](https://carbondesignsystem.com/patterns/notification-pattern/): Notification patterns
90+
- [Overflow Content](https://carbondesignsystem.com/patterns/overflow-content/): Handling overflow
91+
- [Pagination](https://carbondesignsystem.com/patterns/pagination-pattern/): Pagination patterns
92+
- [Placeholder Loading](https://carbondesignsystem.com/patterns/placeholder-loading-pattern/): Skeleton loading
93+
- [Search](https://carbondesignsystem.com/patterns/search-pattern/): Search UX patterns
94+
- [Status Indicators](https://carbondesignsystem.com/patterns/status-indicator-pattern/): Status display patterns
95+
96+
## Data Visualization
97+
98+
- [Overview](https://carbondesignsystem.com/data-visualization/getting-started/): Data viz overview
99+
- [Chart Types](https://carbondesignsystem.com/data-visualization/chart-types/): Available chart types
100+
- [Color Palettes](https://carbondesignsystem.com/data-visualization/color-palettes/): Viz color system
101+
- [Axes & Labels](https://carbondesignsystem.com/data-visualization/axes-and-labels/): Chart axes guidance
102+
103+
## Carbon Charts
104+
105+
- [Overview](https://charts.carbondesignsystem.com/): Carbon Charts component library (React, Vue, Angular, Svelte, Vanilla)
106+
107+
## Frameworks
108+
109+
- [React (@carbon/react)](https://carbondesignsystem.com/developing/frameworks/react/): React implementation
110+
- [Web Components (@carbon/web-components)](https://carbondesignsystem.com/developing/frameworks/web-components/): Web Components implementation
111+
- [Angular](https://angular.carbondesignsystem.com/documentation/): Angular implementation
112+
- [Vue](https://carbondesignsystem.com/developing/frameworks/vue/): Community Vue implementation
113+
114+
## Source Code — carbon-design-system/carbon
115+
116+
> Core Carbon packages: React components, Web Components, icons, pictograms, tokens, and styles.
117+
118+
- [Repository](https://github.com/carbon-design-system/carbon): Main monorepo
119+
- [React (@carbon/react)](https://github.com/carbon-design-system/carbon/tree/main/packages/react): React component source code
120+
- [Web Components (@carbon/web-components)](https://github.com/carbon-design-system/carbon/tree/main/packages/web-components): Web Components source code
121+
- [Icons (@carbon/icons)](https://github.com/carbon-design-system/carbon/tree/main/packages/icons): Icon SVG source files
122+
- [Icons React (@carbon/icons-react)](https://github.com/carbon-design-system/carbon/tree/main/packages/icons-react): React icon components
123+
- [Icons Web Components (@carbon/icons-element)](https://github.com/carbon-design-system/carbon/tree/main/packages/icons-element): Web Component icon elements
124+
- [Pictograms (@carbon/pictograms)](https://github.com/carbon-design-system/carbon/tree/main/packages/pictograms): Pictogram SVG source files
125+
- [Pictograms React (@carbon/pictograms-react)](https://github.com/carbon-design-system/carbon/tree/main/packages/pictograms-react): React pictogram components
126+
- [Styles (@carbon/styles)](https://github.com/carbon-design-system/carbon/tree/main/packages/styles): CSS and Sass styles
127+
- [Tokens (@carbon/tokens)](https://github.com/carbon-design-system/carbon/tree/main/packages/tokens): Design tokens
128+
- [Motion (@carbon/motion)](https://github.com/carbon-design-system/carbon/tree/main/packages/motion): Motion tokens
129+
- [Type (@carbon/type)](https://github.com/carbon-design-system/carbon/tree/main/packages/type): Typography tokens and utilities
130+
- [Layout (@carbon/layout)](https://github.com/carbon-design-system/carbon/tree/main/packages/layout): Spacing and grid tokens
131+
- [Themes (@carbon/themes)](https://github.com/carbon-design-system/carbon/tree/main/packages/themes): Theme definitions (White, G10, G90, G100)
132+
- [Examples](https://github.com/carbon-design-system/carbon/tree/main/examples): Framework usage examples
133+
134+
## Source Code — carbon-design-system/ibm-products
135+
136+
> Extended Carbon-powered component library for IBM product teams, including advanced patterns and enterprise-grade components.
137+
138+
- [Repository](https://github.com/carbon-design-system/ibm-products): IBM Products monorepo
139+
- [IBM Products React (@carbon/ibm-products)](https://github.com/carbon-design-system/ibm-products/tree/main/packages/ibm-products): React components for IBM Products
140+
- [IBM Products Web Components (@carbon/ibm-products-web-components)](https://github.com/carbon-design-system/ibm-products/tree/main/packages/ibm-products-web-components): Web Components for IBM Products
141+
- [Storybook](https://ibm-products.carbondesignsystem.com): Interactive component demos
142+
143+
## Source Code — carbon-design-system/carbon-ai-chat
144+
145+
> Carbon AI Chat component library for building AI-powered chat interfaces, with React and Web Component implementations.
146+
147+
- [Repository](https://github.com/carbon-design-system/carbon-ai-chat): Carbon AI Chat monorepo
148+
- [Packages](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/packages): React and Web Component chat packages
149+
- [Examples](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/examples): Usage examples for React and Web Components
150+
- [Demo](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/demo): Live demo source
151+
- [Docs](https://github.com/carbon-design-system/carbon-ai-chat/tree/main/docs): Documentation source
152+
- [Storybook](https://chat.carbondesignsystem.com/tag/latest/docs/documents/Overview.html): Interactive AI chat component docs
153+
154+
## Resources
155+
156+
- [GitHub](https://github.com/carbon-design-system/carbon): Source code
157+
- [Storybook (React)](https://react.carbondesignsystem.com/): Interactive component demos
158+
- [FAQ](https://carbondesignsystem.com/help/faq/): Frequently asked questions
159+
- [Changelog](https://github.com/carbon-design-system/carbon/releases): Release notes
160+
- [Community Assets](https://carbondesignsystem.com/community/component-index/): Community components

0 commit comments

Comments
 (0)