Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md - Add Everything Search to community highlights #371

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mamertofabian
Copy link

@mamertofabian mamertofabian commented Dec 18, 2024

Description

Adding a cross-platform file search MCP server that leverages native search capabilities on each supported OS: Everything SDK (Windows), Spotlight (macOS), and locate/plocate (Linux). On Windows, it integrates with voidtools Everything for fast file indexing and search. Available in PyPi.

Server Details

  • Server: everything-search (new community server)

Motivation and Context

This server provides fast file search capabilities across multiple operating systems, utilizing the best native search tools for each platform. Enabling LLMs to interact with local file search functions directly empowers users to better organize and manage their file systems through natural language interactions.

This integration allows LLMs to assist users with tasks like file organization, duplicate detection, and content discovery through natural conversation, making file system management more intuitive and efficient.

How Has This Been Tested?

Tested with Claude Desktop and Cline clients across different platforms:

  • Windows:
    • Everything SDK features including path and file type filtering
    • Complex search patterns
  • macOS:
    • Filename and content search via Spotlight
    • Basic pattern matching
  • Linux:
    • Basic filename search using locate database
    • Pattern matching with plocate

Tested locally, TestPyPi, and PyPi releases via npx.

Breaking Changes

No breaking changes. This is an additive change to documentation only.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Protocol Documentation
  • My changes follows MCP security best practices
  • I have updated the server's README accordingly
  • I have tested this with an LLM client
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have documented all environment variables and configuration options

Additional context

Platform-specific requirements:

  • Windows: Everything SDK installation required
  • macOS: No additional requirements (uses built-in Spotlight)
  • Linux: locate/plocate package installation required

Full documentation including platform-specific search syntax and capabilities available in the server's README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant