使用说明

项目简介

MCP Server Reddit 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为大型语言模型(LLM)提供访问 Reddit 公共 API 的能力。通过此服务器,LLM 可以与 Reddit 内容进行交互,例如浏览首页热门帖子、获取 subreddit 信息、以及阅读帖子评论等。

主要功能点

  • 浏览 Reddit 首页: 获取 Reddit 首页的热门帖子。
  • 获取 Subreddit 信息: 查询特定 subreddit 的信息,如订阅人数和描述。
  • 获取 Subreddit 帖子: 获取特定 subreddit 的热门、最新、置顶或上升中的帖子。
  • 获取帖子内容和评论: 获取指定 Reddit 帖子的详细内容和评论。

安装步骤

推荐使用 'uv' 或 'pip' 进行安装。

使用 uv (推荐,无需安装)

  1. 确保已安装 'uv' 和 'uvx' (参考仓库 README)。
  2. 无需额外安装,配置客户端时直接使用命令 'uvx mcp-server-reddit' 即可。

使用 PIP 安装

  1. 确保已安装 Python 和 pip。
  2. 打开终端,运行命令:
    pip install mcp-server-reddit

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以下是配置示例,以 JSON 格式提供,请根据您使用的 MCP 客户端 (如 Claude, Zed) 的配置方法进行配置。

JSON 配置示例

{
  "reddit": {
    "command": "python",
    "args": ["-m", "mcp_server_reddit"]
  }
}

配置参数说明

  • 'reddit': 服务器名称,可以自定义,用于在客户端中标识该服务器。
  • 'command': 启动 MCP Server Reddit 的命令,这里使用 'python' 解释器。
  • 'args': 传递给 'python' 命令的参数,'-m mcp_server_reddit' 表示以模块方式运行 'mcp_server_reddit',即启动服务器程序。

基本使用方法

  1. 启动 MCP Server Reddit 服务器 (如果使用 'uv' 或 ClaudeMind 等方式,通常由客户端自动启动)。
  2. 在 MCP 客户端中,配置上述 JSON 信息,将 MCP 客户端连接到 MCP Server Reddit。
  3. 在 MCP 客户端中,LLM 即可通过预定义的工具与 Reddit 进行交互。例如,询问 "What are the current hot posts on Reddit's frontpage?",客户端将调用 'get_frontpage_posts' 工具,MCP Server Reddit 会返回 Reddit 首页的热门帖子信息。

注意

  • 请确保您的 MCP 客户端支持 MCP 协议和自定义服务器配置。
  • 详细工具列表和参数请参考仓库 README.md 文件。

信息

分类

网页与API