Skip to main content
Glama

get_top_posts

Retrieve top-performing posts from any subreddit by specifying time period and quantity for content analysis or trend monitoring.

Instructions

Get top posts from a subreddit

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
subredditYesName of the subreddit
time_filterNoTime period to filter posts (e.g. 'day', 'week', 'month', 'year', 'all')week
limitNoNumber of posts to fetch

Implementation Reference

  • Main handler function implementing the get_top_posts tool logic: fetches top posts via RedditClient, formats them with formatPostInfo, generates summaries, and returns structured markdown content.
    export async function getTopPosts(params: {
      subreddit: string;
      time_filter?: string;
      limit?: number;
    }) {
      const { subreddit, time_filter = "week", limit = 10 } = params;
      const client = getRedditClient();
    
      if (!client) {
        throw new McpError(
          ErrorCode.InternalError,
          "Reddit client not initialized"
        );
      }
    
      try {
        console.log(`[Tool] Getting top posts from r/${subreddit}`);
        const posts = await client.getTopPosts(subreddit, time_filter, limit);
        const formattedPosts = posts.map(formatPostInfo);
    
        const postSummaries = formattedPosts
          .map(
            (post, index) => `
    ### ${index + 1}. ${post.title}
    - Author: u/${post.author}
    - Score: ${post.stats.score.toLocaleString()} (${(
              post.stats.upvoteRatio * 100
            ).toFixed(1)}% upvoted)
    - Comments: ${post.stats.comments.toLocaleString()}
    - Posted: ${post.metadata.posted}
    - Link: ${post.links.shortLink}
        `
          )
          .join("\n");
    
        return {
          content: [
            {
              type: "text",
              text: `
    # Top Posts from r/${subreddit} (${time_filter})
    
    ${postSummaries}
              `,
            },
          ],
        };
      } catch (error) {
        console.error(`[Error] Error getting top posts: ${error}`);
        throw new McpError(
          ErrorCode.InternalError,
          `Failed to fetch top posts: ${error}`
        );
      }
    }
  • Input schema definition for the get_top_posts tool, specifying required 'subreddit' parameter and optional 'time_filter' (enum) and 'limit'.
    name: "get_top_posts",
    description: "Get top posts from a subreddit",
    inputSchema: {
      type: "object",
      properties: {
        subreddit: {
          type: "string",
          description: "Name of the subreddit",
        },
        time_filter: {
          type: "string",
          description:
            "Time period to filter posts (e.g. 'day', 'week', 'month', 'year', 'all')",
          enum: ["day", "week", "month", "year", "all"],
          default: "week",
        },
        limit: {
          type: "integer",
          description: "Number of posts to fetch",
          default: 10,
        },
      },
      required: ["subreddit"],
    },
  • src/index.ts:434-441 (registration)
    Registration of the get_top_posts handler in the MCP server's CallToolRequestSchema switch statement, dispatching to tools.getTopPosts.
    case "get_top_posts":
      return await tools.getTopPosts(
        toolParams as {
          subreddit: string;
          time_filter?: string;
          limit?: number;
        }
      );
  • Supporting helper method in RedditClient class that makes the actual API call to fetch top posts from Reddit's OAuth API and parses the response into RedditPost objects.
    async getTopPosts(
      subreddit: string,
      timeFilter: string = "week",
      limit: number = 10
    ): Promise<RedditPost[]> {
      await this.authenticate();
      try {
        const endpoint = subreddit ? `/r/${subreddit}/top.json` : "/top.json";
        const response = await this.api.get(endpoint, {
          params: {
            t: timeFilter,
            limit,
          },
        });
    
        return response.data.data.children.map((child: any) => {
          const post = child.data;
          return {
            id: post.id,
            title: post.title,
            author: post.author,
            subreddit: post.subreddit,
            selftext: post.selftext,
            url: post.url,
            score: post.score,
            upvoteRatio: post.upvote_ratio,
            numComments: post.num_comments,
            createdUtc: post.created_utc,
            over18: post.over_18,
            spoiler: post.spoiler,
            edited: !!post.edited,
            isSelf: post.is_self,
            linkFlairText: post.link_flair_text,
            permalink: post.permalink,
          };
        });
      } catch (error) {
        console.error(
          `[Error] Failed to get top posts for ${subreddit || "home"}:`,
          error
        );
        throw new Error(`Failed to get top posts for ${subreddit || "home"}`);
      }
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool 'gets' data, implying a read-only operation, but doesn't mention potential rate limits, authentication requirements, pagination, or what 'top' entails (e.g., sorting criteria). The description is minimal and misses key behavioral traits needed for safe and effective use.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words, making it easy to parse. However, it's front-loaded but overly brief, potentially sacrificing clarity for brevity. It earns a high score for conciseness but loses a point because the minimalism might hinder understanding without additional context.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (3 parameters, no output schema, no annotations), the description is incomplete. It lacks details on behavioral aspects like rate limits or authentication, doesn't explain the output format (e.g., what data is returned for posts), and offers no usage guidelines. While the schema covers parameters well, the overall context for an agent to use the tool effectively is insufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with clear descriptions for all parameters (limit, subreddit, time_filter) including defaults and enum values. The description adds no additional parameter semantics beyond what the schema provides, such as explaining 'top' in relation to parameters. Since the schema is comprehensive, the baseline score of 3 is appropriate, as the description doesn't compensate but also doesn't detract.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Get top posts from a subreddit' clearly states the action (get) and resource (top posts from a subreddit), but it's somewhat vague about what 'top' means (e.g., by upvotes, hotness) and doesn't explicitly distinguish this tool from siblings like 'get_reddit_post' (which might fetch a specific post) or 'search_reddit' (which might allow broader queries). It avoids tautology but lacks specificity for full differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention siblings like 'get_reddit_post' for individual posts or 'search_reddit' for custom searches, nor does it specify prerequisites or exclusions (e.g., whether it requires authentication). Usage is implied by the name but not explicitly stated, leaving gaps for an agent to infer context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.