You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/features/marketplace.mdx
+75-31Lines changed: 75 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,19 @@ import Codicon from '@site/src/components/Codicon';
10
10
11
11
## Overview
12
12
13
-
The Roo Code Marketplace is a central hub for discovering and installing community-contributed extensions, known as Modes and MCPs (Model Context Protocol). It allows you to easily extend the functionality of Roo Code to fit your specific needs and workflows.
13
+
The Roo Code Marketplace is a central hub for discovering and installing community-contributed extensions, known as MCPs (Model Context Protocol) and Modes. It allows you to easily extend the functionality of Roo Code to fit your specific needs and workflows.
14
14
15
15
### Key Features
16
-
-**Discoverability**: Browse a curated list of Modes and MCPs.
16
+
-**Discoverability**: Browse a curated list of MCPs and Modes.
17
17
-**Simple Installation**: Install and remove items with a single click.
18
18
-**Community-Driven**: Access a growing collection of extensions from the Roo Code community.
19
19
-**Project & Global Scopes**: Install items for a specific project or for all your projects.
20
20
21
-
### Target Audiences
22
-
-**End Users**: Anyone using Roo Code who wants to customize their experience with new Modes or connect to new AI models and tools via MCPs.
23
-
-**Developers**: Developers who want to share their own Modes and MCPs with the community.
24
-
25
21
---
26
22
27
23
## Getting Started
28
24
29
-
The Roo Code Marketplace is available directly within the Roo Code extension in VS Code. You can access it from the Roo Code sidebar.
25
+
The Roo Code Marketplace is available directly within the Roo Code extension in VS Code. Access it by clicking the marketplace icon <Codiconname="extensions" /> in the top menu bar.
30
26
31
27
:::warning Experimental Feature
32
28
The Marketplace is an experimental feature and must be enabled in settings.
@@ -44,11 +40,15 @@ See the main [Experimental Features](/features/experimental/experimental-feature
44
40
45
41
The marketplace offers two types of items:
46
42
43
+
### MCPs (Model Context Protocol)
44
+
MCPs allow Roo Code to connect to and interact with various AI models, APIs, and other external tools. By installing an MCP, you can configure Roo Code to use different language models (like those from OpenAI, Anthropic, or others) or to integrate with other services. Learn more about [What is MCP?](/features/mcp/what-is-mcp) and [how to use MCP in Roo Code](/features/mcp/using-mcp-in-roo).
45
+
46
+
<imgsrc="/img/marketplace/marketplace-1.png"alt="MCP tab showing available MCPs with install and remove buttons"width="500" />
47
+
47
48
### Modes
48
-
Modes are custom sets of instructions and rules that tailor Roo Code's behavior for specific tasks. For example, you might find a "React Component" mode that is optimized for creating React components, or a "Documentation Writer" mode for writing technical documentation.
49
+
Modes are custom sets of instructions and rules that tailor Roo Code's behavior for specific tasks. For example, you might find a "React Component" mode that is optimized for creating React components, or a "Documentation Writer" mode for writing technical documentation. Learn more about [using modes](/basic-usage/using-modes) and [creating custom modes](/features/custom-modes).
49
50
50
-
### MCPs (Model Context Protocol)
51
-
MCPs allow Roo Code to connect to and interact with various AI models, APIs, and other external tools. By installing an MCP, you can configure Roo Code to use different language models (like those from OpenAI, Anthropic, or others) or to integrate with other services.
51
+
<imgsrc="/img/marketplace/marketplace-4.png"alt="Modes tab showing available modes"width="500" />
52
52
53
53
---
54
54
@@ -59,54 +59,98 @@ When you install an item from the marketplace, you can choose to install it at t
59
59
### Project Installation
60
60
-**Scope**: The item is only available within the current VS Code workspace (your project).
61
61
-**Configuration File**:
62
-
-**Modes**: `.roomodes` in the root of your project.
63
-
-**MCPs**: `.roo/mcp.json` in the root of your project.
62
+
-**MCPs**: [`.roo/mcp.json`](/features/mcp/using-mcp-in-roo#configuring-mcp-servers) in the root of your project.
63
+
-**Modes**: [`.roomodes`](/features/custom-modes#manual-configuration-yaml--json) in the root of your project.
64
64
-**Use Case**: This is useful when an item is specific to a particular project's needs or when you want to share a project-specific configuration with your team.
65
65
66
66
### Global Installation
67
67
-**Scope**: The item is available across all your VS Code workspaces.
68
68
-**Configuration File**:
69
-
-**Modes**: `custom-modes.yaml` in the Roo Code extension's global settings directory.
70
-
-**MCPs**: `mcp-settings.json` in the Roo Code extension's global settings directory.
69
+
-**MCPs**: [`mcp_settings.json`](/features/mcp/using-mcp-in-roo#configuring-mcp-servers) in the Roo Code extension's global settings directory.
70
+
-**Modes**: [`custom_modes.yaml`](/features/custom-modes#manual-configuration-yaml--json) in the Roo Code extension's global settings directory.
71
71
-**Use Case**: This is ideal for items that you want to use in all your projects, such as a favorite Mode or a commonly used MCP.
72
72
73
73
---
74
74
75
75
## Using the Marketplace
76
76
77
77
### Browsing and Filtering
78
-
You can browse all available items in the marketplace view. To find specific items, you can:
78
+
79
+
You can browse all available items in the marketplace view. To find specific items:
79
80
-**Search**: Use the search bar to find items by name or description.
80
-
-**Filter by Type**: Filter to show only Modes or only MCPs.
81
-
-**Filter by Tags**: Filter by tags to find items related to specific technologies or tasks.
81
+
-**Filter by Type**: Show only MCPs or only Modes.
82
+
-**Filter by Tags**: Find items related to specific technologies or tasks.
82
83
83
84
### Installing an Item
85
+
84
86
1. Find the item you want to install.
85
87
2. Click the "Install" button.
86
-
3. If prompted, choose whether to install it for the current **Project** or **Globally**.
87
-
4. For some MCPs, you may be asked to provide additional parameters (see [Parameterized MCPs](#parameterized-mcps)).
88
-
5. Roo Code will automatically add the item to the appropriate configuration file and notify you upon successful installation. The configuration file will be opened for your review.
88
+
3. Choose whether to install it for the current **Project** or **Globally**.
89
+
90
+
#### Installing MCPs
91
+
<imgsrc="/img/marketplace/marketplace-3.png"alt="MCP installation modal showing installation scope and method options"width="500" />
92
+
93
+
For MCPs, you may also need to:
94
+
- Select an installation method (NPX or Docker)
95
+
- Provide additional parameters when prompted (see [Parameterized MCPs](#parameterized-mcps))
For Modes, simply select the installation scope and click Install.
101
+
102
+
5. Roo Code automatically adds the item to the appropriate configuration file. If the file doesn't exist, Roo Code will create it for you. The file is then opened for your review.
89
103
90
104
### Removing an Item
91
-
1. Find the installed item in the marketplace view.
92
-
2. Click the "Uninstall" button.
93
-
3. Roo Code will remove the item from the corresponding configuration file.
105
+
106
+
1. Find the installed item in the marketplace view (installed items show a "Remove" button).
3. Choose to remove from the current project or remove globally.
112
+
4. Roo Code removes the item from the corresponding configuration file.
113
+
114
+
**Note:** The "Remove" button is context-aware. If an item is installed in only one scope (e.g., just for the project), it will be a single-action button. The dropdown menu with "Remove from Project" and "Remove Globally" options only appears if the item is installed in both scopes.
115
+
116
+
**Important:** The removal is immediate after you click the button or select an option from the dropdown. There is no additional confirmation prompt.
94
117
95
118
### Parameterized MCPs
96
-
Some MCPs require you to provide specific information during installation, such as an API key or a URL. These are called "parameterized" MCPs.
97
119
98
-
When you install a parameterized MCP, you will be prompted to enter the required values. This allows for a more flexible and secure way to configure MCPs without hardcoding sensitive information.
120
+
<imgsrc="/img/marketplace/marketplace-6.png"alt="Parameterized MCP installation showing API key input and prerequisites"width="500" />
121
+
122
+
Some MCPs require specific information during installation, such as API keys or URLs. When installing these "parameterized" MCPs, you'll be prompted to:
123
+
- Review any prerequisites (like creating accounts or obtaining API keys)
124
+
- Enter required configuration values
125
+
- Select the installation method if applicable
126
+
127
+
This keeps sensitive information secure and makes configuration more flexible.
99
128
100
129
---
101
130
102
131
## Troubleshooting
103
132
104
133
### Installation Errors
105
-
-**Invalid YAML/JSON**: If you see an error about invalid YAML or JSON, it means the configuration file (`.roomodes`, `.roo/mcp.json`, etc.) has a syntax error. You will need to fix the error in the file before you can install or remove items.
106
-
-**File Not Found**: This error should not typically occur, as Roo Code will create the necessary configuration files if they don't exist.
134
+
-**Invalid YAML/JSON**: The configuration file (`.roomodes`, `.roo/mcp.json`, etc.) has a syntax error. To prevent data loss, Roo Code will not modify a corrupted configuration file. Please fix the syntax error before installing or removing items.
0 commit comments