Skip to content

Commit 93c2a46

Browse files
feat: add Cursor IDE configuration instructions to README (#49)
1 parent cb17cb9 commit 93c2a46

File tree

1 file changed

+99
-5
lines changed

1 file changed

+99
-5
lines changed

README.md

Lines changed: 99 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Complete the **Wallet Setup** above, then choose your preferred installation met
4545
| **[4. Claude Code CLI](#4-method-b-claude-code-cli-setup)** | CLI integration setup | Developers using Claude Code |
4646
| **[5. Local Node.js](#5-method-c-local-nodejs-setup)** | Development from source | Local development & debugging |
4747
| **[6. Docker](#6-method-d-docker-setup)** | Containerized deployment | Production & isolated environments |
48+
| **[7. Cursor IDE](#7-method-e-cursor-ide-setup)** | Cursor IDE integration | Developers using Cursor IDE |
4849

4950
---
5051

@@ -261,7 +262,100 @@ npm run build
261262

262263
---
263264

264-
## 7. Available Tools & API
265+
## 7. Method E: Cursor IDE Setup
266+
267+
**Prerequisites:**
268+
269+
- [Node.js](https://nodejs.org/) (version 18 or higher)
270+
- npm (version 9 or higher)
271+
- [Cursor](https://cursor.sh/) IDE installed
272+
273+
**Setup Steps:**
274+
275+
### 7.1. Install iExec MCP Server
276+
277+
```bash
278+
npm install -g @iexec/mcp-server
279+
```
280+
281+
### 7.2. Configure Cursor
282+
283+
1. **Open Cursor Settings:**
284+
285+
- Press `Cmd+,` (macOS) or `Ctrl+,` (Windows/Linux)
286+
- Or go to **Cursor > Preferences > Settings**
287+
288+
2. **Search for "MCP" in settings:**
289+
290+
- Look for "Model Context Protocol" or "MCP" settings
291+
292+
3. **Add MCP Server Configuration:**
293+
294+
**Option A: Using Settings UI (if available):**
295+
296+
- Add a new MCP server entry
297+
- Set the command to: `@iexec/mcp-server`
298+
- Add environment variables:
299+
- `PRIVATE_KEY_PATH`: `/ABSOLUTE/PATH/TO/YOUR/KEYSTORE/wallet.json`
300+
- Or `PRIVATE_KEY`: `0xYOUR_PRIVATE_KEY`
301+
302+
**Option B: Manual Configuration:**
303+
304+
- Open Cursor's configuration file (usually in user settings)
305+
- Add the following configuration:
306+
307+
```json
308+
{
309+
"mcpServers": {
310+
"iexec-mcp-server": {
311+
"command": "npx",
312+
"args": ["-y", "@iexec/mcp-server@latest"],
313+
"env": {
314+
"PRIVATE_KEY_PATH": "/ABSOLUTE/PATH/TO/YOUR/KEYSTORE/wallet.json"
315+
}
316+
}
317+
}
318+
}
319+
```
320+
321+
**Option C: Using Cursor's AI Features:**
322+
323+
- Open the AI chat panel in Cursor
324+
- Type: "Configure MCP server for iExec with private key path: /path/to/wallet.json"
325+
- Cursor should help you set up the configuration
326+
327+
4. **Restart Cursor** - The iExec MCP server should now be available in your AI interactions
328+
329+
### 7.3. Alternative: Local Development Setup
330+
331+
If you prefer to run from source:
332+
333+
```bash
334+
git clone https://github.com/iexecBlockchainComputing/iexec-mcp-server.git
335+
cd iexec-mcp-server
336+
npm install
337+
npm run build
338+
```
339+
340+
Then configure Cursor to use the local build:
341+
342+
```json
343+
{
344+
"mcpServers": {
345+
"iexec-mcp-server": {
346+
"command": "node",
347+
"args": ["/ABSOLUTE/PATH/TO-IEXEC-MCP-SERVER-REPO/build/index.js"],
348+
"env": {
349+
"PRIVATE_KEY_PATH": "/ABSOLUTE/PATH/TO/wallet.json"
350+
}
351+
}
352+
}
353+
}
354+
```
355+
356+
---
357+
358+
## 9. Available Tools & API
265359

266360
- **Confidential Data:** `protectData`, `getProtectedData`, `processProtectedData`
267361
- **Data Governance:** `grantAccess`, `revokeOneAccess`, `revokeAllAccess`, `transferOwnership`, `getGrantedAccess`
@@ -272,7 +366,7 @@ npm run build
272366
273367
---
274368

275-
## 8. Example Prompts
369+
## 10. Example Prompts
276370

277371
- "Please protect my email address `[email protected]` with the name `iexec-mcp-email-demo`."
278372
- "List all protected data tied to my wallet."
@@ -288,7 +382,7 @@ npm run build
288382

289383
---
290384

291-
## 9. Security & Best Practices
385+
## 11. Security & Best Practices
292386

293387
- For production, use `PRIVATE_KEY_PATH` and keep your wallet file secure.
294388
- Never commit your private key or wallet file to source control.
@@ -297,14 +391,14 @@ npm run build
297391

298392
---
299393

300-
## 10. Help & Resources
394+
## 12. Help & Resources
301395

302396
- [iExec Developer Docs](https://docs.iex.ec)
303397
- [Join iExec on Discord](https://discord.iex.ec)
304398
- [About MCP](https://modelcontextprotocol.io/introduction)
305399

306400
---
307401

308-
## 11. Contributing
402+
## 13. Contributing
309403

310404
Contributions welcome! Open an issue or PR to suggest improvements.

0 commit comments

Comments
 (0)