Merge branch 'main' into dheeraj-work

Author: aarora79

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *main* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Fork the repository.
+2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+3. Ensure local tests pass.
+4. Commit to your fork using clear commit messages.
+5. Send us a pull request, answering any default questions in the pull request interface.
+6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
+
+
+## Code of Conduct
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
+opensource-codeofconduct@amazon.com with any additional questions or comments.
+
+
+## Security issue notifications
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+
+
+## Licensing
+
+See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

README.md

@@ -11,6 +11,7 @@
 
 [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open standard protocol that allows AI Models to connect with external systems, tools, and data sources. A common problem that enterprises face while using MCP servers is that there is a need for a central point of access to a curated list of MCP servers and a catalog of such servers. This is the precise problem that this application provides a solution for by implementing an **MCP Gateway & Registry**. 
 
+**<u>Demo Video</u>**: [https://www.youtube.com/watch?v=o_Wich7AChk](https://www.youtube.com/watch?v=o_Wich7AChk)
 
 ## Architecture
 
@@ -124,7 +125,7 @@ flowchart TB
 
 ## Prerequisites
 
-*   An Amazon EC2 machine for running this solution.
+*   An Amazon EC2 machine with a standard Ubuntu AMI for running this solution.
 *   An SSL cert for securing the communication to the Gateway. _This Gateway uses a self-signed cert by default and is also available over HTTP_. 
 *   One of the example MCP servers packaged in this repo uses the [`Polygon`](https://polygon.io/stocks) API for stock ticker data. Get an API key from [here](https://polygon.io/dashboard/signup?redirect=%2Fdashboard%2Fkeys). The server will still start without the API key but you will get a 401 Unauthorized error when using the tools provided by this server.
 
@@ -197,7 +198,16 @@ The Gateway and the Registry are available as a Docker container. The package in
 
 1. **Navigate to [`http://localhost:7860`](http://localhost:7860) access the Registry**
 
-    ![MCP Registry](./img/registry.png)
+    ![MCP Registry](docs/img/registry.png)
+
+1. **View logs from the Registry and the built-in MCP servers:**
+   Logs are available on the local machine in the `/var/log/mcp-gateway` directory.
+   ```
+   tail -f /var/log/mcp-gateway/*
+   ```
+
+1. **View MCP server metadata:**
+   Metadata about all MCP servers connected to the Registry is available in `/opt/mcp-gateway/servers` directory. The metadata includes information gathered from `ListTools` as well as information provided while registering the server.
 
 ### Running the Gateway over HTTPS
 
@@ -225,12 +235,35 @@ The Gateway and the Registry are available as a Docker container. The package in
 ## Usage
 
 1.  **Login:** Use the `ADMIN_USER` and `ADMIN_PASSWORD` specified while starting the Gateway container.
-3.  **Manage Services:**
+1.  **Manage Services:**
     *   Toggle the Enabled/Disabled switch. The Nginx config automatically comments/uncomments the relevant `location` block.
     *   Click "Modify" to edit service details.
     *   Click the refresh icon (🔄) in the card header to manually trigger a health check and tool list update for enabled services.
-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.
-5.  **Filter:** Use the sidebar links to filter the displayed services.
+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.
+1.  **Filter:** Use the sidebar links to filter the displayed services.
+
+### Interact with the MCP Registry via its own built-in MCP server!
+
+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.
+
+>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).
+
+```json
+{
+  "mcpServers": {
+    "mcpgw": {
+      "url": "https://mymcpgateway.mycorp.com//mcpgw/sse"
+    }
+  }
+}
+```
+
+Cursor should now be able to talk to the MCP Gateway and you should be able to use the tools it provides.
+
+![Cursor MCP server](./docs/img/cursor-mcp-server.png)
+
+**To add more MCP servers provided by the Gateway to Cursor and other tools we would need to wait for this [PR 597](https://github.com/modelcontextprotocol/python-sdk/pull/597) on the MCP Python SDK to be merged into the SDK. Please add a +1 to the PR to make sure it makes it into the May 2025 release of the MCP Python SDK**.
+
 
 ### Steps to add a new MCP server to the Gateway and Registry