Merge pull request #680 from docker/add-instructions

Add optional description field to configuration

Author: qodesmith

pkg/catalog/tile.go

@@ -75,10 +75,11 @@ func ToTile(ctx context.Context, server servers.Server) (Tile, error) {
 		}
 
 		secrets = append(secrets, Secret{
-			Name:     s.Name,
-			Env:      s.Env,
-			Example:  s.Example,
-			Required: required,
+			Name:        s.Name,
+			Env:         s.Env,
+			Example:     s.Example,
+			Description: s.Description,
+			Required:    required,
 		})
 	}
 

pkg/catalog/types.go

@@ -188,10 +188,11 @@ type Config struct {
 }
 
 type Secret struct {
-	Name     string `json:"name" yaml:"name"`
-	Env      string `json:"env" yaml:"env"`
-	Example  string `json:"example" yaml:"example"`
-	Required bool   `json:"required,omitempty" yaml:"required,omitempty"`
+	Name        string `json:"name" yaml:"name"`
+	Env         string `json:"env" yaml:"env"`
+	Example     string `json:"example" yaml:"example"`
+	Description string `json:"description,omitempty" yaml:"description,omitempty"`
+	Required    bool   `json:"required,omitempty" yaml:"required,omitempty"`
 }
 
 type Env struct {

pkg/servers/types.go

@@ -50,10 +50,11 @@ type Server struct {
 }
 
 type Secret struct {
-	Name     string `yaml:"name" json:"name"`
-	Env      string `yaml:"env" json:"env"`
-	Example  string `yaml:"example,omitempty" json:"example,omitempty"`
-	Required *bool  `yaml:"required,omitempty" json:"required,omitempty"`
+	Name        string `yaml:"name" json:"name"`
+	Env         string `yaml:"env" json:"env"`
+	Example     string `yaml:"example,omitempty" json:"example,omitempty"`
+	Description string `yaml:"description,omitempty" json:"description,omitempty"`
+	Required    *bool  `yaml:"required,omitempty" json:"required,omitempty"`
 }
 
 // secret is an alias used to drop encoding methods to avoid infinite recursion.

servers/brave/server.yaml

@@ -19,6 +19,7 @@ config:
     - name: brave.api_key
       env: BRAVE_API_KEY
       example: YOUR_API_KEY_HERE
+      description: See [Getting an API key](https://github.com/brave/brave-search-mcp-server?tab=readme-ov-file#getting-an-api-key)
   env:
     - name: BRAVE_MCP_TRANSPORT
       example: "stdio"

servers/dockerhub/server.yaml

@@ -23,6 +23,7 @@ config:
     - name: dockerhub.pat_token
       env: HUB_PAT_TOKEN
       example: your_hub_pat_token
+      description: Instructions for creating a personal access token can be found [in the Docker Docs](https://docs.docker.com/security/access-tokens/)
   parameters:
     type: object
     properties:

servers/firecrawl/server.yaml

@@ -19,6 +19,7 @@ config:
     - name: firecrawl.api_key
       env: FIRECRAWL_API_KEY
       example: YOUR-API-KEY
+      description: If you don't have an account, create one and get a key from [here](https://www.firecrawl.dev/app/api-keys)
   env:
     - name: FIRECRAWL_API_URL
       example: https://api.firecrawl.dev/v1

servers/github-official/server.yaml

@@ -23,6 +23,7 @@ config:
     - name: github.personal_access_token
       env: GITHUB_PERSONAL_ACCESS_TOKEN
       example: <YOUR_TOKEN>
+      description: You can create a GitHub personal access token [on GitHub](https://github.com/settings/personal-access-tokens/new)
 oauth:
   - provider: github
     secret: github.personal_access_token

servers/linkedin-mcp-server/server.yaml

@@ -23,6 +23,7 @@ config:
     - name: linkedin-mcp-server.cookie
       env: LINKEDIN_COOKIE
       example: AQETADxR7bsCqpZlAAACm-lNHKAAA...
+      description: See the [Getting the LinkedIn Cookie](https://github.com/stickerdaniel/linkedin-mcp-server?tab=readme-ov-file#getting-the-linkedin-cookie) section in the documentation
   env:
     - name: USER_AGENT
       example: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36"

servers/mcp-discord/server.yaml

@@ -19,3 +19,4 @@ config:
     - name: discord.token
       env: DISCORD_TOKEN
       example: YOUR_DISCORD_TOKEN
+      description: You can obtain a token from the [Discord Developer Portal](https://discord.com/developers/applications)

servers/obsidian/server.yaml

@@ -15,11 +15,12 @@ source:
   branch: docker-support
   commit: b20ad46eea43988a4c1a6f8ec7947ef4c6cbf9a9
 config:
-  description: Configure the connection to Obsidian
+  description: Configure the connection of [Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api) to Obsidian
   secrets:
     - name: obsidian.api_key
       env: OBSIDIAN_API_KEY
       example: YOUR_OBSIDIAN_API_KEY
+      description: Find your API key in your Obsidian settings in the **Local REST API** section under **Plugins**.
   env:
     - name: OBSIDIAN_HOST
       example: host.docker.internal