create_text_qr

Instructions

Implementation Reference

• packages/mcp/src/tools.ts:503-527 (handler)

  Full tool definition for 'create_text_qr' including the handler function. It extracts 'content' from input, then calls apiRequest to POST /api/qr with type 'text' and text_data containing the content.

  create_text_qr: {
    description:
      "Create a QR code that contains plain text. When scanned, the text is displayed directly. Useful for messages, notes, or any freeform content.",
    inputSchema: z.object({
      content: z.string().describe("Plain text content to encode."),
      label: z.string().optional().describe("Label for this QR code."),
      format: z.enum(["svg", "png"]).default("svg").describe("Image format."),
      foreground_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Hex color for dots."),
      background_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Hex color for background."),
      dot_style: z.enum(["square", "rounded", "dots", "classy-rounded"]).optional().describe("Dot shape."),
      corner_style: z.enum(["square", "extra-rounded", "dot"]).optional().describe("Corner shape."),
      logo_url: z.string().optional().describe("Logo URL or data URI."),
      frame_style: z.enum(["none", "banner_bottom", "banner_top", "rounded"]).optional().describe("Frame style around QR."),
      frame_text: z.string().max(30).optional().describe("CTA text on frame (max 30 chars)."),
      frame_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Frame background color."),
      frame_text_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Frame text color."),
    }),
    handler: async (input: Record<string, unknown>) => {
      const { content, ...rest } = input;
      return apiRequest("/api/qr", {
        method: "POST",
        body: { type: "text", text_data: { content }, ...rest },
      });
    },
  },

• packages/mcp/src/tools.ts:506-519 (schema)

  Input schema (Zod) for create_text_qr defining content, label, format, foreground_color, background_color, dot_style, corner_style, logo_url, frame_style, frame_text, frame_color, frame_text_color.

  inputSchema: z.object({
    content: z.string().describe("Plain text content to encode."),
    label: z.string().optional().describe("Label for this QR code."),
    format: z.enum(["svg", "png"]).default("svg").describe("Image format."),
    foreground_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Hex color for dots."),
    background_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Hex color for background."),
    dot_style: z.enum(["square", "rounded", "dots", "classy-rounded"]).optional().describe("Dot shape."),
    corner_style: z.enum(["square", "extra-rounded", "dot"]).optional().describe("Corner shape."),
    logo_url: z.string().optional().describe("Logo URL or data URI."),
    frame_style: z.enum(["none", "banner_bottom", "banner_top", "rounded"]).optional().describe("Frame style around QR."),
    frame_text: z.string().max(30).optional().describe("CTA text on frame (max 30 chars)."),
    frame_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Frame background color."),
    frame_text_color: z.string().regex(/^#[0-9A-Fa-f]{6}$/).optional().describe("Frame text color."),
  }),

• packages/mcp/src/tools.ts:8-8 (registration)

  The 'tools' object exported from this file is registered in server.ts via the McpServer.tool() call in a loop.

  export const tools = {

• packages/mcp/src/server.ts:20-54 (registration)

  Registration loop: each tool in the exported 'tools' object is registered with the MCP server using server.tool(name, description, inputSchema.shape, handler).

  // Register each tool from our definitions
  for (const [name, tool] of Object.entries(tools)) {
    server.tool(
      name,
      tool.description,
      tool.inputSchema.shape,
      async (input: Record<string, unknown>) => {
        try {
          const result = await tool.handler(input as any);
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify(result, null, 2),
              },
            ],
          };
        } catch (error) {
          const message = error instanceof Error ? error.message : String(error);
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify({
                  error: message,
                  hint: "Check the input parameters and try again. Use list_qr_codes to verify available QR codes.",
                }),
              },
            ],
            isError: true,
          };
        }
      }
    );
  }

• packages/mcp/src/api-client.ts:13-40 (helper)

  The apiRequest helper function that makes HTTP requests to the backend API with X-API-Key authentication.

  export async function apiRequest(path: string, options: RequestOptions = {}) {
    const { method = "GET", body, query } = options;
  
    let url = `${BASE_URL}${path}`;
    if (query) {
      const params = new URLSearchParams();
      for (const [key, value] of Object.entries(query)) {
        params.set(key, String(value));
      }
      url += `?${params.toString()}`;
    }
  
    const headers: Record<string, string> = {
      "X-API-Key": API_KEY,
    };
  
    if (body) {
      headers["Content-Type"] = "application/json";
    }
  
    const res = await fetch(url, {
      method,
      headers,
      body: body ? JSON.stringify(body) : undefined,
    });
  
    return res.json();
  }