MCP (Model Context Protocol) server for reading and analyzing various file formats including PDF, Excel, Word, and PowerPoint
Project description
MCP File Contents Reader
A Model Context Protocol (MCP) server for reading and analyzing various file formats including PDF, Excel, Word, and PowerPoint documents.
Features
- Multi-format Support: Read PDF, Excel (.xlsx, .xls), Word (.docx, .doc), and PowerPoint (.pptx, .ppt) files
- Content Analysis: Extract and analyze file contents with structured information extraction
- Document Search: Search for specific content across multiple documents
- File Upload: Support for temporary file upload and processing
- MCP Integration: Full Model Context Protocol compliance
Installation
Using uvx (Recommended)
uvx mcp-file-contents-reader
Using pip
pip install mcp-file-contents-reader
From Source
git clone https://github.com/yourusername/mcp-file-contents-reader.git
cd mcp-file-contents-reader
pip install -e .
Usage
MCP Configuration
Add the following to your mcp.json configuration file:
{
"mcpServers": {
"file-reader": {
"command": "uvx",
"args": ["mcp-file-contents-reader"]
}
}
}
Or if installed via pip:
{
"mcpServers": {
"file-reader": {
"command": "mcp-file-contents-reader"
}
}
}
Available Tools
1. read_file
Read Excel, PDF, PPT, Word files and return content as text.
Parameters:
file_path(required): Path to the file to readsheet_name(optional): Sheet name for Excel filespage_range(optional): Page range for PDF files (e.g., '1-5' or '1,3,5')
2. search_documents
Search for specific content in Documents directory and analyze files.
Parameters:
keywords(required): Keywords to search for in file contentsearch_path(optional): Directory path to search (default: ~/Documents)file_types(optional): File types to search (default: ["pdf", "docx", "xlsx", "pptx", "doc", "xls", "ppt"])
3. analyze_file_content
Analyze specific file content in detail and extract structured information.
Parameters:
file_path(required): Path to the file to analyzeextract_patterns(optional): Specific patterns or information types to extract
4. upload_file
Upload and temporarily store Base64 encoded file data.
Parameters:
file_data(required): Base64 encoded file datafilename(required): Filename with extension
5. read_uploaded_file
Read uploaded file and return content.
Parameters:
file_id(required): ID of the uploaded file
6. list_uploaded_files
Return list of uploaded files.
7. delete_uploaded_file
Delete uploaded file.
Parameters:
file_id(required): ID of the file to delete
8. get_file_info
Return basic information about a file.
Parameters:
file_path(required): Path to the file to get information about
9. list_supported_formats
Return list of supported file formats.
Supported File Formats
- Excel: .xlsx, .xls
- PDF: .pdf
- PowerPoint: .pptx, .ppt
- Word: .docx, .doc
Example Usage
Search for donation receipts
{
"tool": "search_documents",
"arguments": {
"keywords": ["donation", "receipt", "charity", "fund"],
"search_path": "/Users/username/Documents",
"file_types": ["pdf", "docx", "xlsx"]
}
}
Analyze a specific file
{
"tool": "analyze_file_content",
"arguments": {
"file_path": "/Users/username/Documents/receipt.pdf",
"extract_patterns": ["donor", "amount", "organization", "date"]
}
}
Development
Setup Development Environment
git clone https://github.com/yourusername/mcp-file-contents-reader.git
cd mcp-file-contents-reader
pip install -e ".[dev]"
Running Tests
pytest
Code Formatting
black mcp_file_reader/
Type Checking
mypy mcp_file_reader/
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests for your changes
- Run the test suite
- Submit a pull request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Changelog
1.0.0
- Initial release
- Support for PDF, Excel, Word, and PowerPoint files
- MCP server implementation
- Document search and analysis capabilities
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcp_file_contents_reader-1.0.9.tar.gz.
File metadata
- Download URL: mcp_file_contents_reader-1.0.9.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
27ab6c7b1d723519cdcd1738cf28142fc225ae233a701c5a35ec02320aa65e90
|
|
| MD5 |
de3d5e78470f8ade2550a4223a469b12
|
|
| BLAKE2b-256 |
772721007676d32901c10c2309c01ae8ddcb461b9296c9b4562de934b4b89457
|
File details
Details for the file mcp_file_contents_reader-1.0.9-py3-none-any.whl.
File metadata
- Download URL: mcp_file_contents_reader-1.0.9-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
816dc54494f92eedae255d7593178c20c1e88da27a5e5008df8ad46dcc04166a
|
|
| MD5 |
bcd7f28ed3ad5408b6bfe9ce1e138a51
|
|
| BLAKE2b-256 |
742d3e19178a41ee9c26881ec1aa4bb7cede6ca921124f2cf5d7369345887449
|