Skip to content

Commit c26f564

Browse files
shahednassershahednasser
authored
docs: improve build with AI chapter (#14259)
* docs: improve build with AI chapter * update sidebar
1 parent cc84b9a commit c26f564

File tree

5 files changed

+111
-89
lines changed

5 files changed

+111
-89
lines changed

‎www/apps/book/app/learn/introduction/build-with-llms-ai/page.mdx‎

Lines changed: 55 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -18,50 +18,6 @@ export const metadata = {
1818

1919
In this chapter, you'll learn how you can use AI assistants and LLMs effectively in your Medusa development.
2020

21-
## AI Assistant in Documentation
22-
23-
The Medusa documentation is equipped with an AI Assistant that can answer your questions and help you build customizations with Medusa.
24-
25-
### Open the AI Assistant
26-
27-
To open the AI Assistant, either:
28-
29-
- Use the keyboard shortcut `Ctrl + I` for Windows/Linux, or `Cmd + I` for macOS.
30-
- Click the <InlineIcon Icon={AiAssistent} alt="AI Assistant" /> icon in the top right corner of the documentation.
31-
32-
You can then ask the AI Assistant any questions about Medusa, such as:
33-
34-
- What is a workflow?
35-
- How to create a product review module?
36-
- How to update Medusa?
37-
- How to fix this error?
38-
39-
The AI Assistant will provide you with relevant documentation links, code snippets, and explanations to help you with your development.
40-
41-
### Ask About Code Snippets
42-
43-
While browsing the documentation, you'll find a <InlineIcon Icon={AiAssistentLuminosity} alt="AI Assistant" /> icon in the header of code snippets. You can click this icon to ask the AI Assistant about the code snippet.
44-
45-
The AI Assistant will analyze the code and provide explanations, usage examples, and any additional information you need to understand how the code works.
46-
47-
### Ask About Documentation Pages
48-
49-
If you need more help understanding a specific documentation page, you can click the "Explain with AI Assistant" link in the page's right sidebar. This will open the AI Assistant and provide context about the current page, allowing you to ask questions related to the content.
50-
51-
### Formatting and Code Blocks
52-
53-
In your questions to the AI Assistant, you can format code blocks by wrapping them in triple backticks (```). For example:
54-
55-
~~~markdown
56-
```
57-
console.log("Hello, World!")
58-
```
59-
~~~
60-
61-
You can add new lines using the `Shift + Enter` shortcut.
62-
63-
---
64-
6521
## MCP Remote Server
6622

6723
The Medusa documentation provides a remote Model Context Protocol (MCP) server that allows you to find information from the Medusa documentation right in your IDEs or AI tools, such as Cursor.
@@ -124,6 +80,61 @@ claude mcp add --transport http medusa https://docs.medusajs.com/mcp
12480
</TabsContentWrapper>
12581
</Tabs>
12682

83+
### How to Use the MCP Server
84+
85+
After connecting to the Medusa MCP server in your AI tool or IDE, you can start asking questions or requesting your AI assistant to build Medusa customizations. It will fetch the relevant information from the Medusa documentation and provide you with accurate answers, code snippets, and explanations.
86+
87+
For example, you can ask:
88+
89+
1. "Create a Product Review module for Medusa. Refer to the Medusa documentation for information."
90+
2. "How to update Medusa to the latest version?"
91+
3. "Explain the Medusa workflow system."
92+
4. "Integrate Medusa with X provider. Refer to the Medusa documentation for information."
93+
94+
---
95+
96+
## AI Assistant in Documentation
97+
98+
The Medusa documentation is equipped with an AI Assistant that can answer your questions and help you build customizations with Medusa.
99+
100+
### Open the AI Assistant
101+
102+
To open the AI Assistant, either:
103+
104+
- Use the keyboard shortcut `Ctrl + I` for Windows/Linux, or `Cmd + I` for macOS.
105+
- Click the <InlineIcon Icon={AiAssistent} alt="AI Assistant" /> icon in the top right corner of the documentation.
106+
107+
You can then ask the AI Assistant any questions about Medusa, such as:
108+
109+
- What is a workflow?
110+
- How to create a product review module?
111+
- How to update Medusa?
112+
- How to fix this error?
113+
114+
The AI Assistant will provide you with relevant documentation links, code snippets, and explanations to help you with your development.
115+
116+
### Ask About Code Snippets
117+
118+
While browsing the documentation, you'll find a <InlineIcon Icon={AiAssistentLuminosity} alt="AI Assistant" /> icon in the header of code snippets. You can click this icon to ask the AI Assistant about the code snippet.
119+
120+
The AI Assistant will analyze the code and provide explanations, usage examples, and any additional information you need to understand how the code works.
121+
122+
### Ask About Documentation Pages
123+
124+
If you need more help understanding a specific documentation page, you can click the "Explain with AI Assistant" link in the page's right sidebar. This will open the AI Assistant and provide context about the current page, allowing you to ask questions related to the content.
125+
126+
### Formatting and Code Blocks
127+
128+
In your questions to the AI Assistant, you can format code blocks by wrapping them in triple backticks (```). For example:
129+
130+
~~~markdown
131+
```
132+
console.log("Hello, World!")
133+
```
134+
~~~
135+
136+
You can add new lines using the `Shift + Enter` shortcut.
137+
127138
---
128139

129140
## Plain Text Documentation

‎www/apps/book/generated/edit-dates.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export const generatedEditDates = {
122122
"app/learn/fundamentals/api-routes/override/page.mdx": "2025-05-09T08:01:24.493Z",
123123
"app/learn/fundamentals/module-links/index/page.mdx": "2025-05-23T07:57:58.958Z",
124124
"app/learn/fundamentals/module-links/index-module/page.mdx": "2025-11-26T11:20:25.961Z",
125-
"app/learn/introduction/build-with-llms-ai/page.mdx": "2025-10-02T15:10:49.394Z",
125+
"app/learn/introduction/build-with-llms-ai/page.mdx": "2025-12-09T14:17:13.295Z",
126126
"app/learn/installation/docker/page.mdx": "2025-10-24T08:53:46.445Z",
127127
"app/learn/fundamentals/generated-types/page.mdx": "2025-07-25T13:17:35.319Z",
128128
"app/learn/introduction/from-v1-to-v2/page.mdx": "2025-10-29T11:55:11.531Z",

‎www/apps/book/generated/sidebar.mjs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,20 @@ export const generatedSidebars = [
4444
"loaded": true,
4545
"isPathHref": true,
4646
"type": "link",
47-
"title": "Architecture",
48-
"path": "/learn/introduction/architecture",
47+
"title": "AI Assistants and LLMs",
48+
"path": "/learn/introduction/build-with-llms-ai",
4949
"children": [],
50-
"chapterTitle": "1.3. Architecture",
50+
"chapterTitle": "1.3. AI Assistants and LLMs",
5151
"number": "1.3."
5252
},
5353
{
5454
"loaded": true,
5555
"isPathHref": true,
5656
"type": "link",
57-
"title": "AI Assistants and LLMs",
58-
"path": "/learn/introduction/build-with-llms-ai",
57+
"title": "Architecture",
58+
"path": "/learn/introduction/architecture",
5959
"children": [],
60-
"chapterTitle": "1.4. AI Assistants and LLMs",
60+
"chapterTitle": "1.4. Architecture",
6161
"number": "1.4."
6262
},
6363
{

‎www/apps/book/public/llms-full.txt‎

Lines changed: 45 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -25870,6 +25870,51 @@ The following diagram illustrates Medusa's architecture including all its layers
2587025870

2587125871
In this chapter, you'll learn how you can use AI assistants and LLMs effectively in your Medusa development.
2587225872

25873+
## MCP Remote Server
25874+
25875+
The Medusa documentation provides a remote Model Context Protocol (MCP) server that allows you to find information from the Medusa documentation right in your IDEs or AI tools, such as Cursor.
25876+
25877+
Medusa hosts a Streamable HTTP MCP server available at `https://docs.medusajs.com/mcp`. you can add it to AI agents that support connecting to MCP servers.
25878+
25879+
### Cursor
25880+
25881+
<Link href="cursor://anysphere.cursor-deeplink/mcp/install?name=medusa&config=eyJ1cmwiOiJodHRwczovL2RvY3MubWVkdXNhanMuY29tL21jcCJ9" target="_blank" rel="noopener noreferrer" variant="content">Click here</Link> to add the Medusa MCP server to Cursor.
25882+
25883+
To manually connect to the Medusa MCP server in Cursor, add the following to your `.cursor/mcp.json` file or Cursor settings, as explained in the [Cursor documentation](https://docs.cursor.com/context/model-context-protocol):
25884+
25885+
```json
25886+
{
25887+
"mcpServers": {
25888+
"medusa": {
25889+
"url": "https://docs.medusajs.com/mcp"
25890+
}
25891+
}
25892+
}
25893+
```
25894+
25895+
### VSCode
25896+
25897+
To manually connect to the Medusa MCP server in Claude Code, run the following command in your terminal:
25898+
25899+
```sh
25900+
claude mcp add --transport http medusa https://docs.medusajs.com/mcp
25901+
```
25902+
25903+
### Claude Code
25904+
25905+
### How to Use the MCP Server
25906+
25907+
After connecting to the Medusa MCP server in your AI tool or IDE, you can start asking questions or requesting your AI assistant to build Medusa customizations. It will fetch the relevant information from the Medusa documentation and provide you with accurate answers, code snippets, and explanations.
25908+
25909+
For example, you can ask:
25910+
25911+
1. "Create a Product Review module for Medusa. Refer to the Medusa documentation for information."
25912+
2. "How to update Medusa to the latest version?"
25913+
3. "Explain the Medusa workflow system."
25914+
4. "Integrate Medusa with X provider. Refer to the Medusa documentation for information."
25915+
25916+
***
25917+
2587325918
## AI Assistant in Documentation
2587425919

2587525920
The Medusa documentation is equipped with an AI Assistant that can answer your questions and help you build customizations with Medusa.
@@ -25914,40 +25959,6 @@ You can add new lines using the `Shift + Enter` shortcut.
2591425959

2591525960
***
2591625961

25917-
## MCP Remote Server
25918-
25919-
The Medusa documentation provides a remote Model Context Protocol (MCP) server that allows you to find information from the Medusa documentation right in your IDEs or AI tools, such as Cursor.
25920-
25921-
Medusa hosts a Streamable HTTP MCP server available at `https://docs.medusajs.com/mcp`. you can add it to AI agents that support connecting to MCP servers.
25922-
25923-
### Cursor
25924-
25925-
<Link href="cursor://anysphere.cursor-deeplink/mcp/install?name=medusa&config=eyJ1cmwiOiJodHRwczovL2RvY3MubWVkdXNhanMuY29tL21jcCJ9" target="_blank" rel="noopener noreferrer" variant="content">Click here</Link> to add the Medusa MCP server to Cursor.
25926-
25927-
To manually connect to the Medusa MCP server in Cursor, add the following to your `.cursor/mcp.json` file or Cursor settings, as explained in the [Cursor documentation](https://docs.cursor.com/context/model-context-protocol):
25928-
25929-
```json
25930-
{
25931-
"mcpServers": {
25932-
"medusa": {
25933-
"url": "https://docs.medusajs.com/mcp"
25934-
}
25935-
}
25936-
}
25937-
```
25938-
25939-
### VSCode
25940-
25941-
To manually connect to the Medusa MCP server in Claude Code, run the following command in your terminal:
25942-
25943-
```sh
25944-
claude mcp add --transport http medusa https://docs.medusajs.com/mcp
25945-
```
25946-
25947-
### Claude Code
25948-
25949-
***
25950-
2595125962
## Plain Text Documentation
2595225963

2595325964
The Medusa documentation is available in plain text format, which allows LLMs and AI tools to easily parse and understand the content.

‎www/apps/book/sidebar.mjs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ export const sidebars = [
2727
},
2828
{
2929
type: "link",
30-
title: "Architecture",
31-
path: "/learn/introduction/architecture",
30+
title: "AI Assistants and LLMs",
31+
path: "/learn/introduction/build-with-llms-ai",
3232
},
3333
{
3434
type: "link",
35-
title: "AI Assistants and LLMs",
36-
path: "/learn/introduction/build-with-llms-ai",
35+
title: "Architecture",
36+
path: "/learn/introduction/architecture",
3737
},
3838
{
3939
type: "link",

0 commit comments

Comments
 (0)