Skip to main content
Glama
discourse

Discourse MCP

Official
by discourse

List Drafts

discourse_list_drafts

Retrieve and view all saved drafts for the current user, including keys, sequences, and preview content, to identify existing drafts before making updates.

Instructions

List all drafts for the current user. Returns draft keys, sequences, and preview content. Use this to find existing drafts before updating them.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNoPagination offset (default: 0)

Implementation Reference

  • Full registration function for the discourse_list_drafts tool, including schema definition, tool metadata, and inline handler implementation.
    export const registerListDrafts: RegisterFn = (server, ctx, _opts) => {
      const schema = z.object({
        offset: z.number().int().min(0).optional().describe("Pagination offset (default: 0)"),
      });
    
      server.registerTool(
        "discourse_list_drafts",
        {
          title: "List Drafts",
          description:
            "List all drafts for the current user. Returns draft keys, sequences, and preview content. Use this to find existing drafts before updating them.",
          inputSchema: schema.shape,
        },
        async (input: unknown, _extra: unknown) => {
          const { offset } = schema.parse(input);
    
          try {
            const { base, client } = ctx.siteState.ensureSelectedSite();
            const params = new URLSearchParams();
            if (typeof offset === "number") params.set("offset", String(offset));
    
            const url = `/drafts.json${params.toString() ? `?${params}` : ""}`;
            const data = (await client.get(url)) as {
              drafts?: Array<{
                draft_key: string;
                sequence: number;
                data?: string;
                title?: string;
                category_id?: number;
                created_at?: string;
              }>;
            };
    
            const drafts = data?.drafts || [];
    
            if (drafts.length === 0) {
              return { content: [{ type: "text", text: "No drafts found." }] };
            }
    
            const lines = ["# Drafts\n"];
            for (const draft of drafts) {
              lines.push(`## Draft: \`${draft.draft_key}\` (sequence: ${draft.sequence})`);
              if (draft.title) lines.push(`**Title:** ${draft.title}`);
              if (draft.category_id) lines.push(`**Category ID:** ${draft.category_id}`);
              if (draft.created_at) lines.push(`**Created:** ${draft.created_at}`);
    
              // Parse and show preview of reply content
              if (draft.data) {
                try {
                  const parsed = JSON.parse(draft.data);
                  if (parsed.reply) {
                    const preview = parsed.reply.length > 200 ? parsed.reply.slice(0, 200) + "..." : parsed.reply;
                    lines.push(`**Preview:**\n> ${preview.replace(/\n/g, "\n> ")}`);
                  }
                } catch {
                  // Ignore parse errors
                }
              }
              lines.push("");
            }
    
            lines.push("\n```json");
            lines.push(JSON.stringify(drafts, null, 2));
            lines.push("```");
    
            return { content: [{ type: "text", text: lines.join("\n") }] };
          } catch (e: unknown) {
            const msg = e instanceof Error ? e.message : String(e);
            return { content: [{ type: "text", text: `Failed to list drafts: ${msg}` }], isError: true };
          }
        }
      );
    };
  • Handler function that fetches drafts from /drafts.json API endpoint, processes the response to preview content, formats as Markdown with JSON dump, handles errors.
    async (input: unknown, _extra: unknown) => {
      const { offset } = schema.parse(input);
    
      try {
        const { base, client } = ctx.siteState.ensureSelectedSite();
        const params = new URLSearchParams();
        if (typeof offset === "number") params.set("offset", String(offset));
    
        const url = `/drafts.json${params.toString() ? `?${params}` : ""}`;
        const data = (await client.get(url)) as {
          drafts?: Array<{
            draft_key: string;
            sequence: number;
            data?: string;
            title?: string;
            category_id?: number;
            created_at?: string;
          }>;
        };
    
        const drafts = data?.drafts || [];
    
        if (drafts.length === 0) {
          return { content: [{ type: "text", text: "No drafts found." }] };
        }
    
        const lines = ["# Drafts\n"];
        for (const draft of drafts) {
          lines.push(`## Draft: \`${draft.draft_key}\` (sequence: ${draft.sequence})`);
          if (draft.title) lines.push(`**Title:** ${draft.title}`);
          if (draft.category_id) lines.push(`**Category ID:** ${draft.category_id}`);
          if (draft.created_at) lines.push(`**Created:** ${draft.created_at}`);
    
          // Parse and show preview of reply content
          if (draft.data) {
            try {
              const parsed = JSON.parse(draft.data);
              if (parsed.reply) {
                const preview = parsed.reply.length > 200 ? parsed.reply.slice(0, 200) + "..." : parsed.reply;
                lines.push(`**Preview:**\n> ${preview.replace(/\n/g, "\n> ")}`);
              }
            } catch {
              // Ignore parse errors
            }
          }
          lines.push("");
        }
    
        lines.push("\n```json");
        lines.push(JSON.stringify(drafts, null, 2));
        lines.push("```");
    
        return { content: [{ type: "text", text: lines.join("\n") }] };
      } catch (e: unknown) {
        const msg = e instanceof Error ? e.message : String(e);
        return { content: [{ type: "text", text: `Failed to list drafts: ${msg}` }], isError: true };
      }
    }
  • Zod input schema for the tool, defining optional offset parameter for pagination.
    const schema = z.object({
      offset: z.number().int().min(0).optional().describe("Pagination offset (default: 0)"),
    });
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the return content ('draft keys, sequences, and preview content') and implies read-only behavior through 'List', but lacks details on permissions, rate limits, or pagination beyond the schema's offset parameter. This is adequate but has gaps for a tool with no annotations.

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

Conciseness5/5

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

The description is two concise sentences that are front-loaded with the core purpose and efficiently add usage guidance. Every word contributes value, with no wasted text or redundancy.

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

Completeness3/5

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

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description covers the purpose and usage well. However, it lacks details on behavioral aspects like authentication needs or error handling, which would be beneficial for a tool with no annotations, making it minimally complete but not thorough.

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%, so the schema fully documents the single parameter (offset). The description adds no parameter-specific information beyond what's in the schema, resulting in the baseline score of 3 for adequate coverage without extra value.

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

Purpose4/5

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

The description clearly states the action ('List all drafts') and resource ('for the current user'), distinguishing it from siblings like discourse_get_draft (singular) or discourse_list_user_posts (different resource). However, it doesn't explicitly differentiate from all list-type siblings (e.g., discourse_list_categories), making it a 4 rather than a 5.

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

Usage Guidelines4/5

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

The description provides clear context for usage ('Use this to find existing drafts before updating them'), which implicitly suggests when to use it. However, it doesn't explicitly state when NOT to use it or name specific alternatives among siblings, so it falls short of a perfect 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/discourse/discourse-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server