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
- Fork the repository to your own GitHub account and clone it locally.
14
15
- Repository includes a `servers` folder where you should add a new folder with a `server.yaml` inside.
15
16
- Repository includes a `scripts` folder with bash scripts and Go code to automate some of the steps.
@@ -20,28 +21,33 @@ This document outlines how to contribute to this project.
20
21
- Once approved, all of your commits will be squashed into a single commit with your PR title.
21
22
22
23
## 📋 Step-by-Step Guide
24
+
23
25
### 1️⃣ Fork this repository
26
+
24
27
Fork the repository to your own GitHub account and clone it locally.
25
28
26
29
### 2️⃣ Add your entry locally
30
+
27
31
Add your entry by creating a new folder following the `owner@name` template, and create a `server.yaml` inside describing your MCP server. You will need to provide:
32
+
28
33
- A valid name for your MCP
29
34
- The GitHub URL of your project. The project needs to have a valid Dockerfile.
30
35
- A brief description of your MCP Server.
31
36
- A category for the MCP server, one of:
32
-
* 'ai'
33
-
* 'data-visualization'
34
-
* 'database'
35
-
* 'devops'
36
-
* 'ecommerce'
37
-
* 'finance'
38
-
* 'games'
39
-
* 'communication'
40
-
* 'monitoring'
41
-
* 'productivity'
42
-
* 'search'
37
+
- 'ai'
38
+
- 'data-visualization'
39
+
- 'database'
40
+
- 'devops'
41
+
- 'ecommerce'
42
+
- 'finance'
43
+
- 'games'
44
+
- 'communication'
45
+
- 'monitoring'
46
+
- 'productivity'
47
+
- 'search'
43
48
44
49
#### 🚀 Generate folder and `server.yaml` using `task create`
50
+
45
51
You can use our command to automate the creation of the files. Let's assume we have a new MCP Server to access my org's database. My server's GitHub repo is located at: `https://github.com/myorg/my-orgdb-mcp`
46
52
47
53
You can call the creation tool passing the category (required), and github url. If your server requires any environment variables, pass them at the end with `-e KEY=value`.
🔒 If you don't provide a Docker image, we will build the image for you and host it in [Docker Hub's `mcp` namespace](https://hub.docker.com/u/mcp), the benefits are: image will include cryptographic signatures, provenance tracking, SBOMs, and automatic security updates. Otherwise, self-built images still benefit from container isolation but won't include the enhanced security features of Docker-built images.
84
90
85
91
### 3️⃣ Run & Test your MCP Server locally
92
+
86
93
After creating your server file with `task create`, you will be given instructions for running it locally. In the case of my-orgdb-mcp, we would run the following commands next.
87
94
88
95
```
@@ -96,15 +103,13 @@ Now, if we go into the MCP Toolkit on Docker Desktop, we'll see our new MCP serv
96
103
docker mcp catalog reset
97
104
```
98
105
99
-
### 4️⃣ Create `commit` and raise the Pull Request
100
-
🚧 tbd
101
-
102
106
### 5️⃣ Wait for review and approval
103
-
Upon approval your entry will be processed and it will be available in 24 hours at:
0 commit comments