MCP Reddit

🚀 MCP Reddit Server

This is a Reddit server based on the MCP (Model Context Protocol), specifically designed to interact with large language models like Claude. Through this service, you can use an AI assistant to browse and analyze content on Reddit.

🚀 Quick Start

To start using the MCP Reddit Server, follow these steps:

1. Clone the repository:

git clone https://github.com/nangeplus/mcp-reddit.git
cd mcp-reddit

2. Install dependencies:

pip install -r requirements.txt

3. Run the server:

python src/server.py

✨ Features

Search Posts

Search for posts within a specific subreddit.

Get Post Details

Retrieve detailed information and comments of a post.

Browse Popular Posts

Explore popular posts within a subreddit.

📦 Installation

Prerequisites

• Docker (Required)
• Python 3.12+ (For local development)
• Reddit API credentials (Required)

Obtain Reddit API Credentials

1. Visit https://www.reddit.com/prefs/apps
2. Click "create another app..."
3. Select "script"
4. Fill in the necessary information
5. Obtain the client_id and client_secret

Configure Environment Variables

Set the following environment variables:

REDDIT_CLIENT_ID=your_client_id
REDDIT_CLIENT_SECRET=your_client_secret
REDDIT_USER_AGENT=your_user_agent

Docker Installation Instructions

1. Clone the repository:

git clone https://github.com/nangeplus/mcp-reddit.git
cd mcp-reddit

2. Install dependencies:

pip install -r requirements.txt

3. Build the Docker image:

docker build -t mcp-reddit .

4. Run the container:

docker run -i --rm \
  -e REDDIT_CLIENT_ID=your_client_id \
  -e REDDIT_CLIENT_SECRET=your_client_secret \
  -e REDDIT_USER_AGENT=your_user_agent \
  mcp-reddit

📚 Documentation

Project Structure

nangeAGICode/reddit_chat_claude/
├── .github/
│   └── workflows/
│       └── docker.yml # GitHub Actions workflow configuration
├── src/
│   ├── init.py
│   └── server.py # Core code of the MCP server
├── .gitignore # Git ignore file configuration
├── Dockerfile # Docker build file
├── LICENSE # MIT license
├── README.md # Project documentation
└── requirements.txt # List of Python dependencies

Notes

Security

• Keep your Reddit API credentials secure.
• Do not share your configuration files in public.
• It is recommended to use environment variables instead of hard - coded credentials.

Usage Limitations

• The Reddit API has rate limits.
• The default number of returned comments is limited to 10.
• The default limit for search results is 5.

Troubleshooting

• Check if the API credentials are correct.
• Ensure a stable network connection.
• Check the log output for detailed error information.

Contribution Guidelines

1. Fork the project.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.