Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion apps/docs/content/guides/realtime/protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,16 @@ The two special message types have a well defined binary format where the first
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Type (0x03) | Join Ref Size | Ref Size | Topic Size |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|User Event Size| Payload Enc. | Join Ref (variable length) |
|User Event Size| Metadata Size | Payload Enc. | Join Ref ... |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Ref (variable length) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Topic (variable length) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| User Event (variable length) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Metadata (variable length) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| User Payload (variable length) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
```
Expand All @@ -143,11 +145,13 @@ The two special message types have a well defined binary format where the first
- **Ref Size**: 1 byte, size of reference string (max 255)
- **Topic Size**: 1 byte, size of topic string (max 255)
- **User Event Size**: 1 byte, size of user event string (max 255)
- **Metadata Size**: 1 byte, size of metadata string (max 255)
- **Payload Encoding**: 1 byte (0 = binary, 1 = JSON)
- **Join Ref**: Variable length string
- **Ref**: Variable length string
- **Topic**: Variable length string
- **User Event**: Variable length string
- **Metadata**: Variable length JSON string
- **User Payload**: Variable length payload data

#### User Broadcast
Expand Down Expand Up @@ -386,6 +390,7 @@ Below is the same example from the previous section, showing the binary frame st
- Topic: `realtime:chat-room`
- Payload encoding being JSON
- User Event: `user-event`
- Metadata is empty
- User Payload

```
Expand All @@ -394,6 +399,7 @@ Below is the same example from the previous section, showing the binary frame st
0x01 // Ref Size
0x12 // Topic Size
0x0A // User Event Size
0x00 // Metadata Size
0x01 // Payload Encoding (1 = JSON)
10 // Actual Join Ref
1 // Actual Ref
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11192,14 +11192,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
{
"name": "redirect_uri",
"name": "redirect_url",
"type": {
"type": "intrinsic",
"name": "string"
},
"isOptional": true,
"comment": {
"shortText": "Redirect URI - present if user already consented (can be used to trigger immediate redirect)"
"shortText": "Redirect URL - present if user already consented (can be used to trigger immediate redirect)"
}
},
{
Expand Down Expand Up @@ -50643,14 +50643,14 @@ exports[`TS type spec parsing > matches snapshot 1`] = `
}
},
{
"name": "redirect_uri",
"name": "redirect_url",
"type": {
"type": "intrinsic",
"name": "string"
},
"isOptional": true,
"comment": {
"shortText": "Redirect URI - present if user already consented (can be used to trigger immediate redirect)"
"shortText": "Redirect URL - present if user already consented (can be used to trigger immediate redirect)"
}
},
{
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/features/ui/McpConfigPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ export function McpConfigPanel() {
const [selectedProject, setSelectedProject] = useState<{ ref: string; name: string } | null>(null)
const [selectedPlatform, setSelectedPlatform] = useState<'hosted' | 'local'>('hosted')
const [selectedClient, setSelectedClient] = useState<McpClient | null>(null)
const { theme } = useTheme()
const { resolvedTheme } = useTheme()
const sendTelemetryEvent = useSendTelemetryEvent()

const isPlatform = selectedPlatform === 'hosted'
Expand Down Expand Up @@ -325,7 +325,7 @@ export function McpConfigPanel() {
basePath="/docs"
className="mt-6"
projectRef={project?.ref}
theme={theme as 'light' | 'dark'}
theme={resolvedTheme as 'light' | 'dark'}
isPlatform={isPlatform}
onCopyCallback={handleCopy}
onInstallCallback={handleInstall}
Expand Down
8 changes: 8 additions & 0 deletions apps/docs/public/img/mcp-clients/factory-dark-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/docs/public/img/mcp-clients/factory-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/docs/public/img/mcp-clients/goose-dark-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/docs/public/img/mcp-clients/goose-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions apps/docs/public/img/mcp-clients/openai-dark-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions apps/docs/public/img/mcp-clients/openai-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions apps/docs/spec/api_v1_openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -8532,8 +8532,7 @@
"mfa_phone_template": { "type": "string", "nullable": true },
"nimbus_oauth_client_id": { "type": "string", "nullable": true },
"nimbus_oauth_client_secret": { "type": "string", "nullable": true }
},
"required": ["db_max_pool_size_unit"]
}
},
"RealtimeConfigResponse": {
"type": "object",
Expand Down
Loading
Loading