Skip to content

πŸ” Access local document collections with Fathom MCP, a Model Context Protocol server that enhances AI assistants through powerful file-first search capabilities.

License

Notifications You must be signed in to change notification settings

getwaroo/fathom-mcp

Repository files navigation

πŸ—οΈ fathom-mcp - Simplifying File Search with Ease

🏁 Introduction

fathom-mcp is an MCP server designed for local file knowledge. It bridges file systems and large language models (LLMs) using powerful tools like ugrep and poppler-utils. With fathom-mcp, you can easily search through PDFs and codebases, all in a secure, read-only environment. This application provides full-text search, fuzzy matching, and hierarchical context access, making your document searches straightforward and efficient.

πŸ“₯ Download & Install

Download fathom-mcp

To get started, visit the Releases page to download the latest version of fathom-mcp. Follow these steps to install it on your device:

  1. Click the link above to go to the Releases page.
  2. Look for the latest version.
  3. Download the installation file for your operating system.
  4. Open the downloaded file and follow the on-screen instructions to install.

πŸš€ Getting Started

After installation, you can start using fathom-mcp to enhance your file searching experience. Here’s how:

  1. Launch the Application: Find the fathom-mcp icon on your computer and double-click it to open.
  2. Select Your Files: Use the options within the application to choose the files or folders you want to search through.
  3. Search for Content: Type keywords or phrases into the search bar and hit enter. The application will display results that match your query.

πŸ“‚ Features

  • Full-Text Search: Quickly find specific text within your documents.
  • Fuzzy Matching: Get results even if your search terms are not exact.
  • Hierarchical Context Access: Easily navigate through complex file structures.
  • PDF and Codebase Support: Search across multiple file types seamlessly.
  • Secure Environment: Use the application without risking your file security.

πŸ“‹ System Requirements

To run fathom-mcp effectively, ensure your system meets the following requirements:

  • Operating System: Windows 10 or later, macOS 10.15 or later, or a Linux distribution (Ubuntu 20.04 or later recommended).
  • Processor: Intel or AMD processor with 4 cores or more.
  • RAM: Minimum 4 GB, 8 GB recommended for optimal performance.
  • Disk Space: At least 500 MB of free space for installation and additional space for your files.

πŸ› οΈ Troubleshooting

If you encounter issues while using fathom-mcp, here are some common solutions:

  1. Application Doesn’t Launch: Check if your system meets the requirements. Restart your computer and try launching it again.
  2. Slow Searches: Ensure that your files are not too large. Consider splitting large files into smaller sections.
  3. No Results Found: Double-check your search terms for spelling errors. Try using different keywords.

πŸ“– Help and Support

For additional help, consider these resources:

  • Documentation: Access our official documentation for detailed instructions and FAQs.
  • Community Forum: Join our discussion forum to connect with other users. Share tips and ask questions.

πŸ“Œ Contribute

If you want to contribute to the project, your input is welcome. Follow these simple steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or fix.
  3. Make changes and commit them.
  4. Open a pull request for review.

🐞 Reporting Issues

If you find bugs or have suggestions for improvements, please report them. Open an issue on the GitHub Issues page. Include as much detail as possible to help us resolve it quickly.

πŸ“ˆ Updates and Versions

We regularly update fathom-mcp to improve performance and add features. Check the Releases page frequently to stay informed about the latest changes.

⚑ Final Note

We appreciate your interest in fathom-mcp. Enjoy seamless file searching that saves you time and effort. For any questions, don’t hesitate to reach out through our community or issues page. Happy searching!

About

πŸ” Access local document collections with Fathom MCP, a Model Context Protocol server that enhances AI assistants through powerful file-first search capabilities.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages