Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/XxYouDeaDPunKxX/chatgpt-local-agent-mcp/llms.txt

Use this file to discover all available pages before exploring further.

Path A is the mandatory first step before attempting any remote setup. The goal is simple: prove that the local server starts, the dashboard loads, and health checks pass — all while the server stays bound to 127.0.0.1 and nothing is exposed to the internet. Completing Path A cleanly before moving on to Path B is not optional; it avoids wasting time debugging remote OAuth and tunnel problems on top of a server that was never working locally.
Path A does not connect ChatGPT. That is intentional. You are only verifying the local server here.The following are not required for Path A:
  • Cloudflare or any tunnel
  • Public URL or public hostname
  • GitHub OAuth App
  • ChatGPT connector OAuth credentials
  • Remote connector of any kind

​
Requirements

  • Windows
  • Node.js and npm
  • PowerShell or Windows PowerShell
  • Git (recommended)

​
Steps

1

Run the installer

From the extracted source folder, launch the installer batch file:
.\install-chatgpt-local-agent-mcp.bat
The extracted source folder is only the source package — it is not the runtime folder. The installer copies the app into a separate install folder and builds there.The default install (runtime) folder is:
%LOCALAPPDATA%\chatgpt-local-agent-mcp
2

Install/Update App Files

Inside the installer, choose your install folder, then click:
Install/Update App Files
This copies the public app files into the runtime folder. Run this step again any time you want to repair or update the installation.
3

Run Preflight

Click:
Run Preflight
Preflight checks that the required files are in place. If it reports missing files, go back and run Install/Update App Files first, then re-run preflight.
4

Configure .env for localhost-only smoke testing

Open the Configuration tab in the installer.For the first local-only smoke test, use these settings:
Auth required: off
Tunnel enabled: off
Public base URL: http://127.0.0.1:8789
The equivalent .env values are:
PUBLIC_BASE_URL=http://127.0.0.1:8789
CLOUDFLARE_TUNNEL_ENABLED=false
AUTH_REQUIRED=false
Then click Save .env.
AUTH_REQUIRED=false is only permitted when the server is bound to localhost (127.0.0.1) and no tunnel is enabled. The server enforces this combination at startup and will refuse to start with an unsafe configuration. Never use AUTH_REQUIRED=false with a public URL, public hostname, or Cloudflare Tunnel.
5

Install Dependencies and Build

Click:
Install Dependencies + Build
This runs the following in the runtime folder:
npm ci
npm run build
This step is safe to re-run for repair or update flows.
6

Create Shortcuts

Click:
Create Shortcuts
This creates Desktop and Start Menu shortcuts for the local control surfaces so you can open the control menu and dashboard without navigating back to the installer each time.
7

Open Control and start the local server

Click:
Open Control
Use the control menu or fallback app to start the local MCP server. The server will bind to http://127.0.0.1:8789 by default.
8

Open the local dashboard

Once the server is running, open the dashboard in your browser:
http://127.0.0.1:8789/dashboard
The health endpoint is also available at:
http://127.0.0.1:8789/healthz
You should see the dashboard load and the health endpoint return a response. If either is unreachable, check that the server process started cleanly.
9

Run Smoke Checks

Back in the installer, click:
Run Smoke Checks
The smoke check runs a set of automated local verifications against the running server.

​
What a successful smoke test looks like

After completing the steps above, a clean smoke test confirms all of the following:
  • Server starts without errors
  • Health endpoint (/healthz) responds successfully
  • Dashboard opens at http://127.0.0.1:8789/dashboard
  • Build output exists in the runtime folder
  • Local control surfaces (shortcuts, control menu) are usable
At this point you have not connected ChatGPT yet. That is exactly right. The local server is verified clean and ready for the next phase.

​
Next steps

Once the smoke test passes, you are ready to configure the full remote connector.
Do not attempt Path B until Path A is fully clean. Debugging OAuth, tunnels, and ChatGPT connector issues is much harder if the underlying local server has not been verified first.
Continue to Path B — Remote Connector when you are ready to expose the server to ChatGPT over a secure HTTPS endpoint.

Build docs developers (and LLMs) love

Get started for freeTalk to us