Opus MCP Server

# Package Contents & Structure ## What's Included ### Core Files - **`build/index.js`** - Main MCP server executable - **`build/index.d.ts`** - TypeScript declarations - **`package.json`** - Package configuration and dependencies - **`LICENSE`** - MIT License ### Setup & Utility Scripts - **`scripts/setup.js`** - Interactive configuration wizard - **`scripts/test-connection.js`** - API connection tester ### Documentation - **`README.md`** - Main documentation and API reference - **`QUICKSTART.md`** - 3-minute setup guide - **`INSTALL.md`** - Detailed installation instructions - **`USAGE_EXAMPLE.md`** - Practical usage examples - **`DISTRIBUTION.md`** - Sharing and distribution guide - **`WORKFLOW_INFO.md`** - Specific workflow information ### API Documentation (Reference) - **`opus-00-get-workflow-details.md`** - Get workflow schema - **`opus-01-introduction.md`** - API introduction - **`opus-02-quickstart-guide.md`** - API quick start - **`opus-03-initiate-job.md`** - Job initiation - **`opus-04-uploading-files-for-job-inputs.md`** - File uploads - **`opus-05-execute-job.md`** - Job execution - **`opus-06-get-job-execution-status.md`** - Status monitoring - **`opus-07-get-job-execution-results.md`** - Results retrieval - **`opus-08-job-audit-log.md`** - Audit logs - **`opus-09-appendix-postman-collection.md`** - Postman collection ## File Sizes - **Package tarball**: ~7.2 KB (compressed) - **Unpacked size**: ~26.8 KB (without node_modules) - **With dependencies**: ~2-3 MB (includes node_modules) ## Dependencies ### Runtime Dependencies - `@modelcontextprotocol/sdk` - MCP protocol implementation - `axios` - HTTP client for API requests - `form-data` - File upload handling ### Development Dependencies - `typescript` - TypeScript compiler - `@types/node` - Node.js type definitions ## Installation Methods ### 1. From Tarball ```bash npm install opus-mcp-server-1.0.0.tgz ``` ### 2. From npm (if published) ```bash npm install opus-mcp-server ``` ### 3. From Source ```bash git clone <repository> npm install npm run build ``` ## Quick Commands ### Setup ```bash npm run setup # Interactive configuration wizard ``` ### Testing ```bash npm run test-connection # Test API connectivity ``` ### Building ```bash npm run build # Compile TypeScript npm run watch # Watch mode for development ``` ### Distribution ```bash npm pack # Create tarball for sharing ``` ## What You Need To use this package, you need: 1. **Node.js** >= 18.0.0 2. **npm** (comes with Node.js) 3. **Opus API Key** (from Opus Platform) 4. **MCP-compatible client** (Claude Desktop, Factory/Droid, etc.) ## Supported Platforms - ✅ macOS (Intel & Apple Silicon) - ✅ Linux (x64, ARM) - ✅ Windows (x64) ## File Structure ``` opus-mcp-server/ ├── 📦 Package Files │ ├── package.json # Dependencies & scripts │ ├── LICENSE # MIT license │ └── opus-mcp-server-1.0.0.tgz # Distributable package │ ├── 🔨 Build Output │ └── build/ │ ├── index.js # Compiled server │ └── index.d.ts # Type definitions │ ├── 🛠️ Scripts │ └── scripts/ │ ├── setup.js # Configuration wizard │ └── test-connection.js # Connection tester │ ├── 📚 Documentation │ ├── README.md # Main docs │ ├── QUICKSTART.md # Quick setup │ ├── INSTALL.md # Installation guide │ ├── USAGE_EXAMPLE.md # Examples │ ├── DISTRIBUTION.md # Sharing guide │ ├── WORKFLOW_INFO.md # Workflow info │ └── PACKAGE_CONTENTS.md # This file │ ├── 📖 API Reference │ └── opus-*.md # API documentation files │ └── 💻 Source (for development) └── src/ └── index.ts # TypeScript source ``` ## Configuration Files Created When you run `npm run setup`, it creates/modifies: ### For Claude Desktop - `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) - `%APPDATA%\Claude\claude_desktop_config.json` (Windows) ### For Factory/Droid - `~/.factory/mcp.json` These files contain: - Path to MCP server executable - Your Opus API key (keep secure!) - Server configuration ## Security Notes **What's Safe to Share:** - ✅ Package tarball (opus-mcp-server-1.0.0.tgz) - ✅ Source code - ✅ Documentation files **Never Share:** - ❌ Your Opus API key - ❌ Configuration files with credentials - ❌ `.env` files with secrets ## Getting Started 1. **Install** using any method above 2. **Run** `npm run setup` to configure 3. **Restart** your MCP client 4. **Test** with `npm run test-connection` 5. **Use** the tools in your AI conversations! ## Need Help? - **Quick Setup**: Read QUICKSTART.md - **Installation Issues**: Check INSTALL.md - **Usage Examples**: See USAGE_EXAMPLE.md - **API Reference**: Check README.md - **Distribution**: Review DISTRIBUTION.md