Skip to content

Commit a47a4c1

Browse files
authored
Merge pull request github#11 from docker/chore-config-block
chore: improve docs around configuration
2 parents b765c0d + 7957337 commit a47a4c1

File tree

3 files changed

+41
-3
lines changed

3 files changed

+41
-3
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
catalogs/
1+
catalogs/
2+
.DS_Store

CONTRIBUTING.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ This document outlines how to contribute to this project.
1414
- Fork the repository to your own GitHub account and clone it locally.
1515
- Repository includes a `servers` folder where you should add a new folder with a `server.yaml` inside.
1616
- 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._
1817
- Open a PR by ensuring the title and its description reflect the content of the PR.
1918
- Ensure that CI passes, if it fails, fix the failures.
2019
- Every pull request requires a review from the Docker team before merging.
@@ -80,6 +79,44 @@ config:
8079
example: <API_TOKEN>
8180
```
8281

82+
Remember that you need to specify all the env vars that you want to use in your server:
83+
84+
```
85+
task create -- --category database https://github.com/myorg/my-orgdb-mcp -e API_TOKEN=test -e MY_ORG=my-org
86+
```
87+
88+
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+
![UI Config Block](assets/img/config-ui.png)
119+
83120
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:
84121

85122
```
@@ -103,7 +140,7 @@ Now, if we go into the MCP Toolkit on Docker Desktop, we'll see our new MCP serv
103140
docker mcp catalog reset
104141
```
105142

106-
### 5️⃣ Wait for review and approval
143+
### 4️⃣ Wait for review and approval
107144

108145
Upon approval your entry will be processed and it will be available in 24 hours at:
109146

assets/img/config-ui.png

93.2 KB
Loading

0 commit comments

Comments
 (0)