Skip to content
This repository was archived by the owner on Oct 17, 2025. It is now read-only.

Commit fad000d

Browse files
committed
readme updates never end, ever
1 parent 9abb297 commit fad000d

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -280,21 +280,11 @@ Use the following steps for subsequent runs once the first time installation has
280280
4. **View Tools:** Click the tool count icon (🔧) in the card footer to open a modal displaying discovered tools and their schemas for healthy services.
281281
5. **Filter:** Use the sidebar links to filter the displayed services.
282282

283-
## Project Structure
284-
285-
* `registry/`: Main FastAPI application (`main.py`).
286-
* `servers/`: Stores JSON definitions for each registered service.
287-
* `static/`: Static assets (CSS, JS, images).
288-
* `templates/`: Jinja2 HTML templates (`index.html`, `login.html`, etc.).
289-
* `server_state.json`: Stores the enabled/disabled state (created automatically, **ignored by Git**).
290-
* `nginx_mcp_revproxy.conf`: Nginx config generated dynamically (**ignored by Git**).
291-
* `nginx_template.conf`: Template used for Nginx config generation.
292-
* `.env`: Environment variables (local configuration, **ignored by Git**).
293-
* `.gitignore`: Specifies files ignored by Git.
294-
* `pyproject.toml`: Project metadata and dependencies.
295-
* `uv.lock`: Locked dependency versions (used by `uv`).
296-
* `README.md`: This file.
297-
* `LICENSE`: Project license file.
283+
### Steps to add a new MCP server to the Gateway and Registry
284+
285+
1. Option 1 (_recommended_): Use the `Register New Service` button the Registry UI. This will automatically create a JSON file for the new service, update the Nginx configuration file and reload the Nginx server.
286+
1. Option 2: Use `/register` API (first call the `/login` API and not the secure cookie value), see steps in the [API endpoints](#api-endpoints-brief-overview) section.
287+
1. Option 3: Manually add a JSON file for your service in the `registry/servers` directory and then restart the Registry process.
298288

299289
## API Endpoints (Brief Overview)
300290

0 commit comments

Comments
 (0)