QUICK_START.md•2.62 kB
# Quick Start Guide
## Setup in 3 Steps
### 1. Install Dependencies (Already Done!)
```bash
cd C:/Users/shake/Documents/Projects/restream-mcp-server
npm install
npm run build
```
### 2. Configure Claude Desktop
Edit your Claude Desktop config file:
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
Add this configuration:
```json
{
"mcpServers": {
"restream": {
"command": "node",
"args": ["C:/Users/shake/Documents/Projects/restream-mcp-server/dist/index.js"],
"env": {
"RESTREAM_CLIENT_ID": "83b2a54a-f7e5-42c6-b3e8-42816843ec7a",
"RESTREAM_CLIENT_SECRET": "11b7a2cd-d242-4b48-8876-595b10d8901a",
"RESTREAM_API_BASE_URL": "https://api.restream.io/v2"
}
}
}
}
```
### 3. Restart Claude Desktop
After saving the configuration, restart Claude Desktop to load the MCP server.
## Quick Test Commands
Try these commands in Claude:
1. **"List all my Restream channels"**
- Uses: `list_channels` tool
2. **"Show me my Restream profile"**
- Uses: `get_user_profile` tool
3. **"What's my current stream status?"**
- Uses: `get_current_stream` tool
4. **"Get my streaming analytics"**
- Uses: `get_stream_analytics` tool
## Verify It's Working
In Claude Desktop, you should see "restream" listed in the MCP servers section. You can verify by asking Claude:
"What MCP tools do you have available for Restream?"
Claude should list all 9 available tools.
## Common Issues
### Server Not Loading
- Check the file path in the config matches your actual location
- Ensure Node.js is installed and accessible
- Verify the build succeeded (check `dist/` folder exists)
### Authentication Errors
- Verify credentials in the config are correct
- Check Restream API status at developers.restream.io
## Need Help?
- Full documentation: See `README.md`
- Restream API Docs: https://developers.restream.io/docs
- MCP Documentation: https://modelcontextprotocol.io
## Project Structure
```
restream-mcp-server/
├── src/
│ ├── index.ts # Main MCP server
│ ├── restream-client.ts # Restream API client
│ └── types.ts # TypeScript types
├── dist/ # Compiled JavaScript
├── .env # Your credentials (DO NOT COMMIT)
├── package.json
├── tsconfig.json
└── README.md
```
## Development
Watch mode (rebuilds on changes):
```bash
npm run dev
```
Test with MCP Inspector:
```bash
npx @modelcontextprotocol/inspector node dist/index.js
```