INSTALL.md•3.81 kB
# Installation Guide
## Running from GitHub Repository
The repository is available at: https://github.com/anand-kamble/mcp-instagram
### Method 1: Clone and Use npx (Recommended)
```bash
# Clone the repository
git clone https://github.com/anand-kamble/mcp-instagram.git
cd mcp-instagram
# Install dependencies
npm install
# Run with npx (builds automatically if needed)
npx mcp-instagram
```
### Method 2: Using npx with Local Path
After cloning, you can run from anywhere:
```bash
# From any directory
npx /absolute/path/to/mcp-instagram
```
### Method 3: Traditional npm Scripts
```bash
git clone https://github.com/anand-kamble/mcp-instagram.git
cd mcp-instagram
npm install
npm run build
npm start
```
## Publishing to npm (For Global npx Access)
### Automated Publishing with GitHub Actions (Recommended)
The repository includes a GitHub Actions workflow that automatically publishes to npm when you create a release.
#### Setup Steps:
1. **Create npm account** (if you don't have one): https://www.npmjs.com/signup
2. **Create npm access token**:
- Go to https://www.npmjs.com/settings/YOUR_USERNAME/tokens
- Click "Generate New Token"
- Select "Automation" token type
- Copy the token
3. **Add token to GitHub Secrets**:
- Go to your repository: https://github.com/anand-kamble/mcp-instagram
- Navigate to Settings → Secrets and variables → Actions
- Click "New repository secret"
- Name: `NPM_TOKEN`
- Value: Paste your npm token
- Click "Add secret"
4. **Create a GitHub Release**:
- Go to your repository → Releases → "Create a new release"
- Tag version: `v1.0.0` (or any version)
- Release title: `v1.0.0`
- Click "Publish release"
- The GitHub Action will automatically publish to npm!
#### Manual Publishing (Alternative)
If you prefer to publish manually:
1. **Login to npm**:
```bash
npm login
```
2. **Update version** (if needed):
```bash
npm version patch # or minor, major
```
3. **Publish the package**:
```bash
npm publish --access public
```
4. **After publishing**, anyone can run:
```bash
npx mcp-instagram
```
Or install globally:
```bash
npm install -g mcp-instagram
mcp-instagram
```
## Configuration for MCP Clients
### For Cursor IDE
Add to `.cursor/mcp.json` or `~/.cursor/mcp.json`:
```json
{
"mcpServers": {
"mcp-instagram": {
"command": "npx",
"args": [
"/absolute/path/to/mcp-instagram"
],
"env": {
"IG_USERNAME": "your_instagram_username",
"IG_PASSWORD": "your_instagram_password"
}
}
}
}
```
### For Claude Desktop
Add to your Claude Desktop config file:
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux:** `~/.config/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"mcp-instagram": {
"command": "npx",
"args": [
"/absolute/path/to/mcp-instagram"
],
"env": {
"IG_USERNAME": "your_instagram_username",
"IG_PASSWORD": "your_instagram_password"
}
}
}
}
```
## Environment Variables
You can set environment variables instead of using the config file:
```bash
export IG_USERNAME="your_instagram_username"
export IG_PASSWORD="your_instagram_password"
npx mcp-instagram
```
## Troubleshooting
### Build Errors
If you encounter build errors, ensure you have the correct Node.js version:
```bash
node --version # Should be 18+ or 20+
```
### Permission Errors
If you get permission errors with npx:
```bash
# Make sure the bin script is executable
chmod +x bin/insta-mcp.js
```
### Module Not Found
If you see module errors, ensure dependencies are installed:
```bash
npm install
```