- Home
- MCP servers
- Restream
Restream
- javascript
0
GitHub Stars
javascript
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"shaktech786-restream-mcp-server": {
"command": "npx",
"args": [
"-y",
"@shaktech786/restream-mcp-server"
],
"env": {
"RESTREAM_CLIENT_ID": "YOUR_CLIENT_ID",
"RESTREAM_API_BASE_URL": "https://api.restream.io/v2",
"RESTREAM_CLIENT_SECRET": "YOUR_CLIENT_SECRET"
}
}
}
}You can run a Restream MCP Server locally to manage Restream channels, control streams, and fetch analytics through natural language queries. This MCP server connects to Restream using credentials you provide and exposes tools you can invoke from a client that speaks the MCP protocol, such as Claude Desktop. It supports starting and stopping streams, updating settings, listing channels, and retrieving analytics in a streamlined, automation-friendly way.
How to use
Using the Restream MCP Server, you authenticate with Restream and then perform actions via your MCP client. Start by configuring your MCP client with one or more MCP server entries. You can fetch your user profile, manage channels, control the current stream, and retrieve analytics. Typical workflows include enabling a channel, starting a stream with a given title, updating stream details, and inspecting analytics to monitor performance.
How to install
Prerequisites: you need Node.js 18 or higher and npm or yarn. You also need Restream API credentials (Client ID and Client Secret). Once you have those, install the MCP server package.
# Option 1: Install from npm (recommended)
npm install -g @shaktech786/restream-mcp-server
# Or install locally in your project
npm install @shaktech786/restream-mcp-server
Option 2: Install from source
- Clone the repository
- Install dependencies
- Build the server
git clone https://github.com/shaktech786/restream-mcp-server.git
cd restream-mcp-server
npm install
npm run build
Configure credentials in an environment file or in your Claude Desktop config. Required values include RESTREAM_CLIENT_ID, RESTREAM_CLIENT_SECRET, and RESTREAM_API_BASE_URL.
RESTREAM_CLIENT_ID=your_client_id_here
RESTREAM_CLIENT_SECRET=your_client_secret_here
RESTREAM_API_BASE_URL=https://api.restream.io/v2
If you are using Claude Desktop, add one MCP server entry per runtime method you want to support (see the examples in the configuration section). Restart Claude Desktop after saving the configuration.
Additional content
Configuration notes and example configurations are provided to enable both local development and production-style usage. The MCP server can run via a local runtime (stdio) or be accessed through an HTTP-based remote MCP configuration, depending on how you set up your client.
# Example: Claude Desktop configuration (npm-based runtime)
{
"mcpServers": {
"restream": {
"command": "npx",
"args": ["-y", "@shaktech786/restream-mcp-server"],
"env": {
"RESTREAM_CLIENT_ID": "your_client_id_here",
"RESTREAM_CLIENT_SECRET": "your_client_secret_here",
"RESTREAM_API_BASE_URL": "https://api.restream.io/v2"
}
}
}
}
# Example: Claude Desktop configuration from source installation
{
"mcpServers": {
"restream": {
"command": "node",
"args": ["/absolute/path/to/restream-mcp-server/dist/index.js"],
"env": {
"RESTREAM_CLIENT_ID": "your_client_id_here",
"RESTREAM_CLIENT_SECRET": "your_client_secret_here",
"RESTREAM_API_BASE_URL": "https://api.restream.io/v2"
}
}
}
}
Available tools
get_user_profile
Retrieve authenticated user profile information including email, display name, and account details.
list_channels
List all connected streaming channels with their connection status across platforms like YouTube, Twitch, and Facebook.
get_channel
Fetch detailed information about a specific channel by its ID.
update_channel_status
Enable or disable a specific streaming channel by its ID.
get_current_stream
Obtain information about the current active stream, including title, status, RTMP URL, and viewer count.
update_stream_settings
Modify current stream settings such as title, description, and privacy.
get_stream_analytics
Retrieve analytics and statistics for streams, including viewer counts and engagement metrics.
start_stream
Start a new stream with optional settings like title, description, and privacy.
stop_stream
Stop the currently active stream.