add files
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# mcp-jellyfin
|
||||
|
||||
An MCP server to interface with the Jellyfin API.
|
||||
|
||||
## Features
|
||||
- Search through Jellyfin libraries (Movies, Series, etc.)
|
||||
- List active user sessions and playback information
|
||||
|
||||
## Setup
|
||||
|
||||
### Prerequisites
|
||||
- Python 3.10+
|
||||
- `uv` (recommended) or `pip`
|
||||
|
||||
### Installation
|
||||
|
||||
Using [uv](https://github.com/astral-sh/uv):
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
Using pip:
|
||||
```bash
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
Create a `.env` file based on `.env.example`:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Add your Jellyfin credentials to the `.env` file:
|
||||
- `JELLYFIN_URL`: Your Jellyfin server URL (e.g., `http://192.168.1.10:8096`)
|
||||
- `JELLYFIN_API_KEY`: Your Jellyfin API key
|
||||
|
||||
## Usage
|
||||
|
||||
To run the MCP server:
|
||||
```bash
|
||||
python src/jellyfin_mcp/server.py
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
Reference in New Issue
Block a user