|
| 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 |
0 commit comments