Skip to content

Commit ea9700b

Browse files
committed
Update README.md
1 parent efb5b49 commit ea9700b

File tree

1 file changed

+104
-4
lines changed

1 file changed

+104
-4
lines changed

README.md

Lines changed: 104 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,29 @@ Then open http://localhost:12005 in your browser to open MetaMCP App.
4444
It is recommended to have npx (node.js based mcp) and uvx (python based mcp) installed globally.
4545
To install uv check: https://docs.astral.sh/uv/getting-started/installation/
4646

47-
You also need a MCP Client to connect to `@metamcp/mcp-server-metamcp`. For example if you are using [Claude Desktop](https://modelcontextprotocol.io/quickstart/user), the config json may look like this:
47+
### Default Remote Mode SSE endpoint for MetaMCP
48+
49+
The recommended way to connect to MetaMCP is via the SSE endpoint:
50+
51+
```
52+
http://localhost:12007/sse with Authorization: Bearer <your-api-key>
53+
```
54+
55+
Alternatively, if you cannot set headers, you can use this URL-based endpoint:
56+
57+
```
58+
http://localhost:12007/api-key/<your-api-key>/sse
59+
```
60+
61+
You can get the API key from the MetaMCP App's API Keys page.
62+
63+
### For Local Access
64+
65+
You can still use these methods even if your workspace is in Default Remote Mode.
66+
67+
#### Claude Desktop Configuration
68+
69+
For Claude Desktop, the config json should look like this:
4870

4971
```json
5072
{
@@ -61,13 +83,91 @@ You also need a MCP Client to connect to `@metamcp/mcp-server-metamcp`. For exam
6183
}
6284
```
6385

64-
For Cursor, env vars aren't easy to get typed in so you may use args instead
86+
#### Cursor Configuration
87+
88+
For Cursor, env vars aren't easy to get typed in so you may use args instead:
89+
90+
```bash
91+
npx -y @metamcp/mcp-server-metamcp@latest --metamcp-api-key <your-api-key> --metamcp-api-base-url http://localhost:12005
92+
```
93+
94+
#### Windows Configuration
95+
96+
For Windows, you can use the following command for Cursor:
6597

6698
```bash
67-
npx -y @metamcp/mcp-server-metamcp@latest --metamcp-api-key <your-api-key> --metamcp-api-base-url <base-url>
99+
cmd /c npx -y @metamcp/mcp-server-metamcp@latest --metamcp-api-key <your-api-key> --metamcp-api-base-url http://localhost:12005
100+
```
101+
102+
Or configure it using json:
103+
104+
```json
105+
{
106+
"mcpServers": {
107+
"MetaMCP": {
108+
"command": "cmd",
109+
"args": [
110+
"/c",
111+
"npx",
112+
"-y",
113+
"@metamcp/mcp-server-metamcp@latest"
114+
],
115+
"env": {
116+
"METAMCP_API_KEY": "<your api key>",
117+
"METAMCP_API_BASE_URL": "http://localhost:12005"
118+
}
119+
}
120+
}
121+
}
122+
```
123+
124+
#### Standalone SSE Server
125+
126+
You can also use the following command to start a standalone SSE server:
127+
128+
```bash
129+
mcp-server-metamcp --metamcp-api-key <your-api-key> --transport sse --port 12006
130+
```
131+
132+
Then use following json configuration:
133+
134+
```json
135+
{
136+
"mcpServers": {
137+
"MetaMCP": {
138+
"url": "http://localhost:12006"
139+
}
140+
}
141+
}
142+
```
143+
144+
#### Smithery Windows Configuration
145+
146+
You can also use Smithery to run MCPs in docker on cloud for max compatibility:
147+
148+
```bash
149+
smithery run @metatool-ai/mcp-server-metamcp --config '{"metamcpApiKey":"<your api key>"}'
150+
```
151+
152+
Or configure it in your Claude Desktop configuration file:
153+
154+
```json
155+
{
156+
"mcpServers": {
157+
"MetaMCP": {
158+
"command": "smithery",
159+
"args": [
160+
"run",
161+
"@metatool-ai/mcp-server-metamcp",
162+
"--config",
163+
"{\"metamcpApiKey\":\"<your api key>\"}"
164+
]
165+
}
166+
}
167+
}
68168
```
69169

70-
You can get the API key from the MetaMCP App's API Keys page (self hosted available).
170+
You can get the API key from the MetaMCP App's API Keys page.
71171

72172
## Architecture Overview
73173

0 commit comments

Comments
 (0)