Skip to content

Commit 12d3304

Browse files
authored
Merge pull request #1256 from tisnik/lcore-1356-updated-doc
LCORE-1356: updated doc
2 parents 00dd2e3 + 1b800d0 commit 12d3304

4 files changed

Lines changed: 47 additions & 11 deletions

File tree

docs/config.html

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -693,26 +693,31 @@ <h2 id="customization">Customization</h2>
693693
<td/>
694694
</tr>
695695
<tr class="odd">
696+
<td>disable_shield_ids_override</td>
697+
<td>boolean</td>
698+
<td/>
699+
</tr>
700+
<tr class="even">
696701
<td>system_prompt_path</td>
697702
<td>string</td>
698703
<td/>
699704
</tr>
700-
<tr class="even">
705+
<tr class="odd">
701706
<td>system_prompt</td>
702707
<td>string</td>
703708
<td/>
704709
</tr>
705-
<tr class="odd">
710+
<tr class="even">
706711
<td>agent_card_path</td>
707712
<td>string</td>
708713
<td/>
709714
</tr>
710-
<tr class="even">
715+
<tr class="odd">
711716
<td>agent_card_config</td>
712717
<td>object</td>
713718
<td/>
714719
</tr>
715-
<tr class="odd">
720+
<tr class="even">
716721
<td>custom_profile</td>
717722
<td/>
718723
<td/>
@@ -1056,13 +1061,26 @@ <h2 id="modelcontextprotocolserver">ModelContextProtocolServer</h2>
10561061
<td>authorization_headers</td>
10571062
<td>object</td>
10581063
<td>Headers to send to the MCP server. The map contains the header name
1059-
and the path to a file containing the header value (secret). There are 2
1064+
and the path to a file containing the header value (secret). There are 3
10601065
special cases: 1. Usage of the kubernetes token in the header. To
10611066
specify this use a string &#x2018;kubernetes&#x2019; instead of the file path. 2.
1062-
Usage of the client provided token in the header. To specify this use a
1063-
string &#x2018;client&#x2019; instead of the file path.</td>
1067+
Usage of the client-provided token in the header. To specify this use a
1068+
string &#x2018;client&#x2019; instead of the file path. 3. Usage of the oauth token in
1069+
the header. To specify this use a string &#x2018;oauth&#x2019; instead of the file
1070+
path.</td>
10641071
</tr>
10651072
<tr class="odd">
1073+
<td>headers</td>
1074+
<td>array</td>
1075+
<td>List of HTTP header names to automatically forward from the incoming
1076+
request to this MCP server. Headers listed here are extracted from the
1077+
original client request and included when calling the MCP server. This
1078+
is useful when infrastructure components (e.g.&#xA0;API gateways) inject
1079+
headers that MCP servers need, such as x-rh-identity in HCC. Header
1080+
matching is case-insensitive. These headers are additive with
1081+
authorization_headers and MCP-HEADERS.</td>
1082+
</tr>
1083+
<tr class="even">
10661084
<td>timeout</td>
10671085
<td>integer</td>
10681086
<td>Timeout in seconds for requests to the MCP server. If not specified,

docs/config.json

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,11 @@
583583
"title": "Disable Query System Prompt",
584584
"type": "boolean"
585585
},
586+
"disable_shield_ids_override": {
587+
"default": false,
588+
"title": "Disable Shield Ids Override",
589+
"type": "boolean"
590+
},
586591
"system_prompt_path": {
587592
"type": "string",
588593
"nullable": true,
@@ -866,10 +871,18 @@
866871
"additionalProperties": {
867872
"type": "string"
868873
},
869-
"description": "Headers to send to the MCP server. The map contains the header name and the path to a file containing the header value (secret). There are 2 special cases: 1. Usage of the kubernetes token in the header. To specify this use a string 'kubernetes' instead of the file path. 2. Usage of the client provided token in the header. To specify this use a string 'client' instead of the file path.",
874+
"description": "Headers to send to the MCP server. The map contains the header name and the path to a file containing the header value (secret). There are 3 special cases: 1. Usage of the kubernetes token in the header. To specify this use a string 'kubernetes' instead of the file path. 2. Usage of the client-provided token in the header. To specify this use a string 'client' instead of the file path. 3. Usage of the oauth token in the header. To specify this use a string 'oauth' instead of the file path. ",
870875
"title": "Authorization headers",
871876
"type": "object"
872877
},
878+
"headers": {
879+
"description": "List of HTTP header names to automatically forward from the incoming request to this MCP server. Headers listed here are extracted from the original client request and included when calling the MCP server. This is useful when infrastructure components (e.g. API gateways) inject headers that MCP servers need, such as x-rh-identity in HCC. Header matching is case-insensitive. These headers are additive with authorization_headers and MCP-HEADERS.",
880+
"items": {
881+
"type": "string"
882+
},
883+
"title": "Propagated headers",
884+
"type": "array"
885+
},
873886
"timeout": {
874887
"type": "integer",
875888
"nullable": true,

docs/config.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ Service customization.
209209
|-------|------|-------------|
210210
| profile_path | string | |
211211
| disable_query_system_prompt | boolean | |
212+
| disable_shield_ids_override | boolean | |
212213
| system_prompt_path | string | |
213214
| system_prompt | string | |
214215
| agent_card_path | string | |
@@ -372,7 +373,7 @@ Useful resources:
372373
| name | string | MCP server name that must be unique |
373374
| provider_id | string | MCP provider identification |
374375
| url | string | URL of the MCP server |
375-
| authorization_headers | object | Headers to send to the MCP server. The map contains the header name and the path to a file containing the header value (secret). There are 3 special cases: 1. Usage of the kubernetes token in the headeruse the string 'kubernetes' instead of the file path. 2. Usage of the client-provided token in the headeruse the string 'client' instead of the file path. 3. Usage of OAuth token (resolved at request time or 401 with WWW-Authenticate) — use the string 'oauth' instead of the file path. |
376+
| authorization_headers | object | Headers to send to the MCP server. The map contains the header name and the path to a file containing the header value (secret). There are 3 special cases: 1. Usage of the kubernetes token in the header. To specify this use a string 'kubernetes' instead of the file path. 2. Usage of the client-provided token in the header. To specify this use a string 'client' instead of the file path. 3. Usage of the oauth token in the header. To specify this use a string 'oauth' instead of the file path. |
376377
| headers | array | List of HTTP header names to automatically forward from the incoming request to this MCP server. Headers listed here are extracted from the original client request and included when calling the MCP server. This is useful when infrastructure components (e.g. API gateways) inject headers that MCP servers need, such as x-rh-identity in HCC. Header matching is case-insensitive. These headers are additive with authorization_headers and MCP-HEADERS. |
377378
| timeout | integer | Timeout in seconds for requests to the MCP server. If not specified, the default timeout from Llama Stack will be used. Note: This field is reserved for future use when Llama Stack adds timeout support. |
378379

docs/openapi.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4447,7 +4447,7 @@
44474447
],
44484448
"summary": "Handle A2A Jsonrpc",
44494449
"description": "Handle A2A JSON-RPC requests following the A2A protocol specification.\n\nThis endpoint uses the DefaultRequestHandler from the A2A SDK to handle\nall JSON-RPC requests including message/send, message/stream, etc.\n\nThe A2A SDK application is created per-request to include authentication\ncontext while still leveraging FastAPI's authorization middleware.\n\nAutomatically detects streaming requests (message/stream JSON-RPC method)\nand returns a StreamingResponse to enable real-time chunk delivery.\n\nArgs:\n request: FastAPI request object\n auth: Authentication tuple\n mcp_headers: MCP headers for context propagation\n\nReturns:\n JSON-RPC response or streaming response",
4450-
"operationId": "handle_a2a_jsonrpc_a2a_post",
4450+
"operationId": "handle_a2a_jsonrpc_a2a_get",
44514451
"responses": {
44524452
"200": {
44534453
"description": "Successful Response",
@@ -4465,7 +4465,7 @@
44654465
],
44664466
"summary": "Handle A2A Jsonrpc",
44674467
"description": "Handle A2A JSON-RPC requests following the A2A protocol specification.\n\nThis endpoint uses the DefaultRequestHandler from the A2A SDK to handle\nall JSON-RPC requests including message/send, message/stream, etc.\n\nThe A2A SDK application is created per-request to include authentication\ncontext while still leveraging FastAPI's authorization middleware.\n\nAutomatically detects streaming requests (message/stream JSON-RPC method)\nand returns a StreamingResponse to enable real-time chunk delivery.\n\nArgs:\n request: FastAPI request object\n auth: Authentication tuple\n mcp_headers: MCP headers for context propagation\n\nReturns:\n JSON-RPC response or streaming response",
4468-
"operationId": "handle_a2a_jsonrpc_a2a_post",
4468+
"operationId": "handle_a2a_jsonrpc_a2a_get",
44694469
"responses": {
44704470
"200": {
44714471
"description": "Successful Response",
@@ -8843,6 +8843,7 @@
88438843
"properties": {
88448844
"contents": {
88458845
"type": "string",
8846+
"maxLength": 65536,
88468847
"title": "Contents",
88478848
"description": "File contents read on client",
88488849
"default": "",
@@ -8898,6 +8899,7 @@
88988899
"properties": {
88998900
"stdin": {
89008901
"type": "string",
8902+
"maxLength": 65536,
89018903
"title": "Stdin",
89028904
"description": "Redirect input from stdin",
89038905
"default": "",
@@ -8965,6 +8967,7 @@
89658967
"properties": {
89668968
"question": {
89678969
"type": "string",
8970+
"maxLength": 10240,
89688971
"minLength": 1,
89698972
"title": "Question",
89708973
"description": "User question",
@@ -9073,6 +9076,7 @@
90739076
"properties": {
90749077
"output": {
90759078
"type": "string",
9079+
"maxLength": 65536,
90769080
"title": "Output",
90779081
"description": "Terminal output from client",
90789082
"default": "",

0 commit comments

Comments
 (0)