Skip to main content

A Reddit client using PRAW

Project description

smithery badge

MCP Reddit Companion

An MCP tool that enables natural language interaction with your personal Reddit experience. Create custom curated feeds on Reddit and use your favorite LLM client to analyze, summarize, and engage with content that matters to you.

Example LLM Commands

Here are some example commands you can use with your LLM client:

# Basic Feed Interaction
"Show me the latest posts from my 'tech-news' feed"
"Summarize the top posts from my 'science' feed"
"What are the trending topics in my 'programming' feed?"

# Content Analysis
"What are the common themes in my 'ai' feed?"
"Which of my recent posts got the most engagement?"
"Summarize the discussions in my 'philosophy' feed"

# Personal Activity
"Show me my recent Reddit activity"
"What comments have I received on my posts?"
"Are there any unread messages in my inbox?"

# Engagement Tracking
"How are my recent posts performing?"
"Show me the most active discussions in my feeds"
"What posts got the most comments in my 'news' feed?"

Prerequisites

  • Python 3.11+
  • Reddit account credentials (username, password)
  • Docker (optional, for containerized deployment)
  • An MCP-compatible LLM client (like Cursor)

Installation

Local Installation

  1. Clone the repository:
git clone https://github.com/yourusername/mcp-reddit.git
cd mcp-reddit
  1. Install dependencies using uv:
uv pip install .
  1. Create a .env file with your Reddit API credentials:
REDDIT_CLIENT_ID=your_client_id
REDDIT_CLIENT_SECRET=your_client_secret
REDDIT_USERNAME=your_username
REDDIT_PASSWORD=your_password

Docker Installation

  1. Build the Docker image:
docker build -t mcp-reddit .
  1. Run the container (for passwords with special characters):
docker run \
  -e REDDIT_CLIENT_ID='your_client_id' \
  -e REDDIT_CLIENT_SECRET='your_client_secret' \
  -e REDDIT_USERNAME='your_username' \
  -e REDDIT_PASSWORD='your_password' \
  mcp-reddit

Note: If your password contains special characters (like !, $, etc.), make sure to:

  1. Use single quotes around the password
  2. Escape any special characters with a backslash
  3. Or use double quotes and escape the special characters

Example with special characters:

docker run \
  -e REDDIT_CLIENT_ID='your_client_id' \
  -e REDDIT_CLIENT_SECRET='your_client_secret' \
  -e REDDIT_USERNAME='your_username' \
  -e REDDIT_PASSWORD='your\!password' \
  mcp-reddit

Usage

Local Usage

  1. Start the MCP server:
uv run mcp dev src/mcp_reddit_companion/server.py

or

  1. Install in Claude Desktop
uv run mcp install src/mcp_reddit_companion/server.py 

Docker Usage

The MCP server will start automatically when the container runs. Connect your LLM client to interact with your Reddit feeds.

Configuration

Cursor Integration

To use with Cursor, add the following to your ~/.cursor/mcp.json:

{
  "mcpServers": {
    "reddit-companion": {
      "command": "uv",
      "args": [
        "--directory",
        "C:\\code\\personal\\mcp-reddit",
        "run",
        "mcp",
        "dev",
        "src/mcp_reddit_companion/server.py"
      ]
    }
  }
}

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_mcp_reddit-0.1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_mcp_reddit-0.1.1-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file mseep_mcp_reddit-0.1.1.tar.gz.

File metadata

  • Download URL: mseep_mcp_reddit-0.1.1.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_mcp_reddit-0.1.1.tar.gz
Algorithm Hash digest
SHA256 438256a9794470b3e1a832d83b467d6dcf5b9244c98ace0c1a42d6194257c7a6
MD5 5431c6397f987fcfe96054b359717670
BLAKE2b-256 c749c826c4781bd7a475927cab525e20d513903345d23856c693576d682be385

See more details on using hashes here.

File details

Details for the file mseep_mcp_reddit-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_mcp_reddit-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be61603eeca83bf146dfa390f6e47f1e06ba977d7299499d69c4798a8957fdc2
MD5 06fffeaf4f707a7f847178d253b4b29e
BLAKE2b-256 df61640ebd516f240d8f424ea0f30fa287dacead2f96152744817440e69dfc98

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page