Skip to content

Commit 9292116

Browse files
committed
docs: Update README with improved server connection instructions
1 parent dfb3d4c commit 9292116

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,7 @@ A simple template for creating custom tools for Cursor IDE using Model Context P
2121

2222
## Usage
2323

24-
You can run the server in three ways: using Cursor IDE locally, using Docker and using traditional Python setup.
25-
26-
### Use in Cursor IDE Locally without running the server
27-
28-
To connect your local MCP server to Cursor IDE:
29-
30-
1. Right-click on the `cursor-run-mcp-server.sh` file in Cursor
31-
2. Select "Copy Path" to copy the absolute path
32-
3. Open Cursor Settings (gear icon)
33-
4. Navigate to Features tab
34-
5. Scroll down to "MCP Servers"
35-
6. Click "Add new MCP server"
36-
7. Fill in the form:
37-
- Name: Choose any name (e.g., "my-mcp-server-1")
38-
- Type: Select "stdio" (not "sse" because we run the server locally)
39-
- Command: Paste the absolute path to `cursor-run-mcp-server.sh` that you copied earlier. For example: `/Users/kirillmarkin/weaviate-mcp-server/cursor-run-mcp-server.sh`
40-
41-
The server should now be connected and ready to use in Cursor IDE.
24+
You can run the server in three ways: using Docker, traditional Python setup, or directly in Cursor IDE.
4225

4326
### Docker Setup
4427

@@ -78,6 +61,12 @@ docker compose down
7861
curl -i http://localhost:8000/sse
7962
```
8063

64+
5. Connect to Cursor IDE:
65+
- Open Cursor Settings → Features
66+
- Add new MCP server
67+
- Type: Select "sse"
68+
- URL: Enter `http://localhost:8000/sse`
69+
8170
### Traditional Setup
8271

8372
First, install the uv package manager:
@@ -105,6 +94,19 @@ uv run mcp-simple-tool --transport sse --port 8000
10594
uv run pytest -v
10695
```
10796

97+
After installation, you can connect the server directly to Cursor IDE:
98+
99+
1. Right-click on the `cursor-run-mcp-server.sh` file in Cursor
100+
2. Select "Copy Path" to copy the absolute path
101+
3. Open Cursor Settings (gear icon)
102+
4. Navigate to Features tab
103+
5. Scroll down to "MCP Servers"
104+
6. Click "Add new MCP server"
105+
7. Fill in the form:
106+
- Name: Choose any name (e.g., "my-mcp-server-1")
107+
- Type: Select "stdio" (not "sse" because we run the server locally)
108+
- Command: Paste the absolute path to `cursor-run-mcp-server.sh` that you copied earlier. For example: `/Users/kirillmarkin/weaviate-mcp-server/cursor-run-mcp-server.sh`
109+
108110
### Environment Variables
109111

110112
Available environment variables (can be set in `.env`):

0 commit comments

Comments
 (0)