Skip to main content
Glama

docx-to-markdown

Convert DOCX files to Markdown format for easier editing and sharing. This tool transforms Word documents into readable Markdown text.

Instructions

Convert a DOCX file to markdown

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filepathYesAbsolute path of the DOCX file to convert

Implementation Reference

  • Tool handler dispatch case for 'docx-to-markdown' (and similar file-based converters): validates 'filepath' argument and calls the core Markdownify.toMarkdown function.
    case tools.PDFToMarkdownTool.name:
    case tools.ImageToMarkdownTool.name:
    case tools.AudioToMarkdownTool.name:
    case tools.DocxToMarkdownTool.name:
    case tools.XlsxToMarkdownTool.name:
    case tools.PptxToMarkdownTool.name:
      if (!validatedArgs.filepath) {
        throw new Error("File path is required for this tool");
      }
      result = await Markdownify.toMarkdown({
        filePath: validatedArgs.filepath,
        projectRoot: validatedArgs.projectRoot,
        uvPath: validatedArgs.uvPath || process.env.UV_PATH,
      });
      break;
  • Core handler function `toMarkdown` that executes the DOCX-to-markdown conversion logic: handles filePath input, runs markitdown executable via 'uv run', saves output markdown to temp file, and returns path and text.
    static async toMarkdown({
      filePath,
      url,
      projectRoot = path.resolve(__dirname, ".."),
      uvPath = "~/.local/bin/uv",
    }: {
      filePath?: string;
      url?: string;
      projectRoot?: string;
      uvPath?: string;
    }): Promise<MarkdownResult> {
      try {
        let inputPath: string;
        let isTemporary = false;
    
        if (url) {
          const response = await fetch(url);
    
          let extension = null;
    
          if (url.endsWith(".pdf")) {
            extension = "pdf";
          }
    
          const arrayBuffer = await response.arrayBuffer();
          const content = Buffer.from(arrayBuffer);
    
          inputPath = await this.saveToTempFile(content, extension);
          isTemporary = true;
        } else if (filePath) {
          inputPath = filePath;
        } else {
          throw new Error("Either filePath or url must be provided");
        }
    
        const text = await this._markitdown(inputPath, projectRoot, uvPath);
        const outputPath = await this.saveToTempFile(text);
    
        if (isTemporary) {
          fs.unlinkSync(inputPath);
        }
    
        return { path: outputPath, text };
      } catch (e: unknown) {
        if (e instanceof Error) {
          throw new Error(`Error processing to Markdown: ${e.message}`);
        } else {
          throw new Error("Error processing to Markdown: Unknown error occurred");
        }
      }
    }
  • Schema definition for the 'docx-to-markdown' tool, specifying name, description, and input schema requiring 'filepath'.
    export const DocxToMarkdownTool = ToolSchema.parse({
      name: "docx-to-markdown",
      description: "Convert a DOCX file to markdown",
      inputSchema: {
        type: "object",
        properties: {
          filepath: {
            type: "string",
            description: "Absolute path of the DOCX file to convert",
          },
        },
        required: ["filepath"],
      },
    });
  • src/server.ts:33-37 (registration)
    Registration of all tools (including 'docx-to-markdown') for the ListTools MCP request by returning Object.values(tools).
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: Object.values(tools),
      };
    });
  • Helper function that executes the 'markitdown' CLI tool via 'uv run' on the DOCX file to produce markdown output.
    private static async _markitdown(
      filePath: string,
      projectRoot: string,
      uvPath: string,
    ): Promise<string> {
      const venvPath = path.join(projectRoot, ".venv");
      const markitdownPath = path.join(
        venvPath,
        process.platform === "win32" ? "Scripts" : "bin",
        `markitdown${process.platform === "win32" ? ".exe" : ""}`,
      );
    
      if (!fs.existsSync(markitdownPath)) {
        throw new Error("markitdown executable not found");
      }
    
      // Expand tilde in uvPath if present
      const expandedUvPath = expandHome(uvPath);
    
      // Use execFile to prevent command injection
      const { stdout, stderr } = await execFileAsync(expandedUvPath, [
        "run",
        markitdownPath,
        filePath,
      ]);
    
      if (stderr) {
        throw new Error(`Error executing command: ${stderr}`);
      }
    
      return stdout;
    }

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/zcaceres/markdownify-mcp'

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