reporead

# RepoRead — AI Repository Analysis

RepoRead is an AI-powered platform that analyzes GitHub repositories and generates documentation, technical architecture breakdowns, security audits, visual diagrams, and LLM-optimized summaries. Connect via the MCP server (preferred) or REST API to analyze any public GitHub repository.

## Quick Start

### 1. Get an API Key

Sign up at [reporead.com](https://www.reporead.com) and create an API key at [reporead.com/settings](https://www.reporead.com/settings). Keys use the `rrk_` prefix.

### 2. Set the Environment Variable

```bash
export REPOREAD_API_KEY="rrk_your_api_key_here"
```

Add to your shell profile (`~/.zshrc`, `~/.bashrc`) to persist across sessions.

### 3. Verify Connection

```bash
bash {baseDir}/scripts/check-connection.sh
```

This confirms your API key is valid and shows your current token balance.

### 4. Connect the MCP Server (Recommended)

Add to your MCP configuration (e.g. `claude_desktop_config.json`, `.mcp.json`):

```json
{
  "mcpServers": {
    "reporead": {
      "type": "streamable-http",
      "url": "https://api.reporead.com/mcp",
      "headers": {
        "Authorization": "Bearer rrk_your_api_key_here"
      }
    }
  }
}
```

Replace `rrk_your_api_key_here` with your actual API key.

## MCP Tools

When the MCP server is connected, these tools are available:

| Tool | Description |
|------|-------------|
| `import_repository(github_url)` | Import a GitHub repo by URL |
| `list_repositories(page?, per_page?)` | List imported repos |
| `get_repository(repository_id)` | Get repo details by ID |
| `start_analysis(repository_id, analysis_type, branch?)` | Queue an analysis job |
| `list_analyses(page?, per_page?, repository_id?, status?, analysis_type?)` | List jobs with filters |
| `get_analysis(analysis_id)` | Get full analysis results |
| `get_analysis_status(analysis_id)` | Lightweight status poll |
| `get_token_balance()` | Check available tokens and tier |

## REST API Fallback

If the MCP serv...