appmake-mcp-client/README.md

AppMake MCP Server Client for Claude Desktop - Mobile app development tools integration

# @appmake/mcp-client

[![npm version](https://badge.fury.io/js/%40appmake%2Fmcp-client.svg)](https://badge.fury.io/js/%40appmake%2Fmcp-client)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

AppMake MCP Server Client for Claude Desktop - Integrate mobile app development tools directly into Claude

## 🚀 Quick Start

### One-line Installation & Setup

```bash
npx @appmake/mcp-client setup YOUR_API_KEY
```

This command will:
1. Install the MCP client
2. Configure Claude Desktop automatically
3. Test the connection
4. Show you how to use it

## 📦 Installation

### Global Installation (Recommended)

```bash
npm install -g @appmake/mcp-client
```

### Local Installation

```bash
npm install @appmake/mcp-client
```

## ⚙️ Configuration

### Automatic Setup

After installation, run:

```bash
appmake-mcp-setup
```

You'll be prompted for your API key, and the setup will be completed automatically.

### Manual Setup

Add the following to your Claude Desktop config file:

**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Linux**: `~/.config/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "appmake": {
      "command": "npx",
      "args": ["appmake-mcp-client"],
      "env": {
        "APPMAKE_API_KEY": "YOUR_API_KEY_HERE"
      }
    }
  }
}
```

**환경 변수:**
- `APPMAKE_API_KEY` (필수): AppMake MCP API Key
- `MCP_SERVER_URL` (선택): 서버 URL (기본값: https://mcp.appmake.co.kr)

## 🔑 Getting an API Key

1. Visit [AppMake](https://www.appmake.co.kr)
2. Sign up or log in to your account
3. Navigate to API settings
4. Generate your MCP API key

## 🛠️ Available Tools

Once configured, Claude will have access to these AppMake tools:

### App Management
- `CreateApp` - Create a new mobile app project
- `GetAppList` - List all your apps
- `GetAppInfo` - Get detailed app information
- `UpdateAppInfo` - Update app configuration

### File Management
- `UploadFile` - Upload files to your app
- `DownloadFile` - Download app resources
- `DeleteFile` - Remove files from your app

### Build & Deployment
- `BuildApp` - Build your app for iOS/Android
- `GetBuildStatus` - Check build progress
- `DeployApp` - Deploy to app stores

### Analytics & Monitoring
- `GetAppStats` - View app statistics
- `GetUserAnalytics` - User behavior analytics
- `GetCrashReports` - Access crash reports

## 💡 Usage Examples

After setup, restart Claude Desktop and you can:

```
"Create a new mobile app called MyAwesomeApp"
"Show me all my apps"
"Build MyApp for Android"
"Upload this icon to MyApp"
"Check the build status of MyApp"
```

## 🔧 Environment Variables

You can customize the behavior with these environment variables:

- `MCP_SERVER_URL` - MCP server URL (default: https://mcp.appmake.co.kr)
- `MCP_API_KEY` - Your AppMake API key
- `DEBUG` - Enable debug mode (true/false)
- `TIMEOUT` - Request timeout in ms (default: 30000)

## 📝 Troubleshooting

### Claude Desktop doesn't recognize the MCP server

1. Make sure Claude Desktop is completely closed
2. Verify the config file is in the correct location
3. Check that the API key is valid
4. Restart Claude Desktop

### Connection errors

```bash
# Test your connection
npx @appmake/mcp-client test
```

### Debug mode

Enable debug output by setting the DEBUG environment variable:

```json
{
  "mcpServers": {
    "appmake": {
      "command": "npx",
      "args": ["@appmake/mcp-client"],
      "env": {
        "MCP_API_KEY": "YOUR_API_KEY",
        "DEBUG": "true"
      }
    }
  }
}
```

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## 📄 License

MIT License - see [LICENSE](LICENSE) file for details.

## 🔗 Links

- [AppMake Website](https://www.appmake.co.kr)
- [Documentation](https://docs.appmake.co.kr)
- [GitHub Repository](https://github.com/appmake/mcp-client)
- [NPM Package](https://www.npmjs.com/package/@appmake/mcp-client)
- [Issue Tracker](https://github.com/appmake/mcp-client/issues)

## 📞 Support

- Email: support@appmake.co.kr
- Documentation: https://docs.appmake.co.kr
- Community Forum: https://community.appmake.co.kr

---

Made with ❤️ by AppMake Team