repo-analysis-mcp/README.md

Repository Analysis MCP for analyzing GitHub repositories

# Repository Analysis MCP for Cursor

This is a custom MCP (Model Control Protocol) implementation for analyzing GitHub repositories directly in Cursor.

## Features

- Get basic repository information
- Retrieve file contents from repositories
- List files in directories
- Analyze repository architecture and dependencies

## Setup Instructions

1. **Install Dependencies**:

   ```
   npm install
   ```

2. **Configure GitHub Token**:

   - Create a GitHub personal access token with `repo` scope
   - Update the `GITHUB_TOKEN` in `mcp-config.json` with your token

3. **Configure Repositories**:
   - Set `SOURCE_REPO` to the main repository you want to analyze (format: `owner/repo`)
   - Set `TARGET_REPOS` to comma-separated list of repositories to compare (format: `owner/repo1,owner/repo2`)

## Adding to Cursor

1. Open Cursor
2. Go to Settings > MCPs
3. Click "Add MCP"
4. Select "Import from file"
5. Choose the `mcp-config.json` file from this directory

## Available Tools

- **get_repo_info**: Get basic information about a GitHub repository
- **get_file_content**: Get the content of a file from a GitHub repository
- **list_files**: List files in a directory of a GitHub repository
- **analyze_repository**: Analyze a GitHub repository for patterns and architecture

## Example Usage

Once configured in Cursor, you can use the MCP by typing commands like:

```
/Repository Analysis analyze_repository facebook/react
```

Or:

```
/Repository Analysis get_file_content facebook/react package.json
```

## Troubleshooting

- If you encounter permission issues, make sure the script is executable:
  ```
  chmod +x cursor-mcp.js
  ```
- If you see connection errors, verify your GitHub token is valid and has the necessary permissions
- Make sure the path in `mcp-config.json` points to the correct location of `cursor-mcp.js`

## License

MIT