mcp-reddit

🚀 MCP Reddit 服务器

本项目是一个基于MCP（模型上下文协议）协议的Reddit服务器，专为与Claude等大语言模型交互而设计。借助该服务，你能让AI助手帮你浏览和分析Reddit上的内容。

🚀 快速开始

克隆仓库

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

安装依赖

pip install -r requirements.txt

运行服务器

python src/server.py

✨ 主要特性

• 搜索特定subreddit中的帖子
• 获取帖子详细信息和评论
• 浏览subreddit中的热门帖子

📦 安装指南

前提条件

• Docker（必须）
• Python 3.12+（用于本地开发）
• Reddit API凭证（必需）

获取Reddit API凭证

1. 访问 https://www.reddit.com/prefs/apps
2. 点击"create another app..."
3. 选择"script"
4. 填写必要信息
5. 获取client_id和client_secret

环境变量配置

需要设置以下环境变量：

REDDIT_CLIENT_ID=你的client_id
REDDIT_CLIENT_SECRET=你的client_secret
REDDIT_USER_AGENT=你的user_agent

Docker安装说明

1. 克隆仓库：

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

2. 安装依赖：

   pip install -r requirements.txt
   

3. 构建Docker镜像：

   docker build -t mcp-reddit .
   

4. 运行容器：

   docker run -i --rm \
     -e REDDIT_CLIENT_ID=你的client_id \
     -e REDDIT_CLIENT_SECRET=你的client_secret \
     -e REDDIT_USER_AGENT=你的user_agent \
     mcp-reddit
   

📚 详细文档

项目结构

nangeAGICode/reddit_chat_claude/
├── .github/
│   └── workflows/
│       └── docker.yml # GitHub Actions工作流配置
├── src/
│   ├── init.py
│   └── server.py # MCP服务器核心代码
├── .gitignore # Git忽略文件配置
├── Dockerfile # Docker构建文件
├── LICENSE # MIT许可证
├── README.md # 项目说明文档
└── requirements.txt # Python依赖包列表

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情

⚠️ 注意事项

安全性

• 请妥善保管你的Reddit API凭证
• 不要在公共场合分享你的配置文件
• 建议使用环境变量而不是硬编码凭证

使用限制

• Reddit API有调用频率限制
• 默认返回的评论数量限制为10条
• 搜索结果默认限制为5条

故障排除

• 检查API凭证是否正确
• 确保网络连接正常
• 查看日志输出了解详细错误信息

🤝 贡献指南

1. Fork 项目
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启 Pull Request