regen-koi-mcp 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +72 -15
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -4,29 +4,86 @@ Access Regen Network's Knowledge Organization Infrastructure (KOI) through Model
4
4
 
5
5
  ## 🚀 Quick Start
6
6
 
7
+ ### One-Line Install (Easiest!)
8
+
7
9
  ```bash
8
- # Clone the repository
9
- git clone https://github.com/regen-network/regen-koi-mcp
10
- cd regen-koi-mcp
10
+ curl -fsSL https://raw.githubusercontent.com/gaiaaiagent/regen-koi-mcp/main/install.sh | bash
11
+ ```
12
+
13
+ This automatically configures Claude Desktop and Claude Code CLI. Just restart and you're done! 🎉
14
+
15
+ ---
16
+
17
+ ### Option 1: NPM (Recommended - Auto-Updates)
18
+
19
+ **No installation needed!** Just configure Claude Desktop with:
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ "regen-koi": {
25
+ "command": "npx",
26
+ "args": ["-y", "regen-koi-mcp@latest"],
27
+ "env": {
28
+ "KOI_API_ENDPOINT": "https://regen.gaiaai.xyz/api/koi"
29
+ }
30
+ }
31
+ }
32
+ }
33
+ ```
34
+
35
+ **Benefits:**
36
+ - ✅ Automatic updates - get new features without doing anything
37
+ - ✅ No git clone, no build, no maintenance
38
+ - ✅ Always uses the latest version
39
+ - ✅ Works immediately
40
+
41
+ Config file locations:
42
+ - **Mac**: `~/Library/Application Support/Claude/claude_desktop_config.json`
43
+ - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
44
+ - **Linux**: `~/.config/Claude/claude_desktop_config.json`
45
+
46
+ Then restart Claude Desktop and you're done! 🎉
47
+
48
+ **For existing git users**: See the migration section below for a simple one-line script to switch to npx.
49
+
50
+ ---
51
+
52
+ ### 🔄 Migrating from Git Installation
53
+
54
+ If you previously installed via `git clone`, switch to npx for automatic updates:
11
55
 
12
- # Run the setup script (installs everything and configures clients)
13
- ./setup.sh
56
+ ```bash
57
+ curl -fsSL https://raw.githubusercontent.com/gaiaaiagent/regen-koi-mcp/main/migrate.sh | bash
14
58
  ```
15
59
 
16
- That's it! The setup script will:
17
- - ✅ Install Node.js dependencies
18
- - ✅ Setup Python environment (optional, for advanced digest features)
19
- - ✅ Build the TypeScript code
20
- - ✅ Configure Claude Desktop & VSCode automatically
60
+ **What this does**:
61
+ - ✅ Backs up your existing config
62
+ - ✅ Updates `command: "node"` `command: "npx"`
63
+ - ✅ Updates `args` to use `regen-koi-mcp@latest`
64
+ - ✅ Configures Claude Code CLI too
65
+ - ✅ You get automatic updates forever!
66
+
67
+ After migration, you can safely delete your old git clone directory.
68
+
69
+ ---
70
+
71
+ ### Option 2: Local Development (Git Clone)
21
72
 
22
- Just restart Claude Desktop or reload VSCode to see the tools.
73
+ For contributors or local development only:
23
74
 
24
- ### Requirements
75
+ ```bash
76
+ git clone https://github.com/gaiaaiagent/regen-koi-mcp
77
+ cd regen-koi-mcp
78
+ npm install
79
+ npm run build
80
+ ```
25
81
 
26
- - **Node.js 16+**: [Download here](https://nodejs.org) - **Required**
27
- - **Python 3.8+**: [Download here](https://python.org) - **Optional** (only for advanced local digest generation)
82
+ Then manually configure your MCP client to point to the local `dist/index.js`.
28
83
 
29
- The setup script will check for these and guide you if they're missing.
84
+ **Requirements:**
85
+ - **Node.js 16+**: [Download here](https://nodejs.org)
86
+ - **Python 3.8+**: [Download here](https://python.org) - Optional (only for advanced local digest generation)
30
87
 
31
88
  ## 🏠 Deployment Options
32
89
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "regen-koi-mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "MCP server for accessing Regen Network's KOI (Knowledge Organization Infrastructure) system",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",
@@ -36,6 +36,7 @@
36
36
  ],
37
37
  "author": "Regen Network",
38
38
  "license": "MIT",
39
+ "readme": "README.md",
39
40
  "repository": {
40
41
  "type": "git",
41
42
  "url": "https://github.com/gaiaaiagent/regen-koi-mcp.git"
@@ -47,7 +48,8 @@
47
48
  "dependencies": {
48
49
  "@modelcontextprotocol/sdk": "^1.20.0",
49
50
  "axios": "^1.7.7",
50
- "dotenv": "^16.4.5"
51
+ "dotenv": "^16.4.5",
52
+ "regen-koi-mcp": "^1.0.0"
51
53
  },
52
54
  "devDependencies": {
53
55
  "@types/node": "^20.16.11",