Skip to content

Commit 1d202e3

Browse files
Merge pull request #21 from iExecBlockchainComputing/feature/npm-docker-publishing
add config npm & docker publishing
2 parents e83d4f4 + 661f5e7 commit 1d202e3

File tree

7 files changed

+80
-117
lines changed

7 files changed

+80
-117
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Publish Docker Image
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish:
9+
uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/docker-build.yml@docker-build-v1.1.1
10+
with:
11+
dockerfile: "Dockerfile"
12+
image-name: "iexec/mcp-server"
13+
secrets:
14+
dockerhub-username: ${{ secrets.dockerhub_user }}
15+
dockerhub-pat: ${{ secrets.dockerhub-pat }}

.github/workflows/publish-npm.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Publish NPM Package
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
publish:
9+
uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/publish-npm.yml@publish-npm-v1.2.0
10+
secrets:
11+
npm-token: ${{ secrets.npm-token }}

.github/workflows/publish.yml

Lines changed: 0 additions & 71 deletions
This file was deleted.

README.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
## 1. Wallet Setup
88

9+
**Prerequisites:**
10+
11+
- [Node.js](https://nodejs.org/) (version 18 or higher)
12+
- npm (version 9 or higher)
13+
914
**Option 1: Create a new wallet with iExec**
1015

1116
```bash
@@ -28,6 +33,8 @@ Find your wallet at:
2833
```
2934
- Or use your raw private key directly in Claude configuration.
3035

36+
> **Important:** All sensitive configuration (PRIVATE_KEY_PATH or PRIVATE_KEY) is used only at the local MCP server level and is **never** transmitted to Claude or any other AI model. This information remains strictly confidential on your local machine.
37+
3138
## 2. Getting Started
3239

3340
Complete the **Wallet Setup** above, then choose your preferred installation method:
@@ -64,9 +71,9 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
6471
"mcpServers": {
6572
"iexec-mcp-server": {
6673
"command": "npx",
67-
"args": ["-y", "@paypes/mcp-server@latest"],
74+
"args": ["-y", "@iexec/mcp-server@latest"],
6875
"env": {
69-
"PRIVATE_KEY_PATH": "/absolute/path/to/wallet.json"
76+
"PRIVATE_KEY_PATH": "/ABSOLUTE/PATH/TO/YOUR/KEYSTORE/wallet.json"
7077
}
7178
}
7279
}
@@ -80,7 +87,7 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
8087
"mcpServers": {
8188
"iexec-mcp-server": {
8289
"command": "npx",
83-
"args": ["-y", "@paypes/mcp-server@latest"],
90+
"args": ["-y", "@iexec/mcp-server@latest"],
8491
"env": {
8592
"PRIVATE_KEY": "0xYOUR_PRIVATE_KEY"
8693
}
@@ -113,13 +120,13 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
113120
_With wallet file (from Section 1):_
114121

115122
```bash
116-
claude mcp add iexec-mcp --env PRIVATE_KEY_PATH=~/Library/Ethereum/keystore/wallet.json -- npx @paypes/mcp-server@latest run
123+
claude mcp add iexec-mcp --env PRIVATE_KEY_PATH=/ABSOLUTE/PATH/TO/YOUR/KEYSTORE/wallet.json -- npx @iexec/mcp-server@latest run
117124
```
118125

119126
_With direct private key:_
120127

121128
```bash
122-
claude mcp add iexec-mcp --env PRIVATE_KEY=0xYOUR_PRIVATE_KEY -- npx @paypes/mcp-server@latest run
129+
claude mcp add iexec-mcp --env PRIVATE_KEY=0xYOUR_PRIVATE_KEY -- npx @iexec/mcp-server@latest run
123130
```
124131

125132
3. **Run Claude:**
@@ -136,26 +143,23 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
136143
- [Node.js](https://nodejs.org/) (version 18 or higher)
137144
- npm (version 9 or higher)
138145
- [Git](https://git-scm.com/)
139-
- [Claude Desktop](https://claude.ai/download) (optional)
146+
- [Claude Desktop](https://claude.ai/download)
140147

141148
**Setup Steps:**
142149

143150
### 5.1. Clone, Install, and Build
144151

145152
```bash
146-
git clone https://github.com/iexec-blockchain-computing/iexec-mcp-server.git
153+
git clone https://github.com/iexecBlockchainComputing/iexec-mcp-server.git
147154
cd iexec-mcp-server
148155
npm install
149156
npm run build
150157
```
151158

152-
> All configuration (PRIVATE_KEY_PATH or PRIVATE_KEY) is set in the Claude config, not as shell variables.
153-
154-
### 5.2. Integrate with Claude Desktop (Optional)
159+
### 5.2. Integrate with Claude Desktop
155160

156161
1. **Open Claude Desktop configuration:**
157162

158-
- Download and install [Claude Desktop](https://claude.ai/download) if you haven't already
159163
- Open Claude Desktop → **Developer > Edit Config**
160164

161165
2. **Add configuration to `claude_desktop_config.json`:**
@@ -167,9 +171,9 @@ npm run build
167171
"mcpServers": {
168172
"iexec-mcp-server": {
169173
"command": "node",
170-
"args": ["/absolute/path/to/iexec-mcp-server/build/index.js"],
174+
"args": ["/ABSOLUTE/PATH/TO-IEXEC-MCP-SERVER-REPO/build/index.js"],
171175
"env": {
172-
"PRIVATE_KEY_PATH": "/absolute/path/to/wallet.json"
176+
"PRIVATE_KEY_PATH": "/ABSOLUTE/PATH/TO/wallet.json"
173177
}
174178
}
175179
}
@@ -183,7 +187,7 @@ npm run build
183187
"mcpServers": {
184188
"iexec-mcp-server": {
185189
"command": "node",
186-
"args": ["/absolute/path/to/iexec-mcp-server/build/index.js"],
190+
"args": ["/ABSOLUTE/PATH/TO-IEXEC-MCP-SERVER-REPO/build/index.js"],
187191
"env": {
188192
"PRIVATE_KEY": "0xYOUR_PRIVATE_KEY"
189193
}
@@ -201,29 +205,11 @@ npm run build
201205
**Prerequisites:**
202206

203207
- [Docker](https://www.docker.com/get-started) installed
204-
- [Claude Desktop](https://claude.ai/download) (optional)
205-
206-
**Setup Steps:**
207-
208-
### 6.1. Run the Server with Docker
209-
210-
_With wallet file (from Section 1):_
211-
212-
```bash
213-
docker run -i --rm --init -e PRIVATE_KEY_PATH=/absolute/path/to/wallet.json iexec/mcp-server:latest
214-
```
215-
216-
_With direct private key:_
217-
218-
```bash
219-
docker run -i --rm --init -e PRIVATE_KEY=0xYOUR_PRIVATE_KEY iexec/mcp-server:latest
220-
```
221-
222-
### 6.2. Integrate with Claude Desktop (Optional)
208+
- [Claude Desktop](https://claude.ai/download)
223209

224210
1. **Open Claude Desktop configuration:**
225211

226-
- Open Claude Desktop → **Developer > Edit Config**
212+
- Open Claude Desktop → **Developer > Edit Config**
227213

228214
2. **Add configuration to `claude_desktop_config.json`:**
229215

@@ -239,9 +225,11 @@ docker run -i --rm --init -e PRIVATE_KEY=0xYOUR_PRIVATE_KEY iexec/mcp-server:lat
239225
"-i",
240226
"--rm",
241227
"--init",
228+
"-v",
229+
"/ABSOLUTE/PATH/TO/YOUR/KEYSTORE:/app/keystore",
242230
"-e",
243-
"PRIVATE_KEY_PATH=/absolute/path/to/wallet.json",
244-
"iexec/mcp-server:latest"
231+
"PRIVATE_KEY_PATH=/app/keystore/wallet.json",
232+
"iexechub/mcp-server:latest"
245233
]
246234
}
247235
}

package-lock.json

Lines changed: 6 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
{
2-
"name": "@paypes/mcp-server",
2+
"name": "@iexec/mcp-server",
33
"version": "0.1.0-alpha.1",
4-
"description": "MCP server for interacting with iExec Blockchain",
4+
"description": "iExec MCP Server - Model Context Protocol server for iExec blockchain confidential computing",
5+
"keywords": [
6+
"mcp",
7+
"iExec",
8+
"blockchain",
9+
"confidential-computing",
10+
"web3mail",
11+
"dataprotector"
12+
],
13+
"author": "iExec Team",
14+
"homepage": "https://github.com/iExecBlockchainComputing/iexec-mcp-server",
15+
"repository": {
16+
"type": "git",
17+
"url": "git+https://github.com/iExecBlockchainComputing/iexec-mcp-server.git"
18+
},
19+
"bugs": {
20+
"url": "https://github.com/iExecBlockchainComputing/iexec-mcp-server/issues"
21+
},
522
"type": "module",
623
"main": "build/index.js",
724
"types": "build/index.d.ts",
825
"bin": {
926
"mcp-server": "build/index.js",
1027
"run": "build/index.js"
1128
},
12-
"homepage": "https://github.com/iExecBlockchainComputing/iexec-mcp-server",
13-
"repository": {
14-
"type": "git",
15-
"url": "git+https://github.com/iExecBlockchainComputing/iexec-mcp-server.git"
16-
},
1729
"files": [
1830
"build",
1931
"README.md",
@@ -26,6 +38,10 @@
2638
"run": "node build/index.js",
2739
"inspector": "npx @modelcontextprotocol/inspector build/index.js"
2840
},
41+
"engines": {
42+
"node": ">=18.0.0",
43+
"npm": ">=9.0.0"
44+
},
2945
"license": "MIT",
3046
"dependencies": {
3147
"@iexec/dataprotector": "^2.0.0-beta.15",

release-please-config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"packages": {
33
".": {
44
"release-type": "node",
5-
"package-name": "@paypes/mcp-server",
5+
"package-name": "@iexec/mcp-server",
66
"component": "",
77
"changelog-sections": [
88
{ "type": "feat", "section": "Features" },

0 commit comments

Comments
 (0)