Skip to main content

Reddit API tools and examples

Project description

Reddit MCP

License: MIT

A plug-and-play MCP server to browse, search, and read Reddit.

Demo

Here's a short video showing how to use this in Claude Desktop:

https://github.com/user-attachments/assets/a2e9f2dd-a9ac-453f-acd9-1791380ebdad

Features

  • Detailed parameter validation with pydantic
  • Uses the reliable PRAW library under the hood
  • Built-in rate limiting protection thanks to PRAW

Caveats

  • Only supports read features for now. If you want to use write features, upvote the issue or send a PR! 🙌
  • Tools use tokens. To use this with Claude, you may need to be a Pro user to use many tool calls. Free tier users should be fine with lighter tool usage. Your token usage is your responsibility.

Installation

Prerequisite: Reddit API credentials

Create a developer app in your Reddit account if you don't already have one. This will give you a client_id and client_secret to use in the following steps. If you already have these, you can skip this step.

Claude Desktop

To install into Claude Desktop:

  • Follow the instructions here until the section "Open up the configuration file in any text editor."
  • Add the following to the file depending on your preferred installation method:

Using uvx (recommended)

"mcpServers": {
  "reddit": {
    "command": "uvx",
    "args": ["reddit-mcp"],
    "env": {
      "REDDIT_CLIENT_ID": "<client_id>",
      "REDDIT_CLIENT_SECRET": "<client_secret>"
    }
  }
}

Using PIP

First install the package:

pip install reddit-mcp

Then add the following to the configuration file:

"mcpServers": {
  "reddit": {
    "command": "python",
    "args": ["-m", "reddit_mcp"],
    "env": {
      "REDDIT_CLIENT_ID": "<client_id>",
      "REDDIT_CLIENT_SECRET": "<client_secret>"
    }
  }
}

Others

You can use this server with any MCP client, including agent frameworks (LangChain, LlamaIndex, AutoGen, etc). For an example AutoGen integration, check out the example.

Tools

The tools the server will expose are:

Name Description
get_comment Access a comment
get_comments_by_submission Access comments of a submission
get_submission Access a submission
get_subreddit Access a subreddit by name
search_posts Search posts in a subreddit
search_subreddits Search subreddits by name or description

Contributing

Contributions are welcome! See CONTRIBUTING.md for more information.

Acknowledgments

  • PRAW for an amazingly reliable library 💙

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

reddit_mcp-0.1.0.tar.gz (17.4 MB view details)

Uploaded Source

Built Distribution

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

reddit_mcp-0.1.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file reddit_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: reddit_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 17.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for reddit_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 810437219775f127e25beda5d705f632148e26b1ab2c288eacf09e87f8ccebcc
MD5 1d218aef7071bd6d2f09f284477b7b8d
BLAKE2b-256 062fc5a0f1742c140f4180d0dbf00bef9b95a85e730a6eb2bd4dd551c95b3fc8

See more details on using hashes here.

File details

Details for the file reddit_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reddit_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 152f494fbc4ad413eacb56662b32a5f3ee67bdc6ce949bf80cd38d3d637ad804
MD5 7f921b6c6b4072a969424bc7d4b78aa4
BLAKE2b-256 7a21a60d5682acb0dcf391a1c8e4f51782ebb09673515c33661184ea3b47baba

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