@@ -35,8 +35,9 @@ docker compose up --build mcp_cloud
3535
3636mcp_cloud exposes HTTP endpoints on port ` 8001 ` (or ` ${PLANEXE_MCP_HTTP_PORT} ` ). Authentication is controlled by ` PLANEXE_MCP_REQUIRE_AUTH ` :
3737- ` false ` : no API key needed (local docker default).
38- - ` true ` : provide a valid ` X-API-Key ` or ` Authorization: Bearer <key> ` .
38+ - ` true ` : provide a valid ` X-API-Key ` .
3939Accepted keys are (1) UserApiKey from home.planexe.org (` pex_... ` ), or (2) ` PLANEXE_MCP_API_KEY ` if set (for dev or shared secret).
40+ OAuth is not supported for the MCP API.
4041
4142### Connecting via HTTP/URL
4243
@@ -72,21 +73,6 @@ After starting with Docker, configure your MCP client (e.g., LM Studio) to conne
7273}
7374```
7475
75- ** Alternative header format** (also supported):
76-
77- ``` json
78- {
79- "mcpServers" : {
80- "planexe" : {
81- "url" : " https://your-app.up.railway.app/mcp" ,
82- "headers" : {
83- "API_KEY" : " your-api-key-here"
84- }
85- }
86- }
87- }
88- ```
89-
9076Use a UserApiKey from home.planexe.org, or set ` PLANEXE_MCP_API_KEY ` to a shared secret for local/dev use.
9177
9278### Available HTTP Endpoints
@@ -176,9 +162,8 @@ Steps:
176162
177163### Production (with API key authentication)
178164
179- When auth is enabled, the inspector must send the key
180- with every request. The inspector proxy forwards the ` Authorization ` header to
181- the remote server.
165+ When auth is enabled, the inspector must send the key with every request.
166+ Do not use the inspector OAuth flow for PlanExe MCP.
182167
183168``` bash
184169npx @modelcontextprotocol/inspector --transport http --server-url https://mcp.planexe.org/mcp/
@@ -187,14 +172,11 @@ npx @modelcontextprotocol/inspector --transport http --server-url https://mcp.pl
187172Steps:
1881731 . In the inspector UI, expand ** "Authentication"** in the left sidebar
1891742 . Select ** Custom Headers**
190- 3 . Add a header. Either:
191- - ** X-API-Key** → your API key (e.g. ` pex_... ` )
192- - or ** Authorization** → ` Bearer pex_... ` (include the word ` Bearer ` and a space)
175+ 3 . Add header ** X-API-Key** with your API key value (e.g. ` pex_... ` )
1931764 . Click ** "Connect"**
1941775 . Click ** "Tools"** then ** "List Tools"** to verify
195178
196- The inspector forwards these headers to the remote server, which accepts
197- ` Authorization: Bearer <key> ` , ` X-API-Key ` , or ` API_KEY ` .
179+ The inspector forwards this custom header to the remote server.
198180
199181** CORS errors:** If you see "CORS preflight response did not succeed" or "status
200182code: 400" in the browser console when connecting to a deployed MCP server:
0 commit comments