Skip to main content
Glama

xlsx-to-markdown

Convert XLSX spreadsheets to Markdown format for easier readability and sharing within documentation or notes.

Instructions

Convert an XLSX file to markdown

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filepathYesAbsolute path of the XLSX file to convert

Implementation Reference

  • Handler logic within the CallToolRequest handler that matches the xlsx-to-markdown tool name and invokes Markdownify.toMarkdown to perform the conversion.
    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;
  • Input schema definition for the xlsx-to-markdown tool using ToolSchema.parse.
    export const XlsxToMarkdownTool = ToolSchema.parse({
      name: "xlsx-to-markdown",
      description: "Convert an XLSX file to markdown",
      inputSchema: {
        type: "object",
        properties: {
          filepath: {
            type: "string",
            description: "Absolute path of the XLSX file to convert",
          },
        },
        required: ["filepath"],
      },
    });
  • src/server.ts:33-37 (registration)
    Registers the xlsx-to-markdown tool (included in tools export) by listing all tool schemas in response to ListToolsRequest.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: Object.values(tools),
      };
    });
  • Helper function Markdownify.toMarkdown that performs the file-to-markdown conversion by running the markitdown executable via uv for XLSX files.
    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");
        }
      }
    }
  • Private helper that executes the markitdown tool via uv run to convert XLSX files to markdown.
    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 of behavioral disclosure. It states the conversion action but lacks critical details: it doesn't mention whether the tool modifies the original file, where the output is saved, what markdown format is used (e.g., for tables), or error handling for invalid files. This leaves significant gaps in understanding the tool's behavior.

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 extremely concise—a single sentence with zero wasted words—and front-loaded with the core action. It efficiently communicates the tool's purpose without unnecessary elaboration, making it easy to parse quickly.

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 lack of annotations and output schema, the description is incomplete for a file conversion tool. It doesn't explain the output (e.g., markdown content or file location), error conditions, or limitations (e.g., file size constraints). While the schema covers the input, the overall context for safe and effective use is insufficient.

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?

The description adds no parameter-specific information beyond what the input schema provides. With 100% schema description coverage, the schema fully documents the single parameter ('filepath'), so the baseline score of 3 is appropriate. The description doesn't compensate with additional context like file format requirements or examples.

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 tool's purpose with a specific verb ('Convert') and resource ('XLSX file to markdown'), making it immediately understandable. However, it doesn't differentiate from sibling tools like 'docx-to-markdown' or 'pdf-to-markdown' beyond the file format, missing an opportunity to specify what makes XLSX conversion unique (e.g., handling spreadsheets vs. documents).

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 file types to markdown, it fails to indicate scenarios where XLSX conversion is appropriate (e.g., for tabular data) or when other tools might be better suited, leaving usage context entirely implicit.

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