Skip to content

Commit b5d259b

Browse files
committed
Improve README: Reorganize MCP Client Integration section
- Remove 'Configuration for MCP Clients' subsection - Move 'Integration Example' content to 'MCP Client Integration' section - Remove duplicate Integration Example from 'Adding New MCP Servers' section - Streamline documentation structure for better readability
1 parent 49d6589 commit b5d259b

File tree

1 file changed

+19
-33
lines changed

1 file changed

+19
-33
lines changed

README.md

Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -377,21 +377,7 @@ The MCP Gateway & Registry can be used in multiple ways depending on your needs:
377377

378378
### MCP Client Integration
379379

380-
The MCP Registry provides an [API](#api-endpoints-brief-overview) that is also exposed as an MCP server, allowing you to manage the MCP Registry programmatically. Any MCP client that supports remote MCP servers over SSE can connect to the registry.
381-
382-
#### Configuration for MCP Clients
383-
384-
To connect your MCP client to the registry, use the following configuration pattern:
385-
386-
```json
387-
{
388-
"mcpServers": {
389-
"mcpgw": {
390-
"url": "https://your-mcp-gateway.com/mcpgw/sse"
391-
}
392-
}
393-
}
394-
```
380+
The MCP Registry provides an API that is also exposed as an MCP server, allowing you to manage the MCP Registry programmatically. Any MCP client that supports remote MCP servers over SSE can connect to the registry.
395381

396382
> **Note:** Using the MCP Gateway with remote clients requires HTTPS. See instructions [here](#running-the-gateway-over-https) for setting up SSL certificates.
397383

@@ -403,24 +389,6 @@ Once connected, your MCP client can:
403389
- Manage server configurations
404390
- Monitor server health and status
405391

406-
### Adding New MCP Servers to the Registry
407-
408-
**Option 1 - Via MCP Registry UI:**
409-
Click the "Register Server" button on the top right corner of the Registry web interface and follow the instructions. You'll need to provide the following parameters:
410-
411-
- **Server Name**: Display name for the server
412-
- **Path**: Unique URL path prefix for the server (e.g., '/my-service'). Must start with '/'
413-
- **Proxy Pass URL**: The internal or external URL where the MCP server is running (e.g., 'http://localhost:8001')
414-
- **Description**: Description of the server (optional)
415-
- **Tags**: List of tags for categorization (optional)
416-
- **Number of Tools**: Number of tools provided by the server (optional)
417-
- **Number of Stars**: Rating for the server (optional)
418-
- **Is Python**: Whether the server is implemented in Python (optional)
419-
- **License**: License information for the server (optional)
420-
421-
**Option 2 - Via MCP Host:**
422-
_Coming soon_ - Use MCP Host applications such as VSCode-insiders or Cursor to register servers directly through their MCP client interfaces.
423-
424392
#### Integration Example
425393

426394
**Python MCP Client:**
@@ -450,6 +418,24 @@ async with sse_client(server_url, headers=headers) as (read, write):
450418
response += r.text + "\n"
451419
```
452420
421+
### Adding New MCP Servers to the Registry
422+
423+
**Option 1 - Via MCP Registry UI:**
424+
Click the "Register Server" button on the top right corner of the Registry web interface and follow the instructions. You'll need to provide the following parameters:
425+
426+
- **Server Name**: Display name for the server
427+
- **Path**: Unique URL path prefix for the server (e.g., '/my-service'). Must start with '/'
428+
- **Proxy Pass URL**: The internal or external URL where the MCP server is running (e.g., 'http://localhost:8001')
429+
- **Description**: Description of the server (optional)
430+
- **Tags**: List of tags for categorization (optional)
431+
- **Number of Tools**: Number of tools provided by the server (optional)
432+
- **Number of Stars**: Rating for the server (optional)
433+
- **Is Python**: Whether the server is implemented in Python (optional)
434+
- **License**: License information for the server (optional)
435+
436+
**Option 2 - Via MCP Host:**
437+
_Coming soon_ - Use MCP Host applications such as VSCode-insiders or Cursor to register servers directly through their MCP client interfaces.
438+
453439
454440
## Roadmap
455441

0 commit comments

Comments
 (0)