Skip to content

Commit b94a85f

Browse files
committed
feat: add windows-mcp marketplace example configuration
- Created marketplace-examples directory for MCP server submissions - Added windows-mcp.yaml with complete configuration following marketplace schema - Included multiple installation methods (uvx, pip, development) - Added comprehensive documentation explaining marketplace submission process - Addresses #7613 by providing reference configuration for windows-mcp This example can be used by maintainers to add windows-mcp to the marketplace backend API.
1 parent 5196c75 commit b94a85f

File tree

2 files changed

+157
-0
lines changed

2 files changed

+157
-0
lines changed

marketplace-examples/README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Marketplace Examples
2+
3+
This directory contains example configurations for items that could be added to the Roo Code Marketplace.
4+
5+
## Purpose
6+
7+
Since the Roo Code Marketplace items are managed through an external API (`https://api.roocode.com/api/marketplace/`), this directory serves as:
8+
9+
1. **Reference examples** for new marketplace submissions
10+
2. **Documentation** of the expected format for MCP servers and modes
11+
3. **Testing ground** for validating configurations before they're added to the marketplace backend
12+
13+
## Structure
14+
15+
```
16+
marketplace-examples/
17+
├── mcp-servers/ # Example MCP server configurations
18+
│ └── windows-mcp.yaml
19+
└── modes/ # Example custom mode configurations (future)
20+
```
21+
22+
## MCP Server Configuration Format
23+
24+
MCP server configurations follow the schema defined in `packages/types/src/marketplace.ts`. Each configuration should include:
25+
26+
### Required Fields
27+
28+
- `id`: Unique identifier for the MCP server
29+
- `name`: Display name
30+
- `description`: Clear description of what the server does
31+
- `url`: GitHub repository or project URL
32+
- `content`: Installation configuration(s)
33+
34+
### Optional Fields
35+
36+
- `author`: Creator's name
37+
- `authorUrl`: Link to author's profile
38+
- `tags`: Array of relevant tags for discovery
39+
- `prerequisites`: System requirements or dependencies
40+
- `parameters`: Configurable options for the server
41+
42+
## Example: Windows MCP
43+
44+
The `mcp-servers/windows-mcp.yaml` file demonstrates a complete configuration for the Windows MCP server, which allows AI agents to control Windows desktop applications, browsers, and file operations.
45+
46+
### Key Features Highlighted:
47+
48+
- Multiple installation methods (uvx, pip, development)
49+
- Clear prerequisites for each installation method
50+
- Optional configuration parameters
51+
- Comprehensive tagging for discoverability
52+
53+
## How to Submit to Marketplace
54+
55+
Currently, marketplace items are managed through the Roo Code backend API. To submit a new MCP server:
56+
57+
1. Create a configuration file following the examples in this directory
58+
2. Test the configuration locally to ensure it works
59+
3. Submit an issue using the [Marketplace Feedback template](https://github.com/RooCodeInc/Roo-Code/issues/new?template=marketplace.yml)
60+
4. Include your configuration file in the issue
61+
5. The Roo Code team will review and add it to the marketplace backend
62+
63+
## Testing Locally
64+
65+
While these configurations cannot be directly used in the extension (as it fetches from the API), you can manually test MCP servers by:
66+
67+
1. Installing them according to their documentation
68+
2. Adding them to your `.roo/mcp.json` (project-level) or global MCP settings
69+
3. Verifying they work correctly with Roo Code
70+
71+
## Contributing
72+
73+
If you'd like to add more example configurations:
74+
75+
1. Follow the existing format and structure
76+
2. Ensure all required fields are present
77+
3. Test the installation instructions
78+
4. Submit a PR with your example configuration
79+
80+
## Notes
81+
82+
- These examples are for reference only and don't automatically appear in the marketplace
83+
- The actual marketplace data is served from `https://api.roocode.com/api/marketplace/mcps`
84+
- Changes to the marketplace require backend updates by the Roo Code team
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Windows MCP Server Configuration
2+
# This is a sample configuration for adding windows-mcp to the MCP Marketplace
3+
# Repository: https://github.com/CursorTouch/Windows-MCP
4+
5+
id: windows-mcp
6+
name: Windows MCP
7+
description: Control Windows PC with an AI agent - automate desktop apps, web browsers, file operations, and more. Perfect for testing applications, automating workflows, and controlling VS Code itself.
8+
author: CursorTouch
9+
authorUrl: https://github.com/CursorTouch
10+
url: https://github.com/CursorTouch/Windows-MCP
11+
tags:
12+
- automation
13+
- windows
14+
- desktop-control
15+
- testing
16+
- browser-automation
17+
- file-management
18+
prerequisites:
19+
- Windows operating system
20+
- Python 3.8 or higher
21+
- pip package manager
22+
23+
# Installation methods for different scenarios
24+
content:
25+
- name: Standard Installation
26+
content: |
27+
{
28+
"command": "uvx",
29+
"args": ["--from", "windows-mcp", "windows-mcp"],
30+
"env": {}
31+
}
32+
prerequisites:
33+
- uvx installed (pip install uvx)
34+
35+
- name: Python Package Installation
36+
content: |
37+
{
38+
"command": "python",
39+
"args": ["-m", "windows_mcp"],
40+
"env": {}
41+
}
42+
prerequisites:
43+
- pip install windows-mcp
44+
45+
- name: Development Installation
46+
content: |
47+
{
48+
"command": "python",
49+
"args": ["path/to/windows-mcp/main.py"],
50+
"env": {
51+
"PYTHONPATH": "path/to/windows-mcp"
52+
}
53+
}
54+
prerequisites:
55+
- Clone repository: git clone https://github.com/CursorTouch/Windows-MCP.git
56+
- Install dependencies: pip install -r requirements.txt
57+
58+
# Optional parameters for configuration
59+
parameters:
60+
- name: Screenshot Directory
61+
key: screenshot_dir
62+
placeholder: "C:\\Screenshots"
63+
optional: true
64+
65+
- name: Automation Speed
66+
key: automation_speed
67+
placeholder: "normal"
68+
optional: true
69+
70+
- name: Enable Logging
71+
key: enable_logging
72+
placeholder: "false"
73+
optional: true

0 commit comments

Comments
 (0)