Skip to content

Add payloadDir field to MCP Gateway configuration #13178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lpcox merged 3 commits into from
Feb 2, 2026
+20 −1
Merged

Add payloadDir field to MCP Gateway configuration #13178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83cec0f
Initial plan
Copilot Feb 1, 2026
f9c60a3
Add payloadDir field to gateway configuration in MCP Gateway Specific…
Copilot Feb 2, 2026
955c01b
Simplify payloadDir descriptions per code review feedback
Copilot Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/public/schemas/mcp-gateway-config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,11 @@
"description": "Tool invocation timeout in seconds. The gateway enforces this timeout for individual tool/method calls to MCP servers.",
"minimum": 1,
"default": 60
},
"payloadDir": {
"type": "string",
"description": "Directory path for storing large payload JSON files for authenticated clients.",
"minLength": 1
}
},
"required": ["port", "domain", "apiKey"],
Expand Down
11 changes: 10 additions & 1 deletion docs/src/content/docs/reference/mcp-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:

# MCP Gateway Specification

**Version**: 1.7.0
**Version**: 1.8.0
**Status**: Draft Specification
**Latest Version**: [mcp-gateway](/gh-aw/reference/mcp-gateway/)
**JSON Schema**: [mcp-gateway-config.schema.json](/gh-aw/schemas/mcp-gateway-config.schema.json)
Expand Down Expand Up @@ -245,6 +245,7 @@ The `gateway` section is required and configures gateway-specific behavior:
| `apiKey` | string | Yes | API key for authentication |
| `startupTimeout` | integer | No | Server startup timeout in seconds (default: 30) |
| `toolTimeout` | integer | No | Tool invocation timeout in seconds (default: 60) |
| `payloadDir` | string | No | Directory path for storing large payload JSON files for authenticated clients |

#### 4.1.3a Top-Level Configuration Fields

Expand Down Expand Up @@ -1347,6 +1348,14 @@ Content-Type: application/json

## Change Log

### Version 1.8.0 (Draft)

- **Added**: `payloadDir` field to gateway configuration (Section 4.1.3)
- Optional directory path where the gateway places large payload JSON files for authenticated clients
- Enables efficient handling of large response payloads by offloading them to the filesystem
- Gateway implementations MUST ensure proper isolation between clients' payload files when this feature is used
- Payload files are accessible to clients authenticated with the corresponding API key

### Version 1.7.0 (Draft)

- **Added**: Comprehensive volume mount documentation for stdio servers (Section 4.1.5)
Expand Down
5 changes: 5 additions & 0 deletions pkg/workflow/schemas/mcp-gateway-config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,11 @@
"description": "Tool invocation timeout in seconds. The gateway enforces this timeout for individual tool/method calls to MCP servers.",
"minimum": 1,
"default": 60
},
"payloadDir": {
"type": "string",
"description": "Directory path for storing large payload JSON files for authenticated clients.",
"minLength": 1
}
},
"required": ["port", "domain", "apiKey"],
Expand Down
Loading