Rss MCP Server

🚀 RSS MCP Server

This project is an MCP (Model Context Protocol) server for RSS services supporting the FreshRSS API. It enables interaction with your RSS reader via LLM.

The project and its documentation were created by Gemini under human review, based on the original documentation at https://xueli-sherryli.github.io/friendlier-fresh-rss-api-doc/.

🚀 Quick Start

Clone the Repository

git clone https://github.com/your-username/rss-mcp-server.git
cd rss-mcp-server

Using uv

Create and Configure the Environment File

cp .env.example .env

Then, edit the .env file with your credentials.

Sync Dependencies

uv sync

Run the Server

uv run ./main.py

Using docker

Configure docker-compose.yml

If necessary, modify the port mapping in docker-compose.yml to avoid conflicts.

Create and Configure the Environment File

cp .env.example .env

Then, edit the .env file with your credentials.

Build and Run the Container

docker compose up -d
# or docker-compose up -d

📦 Installation

Configuration

Copy a .env file in the root directory and edit the following variables:

# Replace with your FreshAPI credentials and URL
GOOGLE_READER_EMAIL="alice"
GOOGLE_READER_PASSWD="Abcdef123456"
GOOGLE_READER_BASE_URL="https://freshrss.example.net/api/greader.php"

⚠️ Important Note

The GOOGLE_READER_EMAIL field is not necessarily an email address. It is used as the username for authentication with the FreshRSS API.

📄 Disclaimer

This MCP is designed to be compatible with any RSS reader that supports the FreshRSS API. However, it has only been tested with Tiny Tiny RSS + FreshRSS API.