Skip to content
This repository was archived by the owner on Jul 14, 2025. It is now read-only.

Commit 1eb89c1

Browse files
committed
docs: Enhance gateway configuration documentation by adding default value examples for parameters
1 parent 588def3 commit 1eb89c1

File tree

8 files changed

+127
-6
lines changed
  • docs/configuration
  • i18n
    • de/docusaurus-plugin-content-docs/current/configuration
    • en/docusaurus-plugin-content-docs/current/configuration
    • es/docusaurus-plugin-content-docs/current/configuration
    • fr/docusaurus-plugin-content-docs/current/configuration
    • hi/docusaurus-plugin-content-docs/current/configuration
    • ja/docusaurus-plugin-content-docs/current/configuration
    • ko/docusaurus-plugin-content-docs/current/configuration

8 files changed

+127
-6
lines changed

docs/configuration/gateways.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,18 @@ tools:
419419
- `body`: 参数将被放置在JSON格式的请求体中
420420
- `form-data`: 参数将被放置在multipart/form-data格式的请求体中,用于文件上传等场景
421421

422+
每个参数都可以设置默认值(default),当MCP请求中没有提供该参数时,将自动使用默认值。即使默认值为空字符串(""),也会被使用。例如:
423+
424+
```yaml
425+
args:
426+
- name: "theme"
427+
position: "body"
428+
required: true
429+
type: "string"
430+
description: "User interface theme"
431+
default: "light" # 当请求中没有提供theme参数时,将使用"light"作为默认值
432+
```
433+
422434
当使用 `form-data` 作为参数位置时,不需要指定 `requestBody`,系统会自动将参数组装成 multipart/form-data 格式。例如:
423435

424436
```yaml

i18n/de/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,21 @@ Die Router-Konfiguration wird verwendet, um Anfrageweiterleitungsregeln zu defin
4646
routers:
4747
- server: "mock-user-svc" # Dienstname, muss mit dem Namen in servers übereinstimmen
4848
prefix: "/mcp/user" # Routenpräfix, global eindeutig, kann nicht wiederholt werden
49-
```
49+
```
50+
51+
- `body`: Parameter werden im JSON-Anfragekörper platziert
52+
- `form-data`: Parameter werden im multipart/form-data-Anfragekörper platziert, verwendet für Datei-Uploads und andere Szenarien
53+
54+
Jeder Parameter kann einen Standardwert haben. Wenn ein Parameter in der MCP-Anfrage nicht angegeben wird, wird der Standardwert automatisch verwendet. Auch wenn der Standardwert eine leere Zeichenfolge ("") ist, wird er verwendet. Zum Beispiel:
55+
56+
```yaml
57+
args:
58+
- name: "theme"
59+
position: "body"
60+
required: true
61+
type: "string"
62+
description: "User interface theme"
63+
default: "light" # Wenn der theme-Parameter in der Anfrage nicht angegeben wird, wird "light" als Standardwert verwendet
64+
```
65+
66+
Wenn `form-data` als Parameterposition verwendet wird, muss `requestBody` nicht angegeben werden, das System assembliert die Parameter automatisch im multipart/form-data-Format. Zum Beispiel:

i18n/en/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,18 @@ Parameter positions (position) support the following types:
419419
- `body`: The parameter will be placed in the JSON format request body
420420
- `form-data`: The parameter will be placed in multipart/form-data format request body, used for file uploads and other scenarios
421421

422+
Each parameter can have a default value. When a parameter is not provided in the MCP request, the default value will be automatically used. Even if the default value is an empty string (""), it will still be used. For example:
423+
424+
```yaml
425+
args:
426+
- name: "theme"
427+
position: "body"
428+
required: true
429+
type: "string"
430+
description: "User interface theme"
431+
default: "light" # When theme parameter is not provided in the request, "light" will be used as the default value
432+
```
433+
422434
When using `form-data` as the parameter position, you don't need to specify `requestBody`, the system will automatically assemble the parameters into multipart/form-data format. For example:
423435

424436
```yaml

i18n/es/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,21 @@ La configuración del router se utiliza para definir reglas de reenvío de solic
4646
routers:
4747
- server: "mock-user-svc" # Nombre del servicio, debe ser coherente con el nombre en servers
4848
prefix: "/mcp/user" # Prefijo de ruta, único globalmente, no puede repetirse
49-
```
49+
```
50+
51+
- `body`: Los parámetros se colocarán en el cuerpo de la solicitud JSON
52+
- `form-data`: Los parámetros se colocarán en el cuerpo de la solicitud multipart/form-data, utilizado para cargas de archivos y otros escenarios
53+
54+
Cada parámetro puede tener un valor predeterminado. Cuando no se proporciona un parámetro en la solicitud MCP, se utilizará automáticamente el valor predeterminado. Incluso si el valor predeterminado es una cadena vacía (""), se utilizará. Por ejemplo:
55+
56+
```yaml
57+
args:
58+
- name: "theme"
59+
position: "body"
60+
required: true
61+
type: "string"
62+
description: "User interface theme"
63+
default: "light" # Cuando no se proporciona el parámetro theme en la solicitud, se usará "light" como valor predeterminado
64+
```
65+
66+
Cuando se usa `form-data` como posición del parámetro, no es necesario especificar `requestBody`, el sistema ensamblará automáticamente los parámetros en formato multipart/form-data. Por ejemplo:

i18n/fr/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,19 @@ Les positions de paramètres (position) prennent en charge les types suivants :
419419
- `body` : Le paramètre sera placé dans le corps de la requête au format JSON
420420
- `form-data` : Le paramètre sera placé dans le corps de la requête au format multipart/form-data, utilisé pour les téléchargements de fichiers et autres scénarios
421421

422-
Lorsque vous utilisez `form-data` comme position de paramètre, vous n'avez pas besoin de spécifier `requestBody`, le système assemblera automatiquement les paramètres au format multipart/form-data. Par exemple :
422+
Chaque paramètre peut avoir une valeur par défaut. Lorsqu'un paramètre n'est pas fourni dans la requête MCP, la valeur par défaut sera automatiquement utilisée. Même si la valeur par défaut est une chaîne vide (""), elle sera utilisée. Par exemple:
423+
424+
```yaml
425+
args:
426+
- name: "theme"
427+
position: "body"
428+
required: true
429+
type: "string"
430+
description: "User interface theme"
431+
default: "light" # Lorsque le paramètre theme n'est pas fourni dans la requête, "light" sera utilisé comme valeur par défaut
432+
```
433+
434+
Lorsque vous utilisez `form-data` comme position de paramètre, vous n'avez pas besoin de spécifier `requestBody`, le système assemblera automatiquement les paramètres au format multipart/form-data. Par exemple:
423435

424436
```yaml
425437
- name: "update_user_avatar"

i18n/hi/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,21 @@ routers:
4646
routers:
4747
- server: "mock-user-svc" # सेवा का नाम, servers में नाम के साथ संगत होना चाहिए
4848
prefix: "/mcp/user" # राउट उपसर्ग, वैश्विक रूप से अद्वितीय, दोहराया नहीं जा सकता
49-
```
49+
```
50+
51+
- `body`: पैरामीटर JSON अनुरोध बॉडी में रखे जाएंगे
52+
- `form-data`: पैरामीटर multipart/form-data अनुरोध बॉडी में रखे जाएंगे, फ़ाइल अपलोड और अन्य परिदृश्यों के लिए उपयोग किया जाता है
53+
54+
प्रत्येक पैरामीटर का एक डिफ़ॉल्ट मान हो सकता है। जब MCP अनुरोध में पैरामीटर प्रदान नहीं किया जाता है, तो डिफ़ॉल्ट मान स्वचालित रूप से उपयोग किया जाएगा। यहां तक कि अगर डिफ़ॉल्ट मान खाली स्ट्रिंग ("") है, तो भी इसका उपयोग किया जाएगा। उदाहरण के लिए:
55+
56+
```yaml
57+
args:
58+
- name: "theme"
59+
position: "body"
60+
required: true
61+
type: "string"
62+
description: "User interface theme"
63+
default: "light" # जब अनुरोध में theme पैरामीटर प्रदान नहीं किया जाता है, तो "light" को डिफ़ॉल्ट मान के रूप में उपयोग किया जाएगा
64+
```
65+
66+
जब `form-data` को पैरामीटर स्थिति के रूप में उपयोग किया जाता है, तो `requestBody` निर्दिष्ट करने की आवश्यकता नहीं होती है, सिस्टम स्वचालित रूप से पैरामीटर को multipart/form-data प्रारूप में जोड़ेगा। उदाहरण के लिए:

i18n/ja/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,21 @@ routers:
4646
routers:
4747
- server: "mock-user-svc" # サービス名、serversの名前と一致する必要がある
4848
prefix: "/mcp/user" # ルートプレフィックス、グローバルに一意、重複不可
49-
```
49+
```
50+
51+
- `body`: パラメータはJSONリクエストボディに配置されます
52+
- `form-data`: パラメータはmultipart/form-dataリクエストボディに配置され、ファイルアップロードなどのシナリオで使用されます
53+
54+
各パラメータにはデフォルト値を設定できます。MCPリクエストでパラメータが提供されない場合、デフォルト値が自動的に使用されます。デフォルト値が空文字列("")の場合でも使用されます。例えば:
55+
56+
```yaml
57+
args:
58+
- name: "theme"
59+
position: "body"
60+
required: true
61+
type: "string"
62+
description: "User interface theme"
63+
default: "light" # リクエストでthemeパラメータが提供されない場合、"light"がデフォルト値として使用されます
64+
```
65+
66+
`form-data`をパラメータ位置として使用する場合、`requestBody`を指定する必要はありません。システムは自動的にパラメータをmultipart/form-data形式に組み立てます。例えば:

i18n/ko/docusaurus-plugin-content-docs/current/configuration/gateways.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,21 @@ routers:
4646
routers:
4747
- server: "mock-user-svc" # 서비스 이름, servers의 이름과 일치해야 함
4848
prefix: "/mcp/user" # 라우트 접두사, 전역적으로 고유함, 중복 불가
49-
```
49+
```
50+
51+
- `body`: 매개변수는 JSON 요청 본문에 배치됩니다
52+
- `form-data`: 매개변수는 multipart/form-data 요청 본문에 배치되며, 파일 업로드 및 기타 시나리오에 사용됩니다
53+
54+
각 매개변수는 기본값을 가질 수 있습니다. MCP 요청에서 매개변수가 제공되지 않으면 기본값이 자동으로 사용됩니다. 기본값이 빈 문자열("")인 경우에도 사용됩니다. 예를 들어:
55+
56+
```yaml
57+
args:
58+
- name: "theme"
59+
position: "body"
60+
required: true
61+
type: "string"
62+
description: "User interface theme"
63+
default: "light" # 요청에서 theme 매개변수가 제공되지 않으면 "light"가 기본값으로 사용됩니다
64+
```
65+
66+
`form-data`를 매개변수 위치로 사용할 때는 `requestBody`를 지정할 필요가 없으며, 시스템은 자동으로 매개변수를 multipart/form-data 형식으로 조립합니다. 예를 들어:

0 commit comments

Comments
 (0)