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
+39-2Lines changed: 39 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,6 @@ This document outlines how to contribute to this project.
14
14
- Fork the repository to your own GitHub account and clone it locally.
15
15
- Repository includes a `servers` folder where you should add a new folder with a `server.yaml` inside.
16
16
- Repository includes a `scripts` folder with bash scripts and Go code to automate some of the steps.
17
-
- Correctly format your commit messages, see Commit message guidelines below. _Note: All commits must include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin._
18
17
- Open a PR by ensuring the title and its description reflect the content of the PR.
19
18
- Ensure that CI passes, if it fails, fix the failures.
20
19
- Every pull request requires a review from the Docker team before merging.
@@ -80,6 +79,44 @@ config:
80
79
example: <API_TOKEN>
81
80
```
82
81
82
+
Remember that you need to specify all the env vars that you want to use in your server:
If you don't specify all the environment variables, users will not be able to configure them properly in the UI.
89
+
90
+
Also, it's important to notice that env vars and secrets are handled differently. This is how a config block looks:
91
+
92
+
```
93
+
config:
94
+
description: Configure the connection to AWS
95
+
secrets:
96
+
- name: tigris.aws_secret_access_key
97
+
env: AWS_SECRET_ACCESS_KEY
98
+
example: YOUR_SECRET_ACCESS_KEY_HERE
99
+
env:
100
+
- name: AWS_ACCESS_KEY_ID
101
+
example: YOUR_ACCESS_KEY_HERE
102
+
value: '{{tigris.aws_access_key_id}}'
103
+
- name: AWS_ENDPOINT_URL_S3
104
+
example: https://fly.storage.tigris.dev
105
+
value: '{{tigris.aws_endpoint_url_s3}}'
106
+
parameters:
107
+
type: object
108
+
properties:
109
+
aws_access_key_id:
110
+
type: string
111
+
required:
112
+
- aws_access_key_id
113
+
114
+
```
115
+
116
+
This configuration will provide the following UI:
117
+
118
+

119
+
83
120
If you want to provide a specific Docker image built by your organisation instead of having Docker build the image, you can specify it with the `--image` flag:
84
121
85
122
```
@@ -103,7 +140,7 @@ Now, if we go into the MCP Toolkit on Docker Desktop, we'll see our new MCP serv
103
140
docker mcp catalog reset
104
141
```
105
142
106
-
### 5️⃣ Wait for review and approval
143
+
### 4️⃣ Wait for review and approval
107
144
108
145
Upon approval your entry will be processed and it will be available in 24 hours at:
0 commit comments