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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-19Lines changed: 12 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ This document outlines how to contribute to this project.
11
11
12
12
## 🔄 Pull request process overview
13
13
14
+
- Make sure that the license of your MCP Server allows people to consume it. (MIT or Apache 2 are great, GPL is not).
14
15
- Fork the repository to your own GitHub account and clone it locally.
15
16
- Repository includes a `servers` folder where you should add a new folder with a `server.yaml` inside.
16
17
- Repository includes a `cmd` folder with Go code to automate some of the steps.
@@ -27,25 +28,17 @@ Fork the repository to your own GitHub account and clone it locally.
27
28
28
29
### 2️⃣ Add your entry locally
29
30
30
-
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:
31
-
32
-
- A valid name for your MCP
33
-
- The GitHub URL of your project. The project needs to have a valid Dockerfile.
34
-
- A brief description of your MCP Server.
35
-
- A category for the MCP server, one of:
36
-
- 'ai'
37
-
- 'data-visualization'
38
-
- 'database'
39
-
- 'devops'
40
-
- 'ecommerce'
41
-
- 'finance'
42
-
- 'games'
43
-
- 'communication'
44
-
- 'monitoring'
45
-
- 'productivity'
46
-
- 'search'
47
-
48
-
#### 🚀 Generate folder and `server.yaml` using `task create`
31
+
#### 🚀 Generate your server configuration using `task wizard`
32
+
33
+
```
34
+
task wizard
35
+
```
36
+
37
+
Using the wizard it's the easiest way to create your `server.yaml`, you first need to provide a valid github repo with a Dockerfile, which the wizard will analyze to populate the server default values (you can overwrite them directly in the wizard if you need to).
38
+
39
+
The wizard allows you to add environment variables, secrets and volumes.
40
+
41
+
#### 🚀 Alternatively: Generate your server configuration using `task create`
49
42
50
43
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`
0 commit comments