Skip to main content
Glama
mcp-documents-reader

mcp-documents-reader

by xt765

Features

  • Multi-format Support: Supports 4 mainstream document formats: Excel (XLSX/XLS), DOCX, PDF, and TXT

  • MCP Protocol: Compliant with MCP standards, can be used as a tool for AI assistants like Trae IDE

  • Easy Integration: Simple configuration for immediate use

  • Reliable Performance: Successfully tested and running in Trae IDE

  • File System Support: Reads documents directly from the file system


Related MCP server: MinerU Document Explorer

📚 Documentation

User Guide · API Reference · Contributing · Changelog · License


Architecture

graph TB
    A[AI Assistant / User] -->|Call read_document| B[MCP Document Reader]
    B -->|Detect file type| C{File Type?}
    C -->|.docx| D[DOCX Reader]
    C -->|.pdf| E[PDF Reader]
    C -->|.xlsx/.xls| F[Excel Reader]
    C -->|.txt| G[Text Reader]
    D -->|Extract text| H[Return Content]
    E -->|Extract text| H
    F -->|Extract text| H
    G -->|Extract text| H
    H -->|Text content| A
    
    style A fill:#e1f5ff
    style B fill:#fff4e1
    style C fill:#f0f0f0
    style D fill:#e8f5e9
    style E fill:#e8f5e9
    style F fill:#e8f5e9
    style G fill:#e8f5e9
    style H fill:#fff9c4

Supported Formats

Format

Extensions

MIME Type

Features

Excel

.xlsx, .xls

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sheet and cell data extraction

DOCX

.docx

application/vnd.openxmlformats-officedocument.wordprocessingml.document

Text and structure extraction

PDF

.pdf

application/pdf

Text extraction

Text

.txt

text/plain

Plain text reading

Installation

pip install mcp-documents-reader

From Source

git clone https://github.com/xt765/mcp_documents_reader.git
cd mcp_documents_reader
pip install -e .

MCP Tools

This server provides the following tool:

read_document

Read any supported document type with a unified interface.

Arguments:

  • filename (string, required): Document file path, supports absolute or relative paths.

Configuration

Using in Trae IDE / Claude Desktop

Add the following to your MCP configuration file:

Option 1: Using PyPI (Recommended)

{
  "mcpServers": {
    "mcp-document-reader": {
      "command": "uvx",
      "args": [
        "mcp-documents-reader"
      ]
    }
  }
}

Option 2: Using GitHub repository

{
  "mcpServers": {
    "mcp-document-reader": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/xt765/mcp_documents_reader",
        "mcp_documents_reader"
      ]
    }
  }
}

Option 3: Using Gitee repository (Faster access in China)

{
  "mcpServers": {
    "mcp-document-reader": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://gitee.com/xt765/mcp_documents_reader",
        "mcp_documents_reader"
      ]
    }
  }
}

Usage

As an MCP Tool

After configuration, AI assistants can directly call the following tool:

# Read a DOCX file
read_document(filename="example.docx")

# Read a PDF file
read_document(filename="example.pdf")

# Read an Excel file
read_document(filename="example.xlsx")

# Read a text file
read_document(filename="example.txt")

As a Python Library

from mcp_documents_reader import DocumentReaderFactory

# Using factory (recommended)
reader = DocumentReaderFactory.get_reader("document.pdf")
content = reader.read("/path/to/document.pdf")

# Check if format is supported
if DocumentReaderFactory.is_supported("file.xlsx"):
    reader = DocumentReaderFactory.get_reader("file.xlsx")
    content = reader.read("/path/to/file.xlsx")

Tool Interface Details

read_document

Read any supported document type.

Parameters:

Parameter

Type

Required

Description

filename

string

✅

Document file path, supports absolute or relative paths

Dependencies

Core Dependencies

  • mcp >= 1.26.0 - MCP protocol implementation

  • python-docx >= 1.2.0 - DOCX file reading

  • pypdf >= 6.8.0 - PDF file reading (replaces PyPDF2)

  • openpyxl >= 3.1.5 - Excel file reading

Development Dependencies

  • pytest >= 8.0.0 - Testing framework

  • pytest-asyncio >= 0.24.0 - Async testing support

  • pytest-cov >= 6.0.0 - Coverage reporting

  • basedpyright >= 0.28.0 - Type checking

  • ruff >= 0.8.0 - Linting and formatting

License

MIT License

Contributing

Issues and Pull Requests are welcome!

Available Tools

1 tool
read_documentA

Reads and extracts text from a specified document file. Supports multiple document types: TXT, DOCX, PDF, Excel (XLSX, XLS).

:param filename: Path to the document file to read (supports absolute or relative paths) :return: Extracted text from the document

Inputs: filename (required). Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.9/5.0

    Scored across 1 tool

    Disambiguation5/5

    Only one tool exists, so there is no possibility of confusion or overlap between tools. The sole tool's purpose is clear and unambiguous.

    Naming Consistency5/5

    The single tool follows a clean verb_noun naming convention (read + document), which is consistent and predictable. With only one tool, there are no style inconsistencies.

    Tool Count2/5

    A single tool is too few for a document reader server. Even though the tool handles multiple formats, the surface is extremely minimal, and agents may need additional operations such as listing files or retrieving metadata.

    Completeness4/5

    The tool fully covers the core purpose of extracting text from various document types. However, it lacks auxiliary functions like listing available documents or fetching metadata, which are common in document management workflows.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      D
      maintenance
      Provides AI assistants with unified file operations via MCP, supporting Excel, PDF, Word, and SQLite file reading, writing, and querying.
      12
      MIT
    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables AI agents to search, deep-read, and build knowledge bases from Markdown, PDF, DOCX, and PPTX documents via MCP tools for retrieval, document navigation, and ingestion.
      15 npm
      653
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Enables reading and analysis of PDF, Excel, Word, and PowerPoint files through the Model Context Protocol, supporting content extraction, document search, and file upload.
      30 PyPI
      5
      MIT