Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENREPLAY_API_KEY | Yes | Organization API Key (find in Preferences > Account > Organization API Key) | |
| OPENREPLAY_API_URL | No | OpenReplay API URL. For cloud: https://api.openreplay.com (default). For self-hosted: Your instance URL | https://api.openreplay.com |
| OPENREPLAY_PROJECT_KEY | Yes | Project key from your project settings |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_projects | Get list of all projects in the organization |
| get_user_sessions | Get sessions for a specific user ID (API key authentication supported) |
| search_sessions | [Requires userId with API key auth] Search and filter sessions. Full search requires JWT authentication. |
| get_session_details | Get detailed information about a specific session including all events, errors, network requests, console logs, custom events, and performance metrics |
| get_session_events | Get all events from a session with optional filtering by event type |
| aggregate_sessions | Aggregate session data with various metrics and groupings |
| get_user_journey | Get the complete journey of a user across multiple sessions |
| get_errors_issues | Get errors and issues with their impact and affected sessions |
| get_funnel_analysis | Analyze user funnels and conversion paths |
| get_performance_metrics | Get performance metrics like page load times, largest contentful paint, time to interactive, etc. |
| execute_custom_query | Execute a custom query on the session data (supports SQL-like syntax for ClickHouse) |