Skip to content

Simplify install instructions for better onboarding #80

@greynewell

Description

@greynewell

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

  1. Quick Setup (Recommended) - bash script with curl | bash
  2. Manual Install - npm install or npx
  3. Large timeout warning section before showing basic usage

Proposed Improvements

  1. Simplify the default path: Put the simplest install method first (npm/npx) without any timeout concerns
  2. Progressive disclosure: Show users how to get started quickly, then expand on advanced topics like timeout configuration
  3. Better organization:
    • Basic install (1-2 commands)
    • Basic usage example
    • Advanced configuration (timeouts, subdirectories, etc.)
  4. 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-server

Or install globally:

npm install -g @supermodeltools/mcp-server

Quick Start

[Add to your MCP client config]

Advanced Configuration

Configuring timeouts for large repositories [Current timeout documentation]
```

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions