G: F5 document the MCP stream and session delete

This commit is contained in:
ari committed 2026-10-20 15:54:13 -04:00
1 parent abd5b12cd0
commit a1117da01d
4 files changed
+183 -8

No files matched your search

+112
View File
@@ -900,6 +900,68 @@
}
},
"/mcp": {
"get": {
"tags": [
"mcp"
],
"summary": "MCP server-to-client stream",
"description": "Standalone `text/event-stream` for messages the server sends outside a request. The default session mode requires the `Mcp-Session-Id` returned by `initialize`; an unknown or terminated session is 404. Send `Accept: text/event-stream`.",
"operationId": "mcp_stream",
"parameters": [
{
"name": "Mcp-Session-Id",
"in": "header",
"description": "Session id returned by the `initialize` response",
"required": false,
"schema": {
"type": [
"string",
"null"
]
}
}
],
"responses": {
"200": {
"description": "SSE stream of server-to-client messages",
"content": {
"text/event-stream": {}
}
},
"400": {
"description": "`Mcp-Session-Id` is missing or `Mcp-Protocol-Version` is invalid"
},
"401": {
"description": "Missing or unknown bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorBody"
}
}
}
},
"403": {
"description": "`Host` or `Origin` not allowed (DNS-rebinding guard)"
},
"404": {
"description": "Unknown or terminated session"
},
"406": {
"description": "`Accept` does not include `text/event-stream`"
},
"503": {
"description": "The token database is unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorBody"
}
}
}
}
}
},
"post": {
"tags": [
"mcp"
@@ -960,6 +1022,56 @@
"description": "`Content-Type` is not `application/json`"
}
}
},
"delete": {
"tags": [
"mcp"
],
"summary": "End an MCP session",
"description": "Closes the session named by `Mcp-Session-Id` and frees its in-memory state. This ends an MCP session only; it never changes systemd, Docker or a peer.",
"operationId": "mcp_delete_session",
"parameters": [
{
"name": "Mcp-Session-Id",
"in": "header",
"description": "Session id returned by the `initialize` response",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Session closed"
},
"400": {
"description": "`Mcp-Session-Id` is missing or `Mcp-Protocol-Version` is invalid"
},
"401": {
"description": "Missing or unknown bearer token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorBody"
}
}
}
},
"403": {
"description": "`Host` or `Origin` not allowed (DNS-rebinding guard)"
},
"503": {
"description": "The token database is unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorBody"
}
}
}
}
}
}
}
},