-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Problem
The current install instructions prioritize the setup script ("Quick Setup") over the simpler npm commands, which may intimidate new users. Additionally, the prominent timeout configuration warnings before basic usage might overwhelm users who just want to try the tool.
Current Structure
- Quick Setup (Recommended) - bash script with curl | bash
- Manual Install - npm install or npx
- Large timeout warning section before showing basic usage
Proposed Improvements
- Simplify the default path: Put the simplest install method first (npm/npx) without any timeout concerns
- Progressive disclosure: Show users how to get started quickly, then expand on advanced topics like timeout configuration
- Better organization:
- Basic install (1-2 commands)
- Basic usage example
- Advanced configuration (timeouts, subdirectories, etc.)
- Clearer naming: "Quick Setup" currently isn't the quickest - it runs a bash script. The "Manual Install" is actually faster.
Success Criteria
- New users can install and try the tool in under 1 minute
- Advanced configuration is available but doesn't block getting started
- Installation flow feels natural and not intimidating
Example Structure
## Install
```bash
npx @supermodeltools/mcp-serverOr install globally:
npm install -g @supermodeltools/mcp-serverQuick Start
[Add to your MCP client config]
Advanced Configuration
Configuring timeouts for large repositories
[Current timeout documentation]Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request