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;
    }
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. It states the conversion action but lacks behavioral details such as whether it overwrites files, requires specific permissions, handles errors, or produces output location/format. For a file conversion tool with zero annotation coverage, this is a significant gap in transparency.

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 a single, efficient sentence with zero waste. It is front-loaded with the core action and resource, making it highly concise and well-structured for quick understanding.

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 complexity of file conversion, lack of annotations, and no output schema, the description is incomplete. It does not address behavioral aspects like output handling, error conditions, or dependencies, leaving gaps for an AI agent to correctly invoke the tool in context with siblings.

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 the single parameter 'filepath' fully documented in the schema as 'Absolute path of the DOCX file to convert'. The description does not add any meaning beyond this, as it only implies the parameter indirectly. Baseline 3 is appropriate when the schema does the heavy lifting.

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 'Convert a DOCX file to markdown' clearly states the action (convert) and resource (DOCX file) with the target format (markdown). It distinguishes from most siblings by specifying DOCX format, though it doesn't explicitly differentiate from other document converters like pptx-to-markdown or pdf-to-markdown beyond the file type mention.

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. With multiple sibling tools for converting different formats to markdown (e.g., pdf-to-markdown, pptx-to-markdown), there is no indication that this is specifically for DOCX files or any prerequisites like file accessibility or format compatibility.

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

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