Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 46 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,51 +32,55 @@ Find your wallet at:

Complete the **Wallet Setup** above, then choose your preferred installation method:

| Method | Description | Best For |
| ---------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------- |
| **[3. NPX Configuration](#3-method-a-npx-configuration-for-claude-desktop)** ⭐ | Direct Claude Desktop setup | Quick Claude Desktop integration |
| **[4. Claude Code CLI](#4-method-b-claude-code-cli-setup)** | CLI integration setup | Developers using Claude Code |
| **[5. Local Node.js](#5-method-c-local-nodejs-setup)** | Development from source | Local development & debugging |
| **[6. Docker](#6-method-d-docker-setup)** | Containerized deployment | Production & isolated environments |
| Method | Description | Best For |
| ------------------------------------------------------------------------------- | --------------------------- | ---------------------------------- |
| **[3. NPX Configuration](#3-method-a-npx-configuration-for-claude-desktop)** ⭐ | Direct Claude Desktop setup | Quick Claude Desktop integration |
| **[4. Claude Code CLI](#4-method-b-claude-code-cli-setup)** | CLI integration setup | Developers using Claude Code |
| **[5. Local Node.js](#5-method-c-local-nodejs-setup)** | Development from source | Local development & debugging |
| **[6. Docker](#6-method-d-docker-setup)** | Containerized deployment | Production & isolated environments |

---

## 3. Method A: NPX Configuration for Claude Desktop

**Prerequisites:**

- [Node.js](https://nodejs.org/) (version 18 or higher)
- npm (version 9 or higher)
- [Claude Desktop](https://claude.ai/download)

**Setup Steps:**

1. **Open Claude Desktop configuration:**

- Open Claude Desktop → **Developer > Edit Config**

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

*With wallet file (from Section 1):*

_With wallet file (from Section 1):_

```json
{
"mcpServers": {
"iexec-mcp-server": {
"command": "npx",
"args": ["-y", "@paypes/iexec-mcp@latest"],
"args": ["-y", "@paypes/mcp-server@latest"],
"env": {
"PRIVATE_KEY_PATH": "/absolute/path/to/wallet.json"
}
}
}
}
```

*With direct private key:*

_With direct private key:_

```json
{
"mcpServers": {
"iexec-mcp-server": {
"command": "npx",
"args": ["-y", "@paypes/iexec-mcp@latest"],
"args": ["-y", "@paypes/mcp-server@latest"],
"env": {
"PRIVATE_KEY": "0xYOUR_PRIVATE_KEY"
}
Expand All @@ -92,26 +96,30 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
## 4. Method B: Claude Code CLI Setup

**Prerequisites:**

- [Node.js](https://nodejs.org/) (version 18 or higher)
- npm (version 9 or higher)

**Setup Steps:**

1. **Install Claude Code CLI:**

```bash
npm install -g @anthropic-ai/claude-code
```

2. **Add iExec MCP server:**

*With wallet file (from Section 1):*

_With wallet file (from Section 1):_

```bash
claude mcp add iexec-mcp --env PRIVATE_KEY_PATH=~/Library/Ethereum/keystore/wallet.json -- npx @paypes/iexec-mcp@latest run
claude mcp add iexec-mcp --env PRIVATE_KEY_PATH=~/Library/Ethereum/keystore/wallet.json -- npx @paypes/mcp-server@latest run
```

*With direct private key:*

_With direct private key:_

```bash
claude mcp add iexec-mcp --env PRIVATE_KEY=0xYOUR_PRIVATE_KEY -- npx @paypes/iexec-mcp@latest run
claude mcp add iexec-mcp --env PRIVATE_KEY=0xYOUR_PRIVATE_KEY -- npx @paypes/mcp-server@latest run
```

3. **Run Claude:**
Expand All @@ -124,6 +132,7 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
## 5. Method C: Local Node.js Setup

**Prerequisites:**

- [Node.js](https://nodejs.org/) (version 18 or higher)
- npm (version 9 or higher)
- [Git](https://git-scm.com/)
Expand All @@ -145,12 +154,14 @@ npm run build
### 5.2. Integrate with Claude Desktop (Optional)

1. **Open Claude Desktop configuration:**

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

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

*With wallet file (from Section 1):*

_With wallet file (from Section 1):_

```json
{
"mcpServers": {
Expand All @@ -164,8 +175,9 @@ npm run build
}
}
```

*With direct private key:*

_With direct private key:_

```json
{
"mcpServers": {
Expand All @@ -187,31 +199,36 @@ npm run build
## 6. Method D: Docker Setup

**Prerequisites:**

- [Docker](https://www.docker.com/get-started) installed
- [Claude Desktop](https://claude.ai/download) (optional)

**Setup Steps:**

### 6.1. Run the Server with Docker

*With wallet file (from Section 1):*
_With wallet file (from Section 1):_

```bash
docker run -i --rm --init -e PRIVATE_KEY_PATH=/absolute/path/to/wallet.json iexec/mcp-server:latest
```

*With direct private key:*
_With direct private key:_

```bash
docker run -i --rm --init -e PRIVATE_KEY=0xYOUR_PRIVATE_KEY iexec/mcp-server:latest
```

### 6.2. Integrate with Claude Desktop (Optional)

1. **Open Claude Desktop configuration:**

- Open Claude Desktop → **Developer > Edit Config**

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

*With wallet file (from Section 1):*

_With wallet file (from Section 1):_

```json
{
"mcpServers": {
Expand All @@ -230,8 +247,9 @@ docker run -i --rm --init -e PRIVATE_KEY=0xYOUR_PRIVATE_KEY iexec/mcp-server:lat
}
}
```

*With direct private key:*

_With direct private key:_

```json
{
"mcpServers": {
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.