INSTALL.md•3.1 kB
# Installation Guide
## Quick Install
### Option 1: From Source (Recommended)
1. **Clone or download this repository**
2. **Install dependencies and build**:
```bash
cd opus-mcp-server
npm install
npm run build
```
3. **Run the setup wizard**:
```bash
npm run setup
```
The setup wizard will:
- Ask for your Opus API key
- Detect your MCP client (Claude Desktop, Factory/Droid)
- Automatically configure the connection
4. **Restart your MCP client** (Claude Desktop or Droid)
### Option 2: Manual Installation
1. **Install and build**:
```bash
npm install
npm run build
```
2. **Get your API key**:
- Go to Opus Platform → My Organization → Settings → API Keys
- Click "Generate API Key"
- Copy the key (shown only once!)
3. **Configure your MCP client**:
**For Claude Desktop:**
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
```json
{
"mcpServers": {
"opus": {
"command": "node",
"args": ["/absolute/path/to/opus-mcp-server/build/index.js"],
"env": {
"OPUS_SERVICE_KEY": "your_api_key_here"
}
}
}
}
```
**For Factory/Droid:**
Edit `~/.factory/mcp.json`:
```json
{
"mcpServers": {
"opus": {
"command": "node",
"args": ["/absolute/path/to/opus-mcp-server/build/index.js"],
"env": {
"OPUS_SERVICE_KEY": "your_api_key_here"
}
}
}
}
```
4. **Restart your MCP client**
## Testing the Installation
Run the connection test:
```bash
npm run test-connection
```
This will verify:
- Your API key is valid
- You can connect to Opus API
- (Optional) Test a specific workflow
## Requirements
- Node.js >= 18.0.0
- npm or yarn
- Valid Opus API key
## Troubleshooting
**"OPUS_SERVICE_KEY environment variable is required"**
- Ensure the API key is correctly set in your MCP client configuration
- Check for typos in the configuration file
**"Build files not found"**
- Run `npm run build` before setting up
- Check that the `build/` directory exists
**"Permission denied"**
- Make sure the build/index.js file is executable
- Run: `chmod +x build/index.js`
**Connection test fails**
- Verify your internet connection
- Check that the API key is valid
- Try accessing https://operator.opus.com in your browser
## Distribution
To share this MCP server:
1. **Create a distributable package**:
```bash
npm pack
```
This creates `opus-mcp-server-1.0.0.tgz`
2. **Share the package**:
- Upload to npm registry (if publishing)
- Share the .tgz file directly
- Share the GitHub repository
3. **Install from package**:
```bash
npm install opus-mcp-server-1.0.0.tgz
npm run setup
```
## Next Steps
After installation:
1. Find your workflow ID from Opus platform URL
2. Use the MCP tools in your AI client
3. See USAGE_EXAMPLE.md for practical examples
4. Check README.md for complete tool documentation