From 31d0e9b97feac3fdfbccbc656ff995d3829a65ea Mon Sep 17 00:00:00 2001 From: kappa Date: Sun, 10 Aug 2025 21:53:37 +0900 Subject: [PATCH] Fix npm package deployment and usage documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🔧 Resolve npmjs deployment issue: - Add npm global installation guide (npm install -g @ironclads/incus-mcp) - Update Claude Desktop configuration with two options - Fix mcp-config-example.json to use global binary - Update CLAUDE.md with correct remote server list (removed lambda) ✅ npm package now works correctly with global installation 📚 Documentation updated with clear installation options 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- CLAUDE.md | 4 ++-- README.md | 25 +++++++++++++++++++++++++ mcp-config-example.json | 3 +-- test-npmjs/package.json | 16 ++++++++++++++++ 4 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 test-npmjs/package.json diff --git a/CLAUDE.md b/CLAUDE.md index 6a04892..3480b72 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -56,8 +56,8 @@ The `.claude/settings.local.json` file enables all configured MCP servers for Cl ### Remote Server Support The server automatically works with all configured Incus remotes: -- **remote1**: Example primary remote server -- **remote2**: Example secondary remote server +- **jp1**: Japan remote server (100.109.123.1:8443) +- **kr1**: Korea remote server (100.84.111.28:8443) - **local**: Local Incus daemon - **images**: LinuxContainers.org image server - **docker**: Docker Hub OCI registry diff --git a/README.md b/README.md index c113558..99b58b6 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,16 @@ Seamlessly works with all your configured Incus remotes: ## 🚀 Quick Start +### Installation from NPM (Recommended) +```bash +# Global installation (recommended for Claude Desktop) +npm install -g @ironclads/incus-mcp + +# Verify installation +incus-mcp --version +which incus-mcp +``` + ### Installation from Source ```bash # Clone the repository @@ -78,6 +88,21 @@ npm start Add to your Claude Desktop MCP configuration (`~/.config/claude-desktop/config.json`): +#### Option 1: Using Global NPM Installation (Recommended) +```json +{ + "mcpServers": { + "incus": { + "command": "incus-mcp", + "env": { + "PATH": "/usr/local/bin:/opt/homebrew/bin:/usr/bin:/bin" + } + } + } +} +``` + +#### Option 2: Using Local Installation ```json { "mcpServers": { diff --git a/mcp-config-example.json b/mcp-config-example.json index 4e5054b..8043649 100644 --- a/mcp-config-example.json +++ b/mcp-config-example.json @@ -1,8 +1,7 @@ { "mcpServers": { "incus": { - "command": "node", - "args": ["/Users/kaffa/mcp-servers/incus-mcp/build/index.js"], + "command": "incus-mcp", "env": { "PATH": "/usr/local/bin:/opt/homebrew/bin:/usr/bin:/bin" } diff --git a/test-npmjs/package.json b/test-npmjs/package.json new file mode 100644 index 0000000..7f2b3fb --- /dev/null +++ b/test-npmjs/package.json @@ -0,0 +1,16 @@ +{ + "name": "test-npmjs", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "type": "commonjs", + "dependencies": { + "@ironclads/incus-mcp": "^0.1.6" + } +}