@prmichaelsen/reddit-mcp 0.1.0 → 0.1.1

package/src/tools/moderation.ts

@@ -0,0 +1,292 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import type { RedditClient } from "../client/reddit.js";
+
+const paginationParams = {
+  limit: z
+    .number()
+    .min(1)
+    .max(100)
+    .optional()
+    .describe("Number of items to return (1-100, default 25)"),
+  after: z.string().optional().describe("Fullname to paginate after"),
+  before: z.string().optional().describe("Fullname to paginate before"),
+};
+
+function buildParams(
+  input: Record<string, unknown>,
+): Record<string, string | undefined> {
+  const params: Record<string, string | undefined> = {};
+  for (const [key, value] of Object.entries(input)) {
+    if (value !== undefined && value !== null) {
+      params[key] = String(value);
+    }
+  }
+  return params;
+}
+
+export function registerModerationTools(
+  server: McpServer,
+  client: RedditClient,
+): void {
+  // === Mod Action Tools (Task 16) ===
+
+  server.tool(
+    "reddit_approve",
+    "Approve a post or comment in the mod queue. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_) to approve"),
+    },
+    async (input) => {
+      const data = await client.post("/api/approve", { id: input.id });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_remove",
+    "Remove a post or comment as a moderator. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_) to remove"),
+      spam: z
+        .boolean()
+        .optional()
+        .describe("If true, mark as spam (default false)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/remove", {
+        id: input.id,
+        spam: input.spam !== undefined ? String(input.spam) : undefined,
+      });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_distinguish",
+    "Distinguish a post or comment as a moderator. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_)"),
+      how: z
+        .enum(["yes", "no", "admin", "special"])
+        .describe("'yes' = mod distinguish, 'no' = remove, 'admin' = admin, 'special' = special"),
+    },
+    async (input) => {
+      const data = await client.post("/api/distinguish", {
+        id: input.id,
+        how: input.how,
+      });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_ignore_reports",
+    "Ignore future reports on a post or comment. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/ignore_reports", { id: input.id });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_unignore_reports",
+    "Stop ignoring reports on a post or comment. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/unignore_reports", { id: input.id });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_lock",
+    "Lock a post or comment thread (prevent new comments). Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_) to lock"),
+    },
+    async (input) => {
+      const data = await client.post("/api/lock", { id: input.id });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_unlock",
+    "Unlock a previously locked post or comment thread. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post (t3_) or comment (t1_) to unlock"),
+    },
+    async (input) => {
+      const data = await client.post("/api/unlock", { id: input.id });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  // === Mod Listing Tools (Task 17) ===
+
+  server.tool(
+    "reddit_modqueue",
+    "Get items in the mod queue awaiting review. Requires 'modposts' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/modqueue`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_reports",
+    "Get reported posts and comments. Requires 'modposts' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/reports`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_spam",
+    "Get items marked as spam. Requires 'modposts' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/spam`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_edited",
+    "Get recently edited posts and comments. Requires 'modposts' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/edited`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_modlog",
+    "Get the moderation log. Requires 'modlog' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      type: z
+        .string()
+        .optional()
+        .describe("Filter by action type (e.g. banuser, removelink, approvecomment)"),
+      mod: z
+        .string()
+        .optional()
+        .describe("Filter by moderator username"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/log`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  // === Mod Management Tools (Task 18) ===
+
+  server.tool(
+    "reddit_moderators",
+    "List moderators of a subreddit. Requires 'read' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+    },
+    async (input) => {
+      const data = await client.get(
+        `/r/${input.subreddit}/about/moderators`,
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_contributors",
+    "List approved contributors of a subreddit. Requires 'modcontributors' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/contributors`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_banned",
+    "List banned users of a subreddit. Requires 'modcontributors' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/banned`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_muted",
+    "List muted users of a subreddit. Requires 'modcontributors' scope.",
+    {
+      subreddit: z.string().describe("Subreddit name (without r/ prefix)"),
+      ...paginationParams,
+    },
+    async (input) => {
+      const { subreddit, ...rest } = input;
+      const data = await client.get(
+        `/r/${subreddit}/about/muted`,
+        buildParams(rest),
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+}

package/src/tools/multireddits.ts

@@ -0,0 +1,152 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import type { RedditClient } from "../client/reddit.js";
+
+export function registerMultiredditTools(
+  server: McpServer,
+  client: RedditClient,
+): void {
+  server.tool(
+    "reddit_multi_mine",
+    "List the authenticated user's multireddits (custom feeds). Requires 'read' scope.",
+    {},
+    async () => {
+      const data = await client.get("/api/multi/mine");
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_get",
+    "Get a specific multireddit by path. Requires 'read' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+    },
+    async (input) => {
+      const data = await client.get(`/api/multi${input.multipath}`);
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_create",
+    "Create a new multireddit. Requires 'subscribe' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+      display_name: z.string().describe("Display name for the multireddit"),
+      subreddits: z
+        .array(z.string())
+        .optional()
+        .describe("Array of subreddit names to include"),
+      visibility: z
+        .enum(["private", "public", "hidden"])
+        .optional()
+        .describe("Visibility (default private)"),
+      description_md: z
+        .string()
+        .optional()
+        .describe("Description in markdown"),
+    },
+    async (input) => {
+      const { multipath, display_name, subreddits, visibility, description_md } = input;
+      const model = {
+        display_name,
+        subreddits: subreddits?.map((name) => ({ name })) ?? [],
+        visibility: visibility ?? "private",
+        description_md: description_md ?? "",
+      };
+      const data = await client.post(`/api/multi${multipath}`, {
+        model: JSON.stringify(model),
+      });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_update",
+    "Update an existing multireddit. Requires 'subscribe' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+      display_name: z.string().optional().describe("New display name"),
+      subreddits: z
+        .array(z.string())
+        .optional()
+        .describe("Updated array of subreddit names"),
+      visibility: z
+        .enum(["private", "public", "hidden"])
+        .optional()
+        .describe("Updated visibility"),
+      description_md: z
+        .string()
+        .optional()
+        .describe("Updated description in markdown"),
+    },
+    async (input) => {
+      const { multipath, display_name, subreddits, visibility, description_md } = input;
+      const model: Record<string, unknown> = {};
+      if (display_name !== undefined) model.display_name = display_name;
+      if (subreddits !== undefined) model.subreddits = subreddits.map((name) => ({ name }));
+      if (visibility !== undefined) model.visibility = visibility;
+      if (description_md !== undefined) model.description_md = description_md;
+      const data = await client.put(`/api/multi${multipath}`, { model });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_delete",
+    "Delete a multireddit. Requires 'subscribe' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+    },
+    async (input) => {
+      const data = await client.delete(`/api/multi${input.multipath}`);
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_add_sub",
+    "Add a subreddit to a multireddit. Requires 'subscribe' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+      srname: z.string().describe("Subreddit name to add (without r/ prefix)"),
+    },
+    async (input) => {
+      const data = await client.put(
+        `/api/multi${input.multipath}/r/${input.srname}`,
+        { model: { name: input.srname } },
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_multi_remove_sub",
+    "Remove a subreddit from a multireddit. Requires 'subscribe' scope.",
+    {
+      multipath: z
+        .string()
+        .describe("Multireddit path (e.g. /user/username/m/multiname)"),
+      srname: z
+        .string()
+        .describe("Subreddit name to remove (without r/ prefix)"),
+    },
+    async (input) => {
+      const data = await client.delete(
+        `/api/multi${input.multipath}/r/${input.srname}`,
+      );
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+}

package/src/tools/posts.ts

@@ -0,0 +1,177 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import type { RedditClient } from "../client/reddit.js";
+
+function buildParams(
+  input: Record<string, unknown>,
+): Record<string, string | undefined> {
+  const params: Record<string, string | undefined> = {};
+  for (const [key, value] of Object.entries(input)) {
+    if (value !== undefined && value !== null) {
+      params[key] = String(value);
+    }
+  }
+  return params;
+}
+
+export function registerPostTools(
+  server: McpServer,
+  client: RedditClient,
+): void {
+  server.tool(
+    "reddit_submit",
+    "Create a new post (self-post or link). Requires 'submit' scope.",
+    {
+      sr: z.string().describe("Subreddit name to post in (without r/ prefix)"),
+      title: z.string().describe("Post title"),
+      kind: z
+        .enum(["self", "link"])
+        .describe("Post type: 'self' for text post, 'link' for URL post"),
+      text: z
+        .string()
+        .optional()
+        .describe("Post body text (markdown). Required for self posts."),
+      url: z
+        .string()
+        .optional()
+        .describe("URL to submit. Required for link posts."),
+      nsfw: z
+        .boolean()
+        .optional()
+        .describe("Mark as NSFW"),
+      spoiler: z
+        .boolean()
+        .optional()
+        .describe("Mark as spoiler"),
+      flair_id: z
+        .string()
+        .optional()
+        .describe("Flair template ID"),
+      flair_text: z
+        .string()
+        .optional()
+        .describe("Flair text (if flair allows custom text)"),
+      resubmit: z
+        .boolean()
+        .optional()
+        .describe("Allow resubmitting a previously submitted link"),
+      sendreplies: z
+        .boolean()
+        .optional()
+        .describe("Send replies to inbox (default true)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/submit", {
+        ...buildParams(input),
+        api_type: "json",
+      });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_edit",
+    "Edit the body text of a self-post or comment. Requires 'edit' scope.",
+    {
+      thing_id: z
+        .string()
+        .describe("Fullname of the post (t3_) or comment (t1_) to edit"),
+      text: z.string().describe("New body text (markdown)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/editusertext", {
+        ...buildParams(input),
+        api_type: "json",
+      });
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_delete",
+    "Delete a post or comment. Requires 'edit' scope.",
+    {
+      id: z
+        .string()
+        .describe("Fullname of the post (t3_) or comment (t1_) to delete"),
+    },
+    async (input) => {
+      const data = await client.post("/api/del", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_hide",
+    "Hide a post from your listings. Requires 'report' scope.",
+    {
+      id: z.string().describe("Fullname of the post to hide (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/hide", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_unhide",
+    "Unhide a previously hidden post. Requires 'report' scope.",
+    {
+      id: z.string().describe("Fullname of the post to unhide (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/unhide", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_mark_nsfw",
+    "Mark a post as NSFW. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post to mark NSFW (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/marknsfw", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_unmark_nsfw",
+    "Remove NSFW mark from a post. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post to unmark NSFW (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/unmarknsfw", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_spoiler",
+    "Mark a post as a spoiler. Requires 'modposts' scope.",
+    {
+      id: z.string().describe("Fullname of the post to mark as spoiler (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/spoiler", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+
+  server.tool(
+    "reddit_unspoiler",
+    "Remove spoiler mark from a post. Requires 'modposts' scope.",
+    {
+      id: z
+        .string()
+        .describe("Fullname of the post to remove spoiler mark (t3_)"),
+    },
+    async (input) => {
+      const data = await client.post("/api/unspoiler", buildParams(input));
+      return { content: [{ type: "text", text: JSON.stringify(data) }] };
+    },
+  );
+}