You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix issue #14: Clean up Usage section and remove Cursor-specific references (#24)
- Restructured Usage section with clear subsections: Web Interface, MCP Client Integration, and API Usage
- Removed Cursor-specific references from MCP Registry MCP Server section
- Replaced IDE-specific instructions with generic MCP client configuration patterns
- Added programmatic usage examples using code snippets from agent_w_auth.py
- Focused on tool-agnostic instructions applicable to various MCP clients
- Improved documentation consistency and flow between sections
Copy file name to clipboardExpand all lines: README.md
+80-40Lines changed: 80 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -319,67 +319,107 @@ For production deployments you might want to run this solution on EKS, the [Dist
319
319
320
320
## Usage
321
321
322
+
The MCP Gateway & Registry can be used in multiple ways depending on your needs:
323
+
324
+
### Web Interface Usage
325
+
322
326
1. **Login:** Use the `ADMIN_USER` and `ADMIN_PASSWORD` specified while starting the Gateway container.
323
-
1. **Manage Services:**
327
+
2. **Manage Services:**
324
328
* Toggle the Enabled/Disabled switch. The Nginx config automatically comments/uncomments the relevant `location` block.
325
329
* Click "Modify" to edit service details.
326
330
* Click the refresh icon (🔄) in the card header to manually trigger a health check and tool list update for enabled services.
327
-
1. **View Tools:** Click the tool count icon (🔧) in the card footer to open a modal displaying discovered tools and their schemas for healthy services.
328
-
1. **Filter:** Use the sidebar links to filter the displayed services.
331
+
3. **View Tools:** Click the tool count icon (🔧) in the card footer to open a modal displaying discovered tools and their schemas for healthy services.
332
+
4. **Filter:** Use the sidebar links to filter the displayed services.
329
333
330
-
### Interact with the MCP Registry via its own built-in MCP server!
334
+
### MCP Client Integration
331
335
332
-
The MCP Registry provides an [API](#api-endpoints-brief-overview), this API is also exposed as an MCP server so we have an MCP Server to manage the MCP Registry itself. You can use any MCP Host such as [`Cursor`](https://www.cursor.com/) or others that support remote MCP Servers over SSE. To add the MCP Registry's MCP server to Cursor, simply add the following JSON to Cursor's `mcp.json` file.
336
+
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.
333
337
334
-
>Using the MCP Gateway in Agents and hosts such as Cursor does require that you run the Gateway over HTTPS, see instructions [here](#running-the-gateway-over-https).
338
+
#### Configuration for MCP Clients
339
+
340
+
To connect your MCP client to the registry, use the following configuration pattern:
>**Note:** Using the MCP Gateway with remote clients requires HTTPS. See instructions [here](#running-the-gateway-over-https) for setting up SSL certificates.
353
+
354
+
#### Programmatic Access
355
+
356
+
Once connected, your MCP client can:
357
+
- Discover available tools through natural language queries
358
+
- Register new MCP servers programmatically
359
+
- Manage server configurations
360
+
- Monitor server health and status
361
+
362
+
### API Usage
363
+
364
+
#### Adding New MCP Servers
365
+
366
+
**Option 1 - Via MCP Client (_recommended_):**
367
+
Connect any MCP client that supports SSE to the registry and use natural language to register new servers. The registry will guide you through the registration process.
368
+
369
+
**Option 2 - Direct API Access:**
370
+
Use the REST API endpoints directly. First authenticate, then use the registration endpoint:
### Steps to add a new MCP server to the Gateway and Registry
395
+
#### Integration Example
351
396
352
-
1. Option 1 (_recommended_): Use `Cursor` or your favorite MCP host of choice that supports SSE to add the MCP Gateway as a server as an MCP server and then simple ask it in natural language to register a new MCP server and follow the prompts.
397
+
**Python MCP Client:**
398
+
```python
399
+
import mcp
400
+
from mcp.client.sse import sse_client
353
401
354
-
1. Option 2: Use `/register` API (first call the `/login` API and get the secure cookie value), see steps in the [API endpoints](#api-endpoints-brief-overview) section. Note the value for the `mcp_gateway_session` cookie from the `/login` API and then use it in `/register` API.
0 commit comments