| Name | mcp-server-everything-search JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A Model Context Protocol server providing fast file searching using Everything SDK |
| upload_time | 2024-12-16 05:27:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Everything Search MCP Server Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
everything
llm
mcp
search
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Everything Search MCP Server
An MCP server that provides fast file searching capabilities using the Everything SDK.
## Tools
### search
Search for files and folders using Everything SDK.
Parameters:
- `query` (required): Search query string. Supports wildcards (* and ?) and more. See the search syntax guide for more details.
- `max_results` (optional): Maximum number of results to return (default: 100, max: 1000)
- `match_path` (optional): Match against full path instead of filename only (default: false)
- `match_case` (optional): Enable case-sensitive search (default: false)
- `match_whole_word` (optional): Match whole words only (default: false)
- `match_regex` (optional): Enable regex search (default: false)
- `sort_by` (optional): Sort order for results (default: 1). Available options:
- 1 (NAME_ASC): Sort by filename (A to Z)
- 2 (NAME_DESC): Sort by filename (Z to A)
- 3 (PATH_ASC): Sort by path (A to Z)
- 4 (PATH_DESC): Sort by path (Z to A)
- 5 (SIZE_ASC): Sort by size (smallest first)
- 6 (SIZE_DESC): Sort by size (largest first)
- 7 (EXT_ASC): Sort by extension (A to Z)
- 8 (EXT_DESC): Sort by extension (Z to A)
- 11 (CREATED_ASC): Sort by creation date (oldest first)
- 12 (CREATED_DESC): Sort by creation date (newest first)
- 13 (MODIFIED_ASC): Sort by modification date (oldest first)
- 14 (MODIFIED_DESC): Sort by modification date (newest first)
Examples:
```json
{
"query": "*.py",
"max_results": 50
}
```
```json
{
"query": "ext:py datemodified:today",
"max_results": 10
}
```
Response includes:
- File/folder path
- File size in bytes
- Last modified date
<details>
<summary>Search Syntax Guide</summary>
### Basic Operators
- `space`: AND operator
- `|`: OR operator
- `!`: NOT operator
- `< >`: Grouping
- `" "`: Search for an exact phrase
### Wildcards
- `*`: Matches zero or more characters
- `?`: Matches exactly one character
Note: Wildcards match the whole filename by default. Disable Match whole filename to match wildcards anywhere.
### Functions
#### Size and Count
- `size:<size>[kb|mb|gb]`: Search by file size
- `count:<max>`: Limit number of results
- `childcount:<count>`: Folders with specific number of children
- `childfilecount:<count>`: Folders with specific number of files
- `childfoldercount:<count>`: Folders with specific number of subfolders
- `len:<length>`: Match filename length
#### Dates
- `datemodified:<date>, dm:<date>`: Modified date
- `dateaccessed:<date>, da:<date>`: Access date
- `datecreated:<date>, dc:<date>`: Creation date
- `daterun:<date>, dr:<date>`: Last run date
- `recentchange:<date>, rc:<date>`: Recently changed date
Date formats: YYYY[-MM[-DD[Thh[:mm[:ss[.sss]]]]]] or today, yesterday, lastweek, etc.
#### File Attributes and Types
- `attrib:<attributes>, attributes:<attributes>`: Search by file attributes (A:Archive, H:Hidden, S:System, etc.)
- `type:<type>`: Search by file type
- `ext:<list>`: Search by semicolon-separated extensions
#### Path and Name
- `path:<path>`: Search in specific path
- `parent:<path>, infolder:<path>, nosubfolders:<path>`: Search in path excluding subfolders
- `startwith:<text>`: Files starting with text
- `endwith:<text>`: Files ending with text
- `child:<filename>`: Folders containing specific child
- `depth:<count>, parents:<count>`: Files at specific folder depth
- `root`: Files with no parent folder
- `shell:<name>`: Search in known shell folders
#### Duplicates and Lists
- `dupe, namepartdupe, attribdupe, dadupe, dcdupe, dmdupe, sizedupe`: Find duplicates
- `filelist:<list>`: Search pipe-separated (|) file list
- `filelistfilename:<filename>`: Search files from list file
- `frn:<frnlist>`: Search by File Reference Numbers
- `fsi:<index>`: Search by file system index
- `empty`: Find empty folders
### Function Syntax
- `function:value`: Equal to value
- `function:<=value`: Less than or equal
- `function:<value`: Less than
- `function:=value`: Equal to
- `function:>value`: Greater than
- `function:>=value`: Greater than or equal
- `function:start..end`: Range of values
- `function:start-end`: Range of values
### Modifiers
- `case:, nocase:: Enable/disable case sensitivity
- `file:, folder:: Match only files or folders
- `path:, nopath:: Match full path or filename only
- `regex:, noregex:: Enable/disable regex
- `wfn:, nowfn:: Match whole filename or anywhere
- `wholeword:, ww:: Match whole words only
- `wildcards:, nowildcards:: Enable/disable wildcards
### Examples
1. Find Python files modified today:
`ext:py datemodified:today`
2. Find large video files:
`ext:mp4|mkv|avi size:>1gb`
3. Find files in specific folder:
`path:C:\Projects *.js`
</details>
## Prerequisites
1. Windows operating system (required - this server only works on Windows)
2. [Everything](https://www.voidtools.com/) search utility:
- Download and install from https://www.voidtools.com/
- **Make sure the Everything service is running**
3. Everything SDK:
- Download from https://www.voidtools.com/support/everything/sdk/
- Extract the SDK files to a location on your system
## Installation
### Using uv (recommended)
When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-everything-search*.
### Using PIP
Alternatively you can install `mcp-server-everything-search` via pip:
```
pip install mcp-server-everything-search
```
After installation, you can run it as a script using:
```
python -m mcp_server_everything_search
```
## Configuration
The server requires the Everything SDK DLL to be available:
Environment variable:
```
EVERYTHING_SDK_PATH=path\to\Everything-SDK\dll\Everything64.dll
```
### Usage with Claude Desktop
Add this to your `claude_desktop_config.json`:
<details>
<summary>Using uvx</summary>
```json
"mcpServers": {
"everything-search": {
"command": "uvx",
"args": ["mcp-server-everything-search"],
"env": {
"EVERYTHING_SDK_PATH": "path/to/Everything-SDK/dll/Everything64.dll"
}
}
}
```
</details>
<details>
<summary>Using pip installation</summary>
```json
"mcpServers": {
"everything-search": {
"command": "python",
"args": ["-m", "mcp_server_everything_search"],
"env": {
"EVERYTHING_SDK_PATH": "path/to/Everything-SDK/dll/Everything64.dll"
}
}
}
```
</details>
## Debugging
You can use the MCP inspector to debug the server. For uvx installations:
```
npx @modelcontextprotocol/inspector uvx mcp-server-everything-search
```
Or if you've installed the package in a specific directory or are developing on it:
```
git clone https://github.com/mamertofabian/mcp-everything-search.git
cd mcp-everything-search/src/mcp_server_everything_search
npx @modelcontextprotocol/inspector uv run mcp-server-everything-search
```
Using PowerShell, running `Get-Content -Path "$env:APPDATA\Claude\logs\mcp*.log" -Tail 20 -Wait` will show the logs from the server and may help you debug any issues.
## Development
If you are doing local development, there are two ways to test your changes:
1. Run the MCP inspector to test your changes. See [Debugging](#debugging) for run instructions.
2. Test using the Claude desktop app. Add the following to your `claude_desktop_config.json`:
```json
"everything-search": {
"command": "uv",
"args": [
"--directory",
"/path/to/mcp-everything-search/src/mcp_server_everything_search",
"run",
"mcp-server-everything-search"
],
"env": {
"EVERYTHING_SDK_PATH": "path/to/Everything-SDK/dll/Everything64.dll"
}
}
```
## License
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
## Disclaimer
This project is not affiliated with, endorsed by, or sponsored by voidtools (the creators of Everything search utility). This is an independent project that utilizes the publicly available Everything SDK.
Raw data
{
"_id": null,
"home_page": null,
"name": "mcp-server-everything-search",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "everything, llm, mcp, search",
"author": null,
"author_email": "Mamerto Fabian <aidrivencoder@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/32/8d/508f6724ee69f7e851d62409f1ecbc043320125970441d35b7ab1122d49d/mcp_server_everything_search-0.1.2.tar.gz",
"platform": null,
"description": "# Everything Search MCP Server\n\nAn MCP server that provides fast file searching capabilities using the Everything SDK.\n\n## Tools\n\n### search\n\nSearch for files and folders using Everything SDK.\n\nParameters:\n- `query` (required): Search query string. Supports wildcards (* and ?) and more. See the search syntax guide for more details.\n- `max_results` (optional): Maximum number of results to return (default: 100, max: 1000)\n- `match_path` (optional): Match against full path instead of filename only (default: false)\n- `match_case` (optional): Enable case-sensitive search (default: false)\n- `match_whole_word` (optional): Match whole words only (default: false)\n- `match_regex` (optional): Enable regex search (default: false)\n- `sort_by` (optional): Sort order for results (default: 1). Available options:\n - 1 (NAME_ASC): Sort by filename (A to Z)\n - 2 (NAME_DESC): Sort by filename (Z to A)\n - 3 (PATH_ASC): Sort by path (A to Z)\n - 4 (PATH_DESC): Sort by path (Z to A)\n - 5 (SIZE_ASC): Sort by size (smallest first)\n - 6 (SIZE_DESC): Sort by size (largest first)\n - 7 (EXT_ASC): Sort by extension (A to Z)\n - 8 (EXT_DESC): Sort by extension (Z to A)\n - 11 (CREATED_ASC): Sort by creation date (oldest first)\n - 12 (CREATED_DESC): Sort by creation date (newest first)\n - 13 (MODIFIED_ASC): Sort by modification date (oldest first)\n - 14 (MODIFIED_DESC): Sort by modification date (newest first)\n\nExamples:\n```json\n{\n \"query\": \"*.py\",\n \"max_results\": 50\n}\n```\n\n```json\n{\n \"query\": \"ext:py datemodified:today\",\n \"max_results\": 10\n}\n```\n\nResponse includes:\n- File/folder path\n- File size in bytes\n- Last modified date\n\n<details>\n<summary>Search Syntax Guide</summary>\n\n### Basic Operators\n- `space`: AND operator\n- `|`: OR operator\n- `!`: NOT operator\n- `< >`: Grouping\n- `\" \"`: Search for an exact phrase\n\n### Wildcards\n- `*`: Matches zero or more characters\n- `?`: Matches exactly one character\n\nNote: Wildcards match the whole filename by default. Disable Match whole filename to match wildcards anywhere.\n\n### Functions\n\n#### Size and Count\n- `size:<size>[kb|mb|gb]`: Search by file size\n- `count:<max>`: Limit number of results\n- `childcount:<count>`: Folders with specific number of children\n- `childfilecount:<count>`: Folders with specific number of files\n- `childfoldercount:<count>`: Folders with specific number of subfolders\n- `len:<length>`: Match filename length\n\n#### Dates\n- `datemodified:<date>, dm:<date>`: Modified date\n- `dateaccessed:<date>, da:<date>`: Access date\n- `datecreated:<date>, dc:<date>`: Creation date\n- `daterun:<date>, dr:<date>`: Last run date\n- `recentchange:<date>, rc:<date>`: Recently changed date\n\nDate formats: YYYY[-MM[-DD[Thh[:mm[:ss[.sss]]]]]] or today, yesterday, lastweek, etc.\n\n#### File Attributes and Types\n- `attrib:<attributes>, attributes:<attributes>`: Search by file attributes (A:Archive, H:Hidden, S:System, etc.)\n- `type:<type>`: Search by file type\n- `ext:<list>`: Search by semicolon-separated extensions\n\n#### Path and Name\n- `path:<path>`: Search in specific path\n- `parent:<path>, infolder:<path>, nosubfolders:<path>`: Search in path excluding subfolders\n- `startwith:<text>`: Files starting with text\n- `endwith:<text>`: Files ending with text\n- `child:<filename>`: Folders containing specific child\n- `depth:<count>, parents:<count>`: Files at specific folder depth\n- `root`: Files with no parent folder\n- `shell:<name>`: Search in known shell folders\n\n#### Duplicates and Lists\n- `dupe, namepartdupe, attribdupe, dadupe, dcdupe, dmdupe, sizedupe`: Find duplicates\n- `filelist:<list>`: Search pipe-separated (|) file list\n- `filelistfilename:<filename>`: Search files from list file\n- `frn:<frnlist>`: Search by File Reference Numbers\n- `fsi:<index>`: Search by file system index\n- `empty`: Find empty folders\n\n### Function Syntax\n\n- `function:value`: Equal to value\n- `function:<=value`: Less than or equal\n- `function:<value`: Less than\n- `function:=value`: Equal to\n- `function:>value`: Greater than\n- `function:>=value`: Greater than or equal\n- `function:start..end`: Range of values\n- `function:start-end`: Range of values\n\n### Modifiers\n\n- `case:, nocase:: Enable/disable case sensitivity\n- `file:, folder:: Match only files or folders\n- `path:, nopath:: Match full path or filename only\n- `regex:, noregex:: Enable/disable regex\n- `wfn:, nowfn:: Match whole filename or anywhere\n- `wholeword:, ww:: Match whole words only\n- `wildcards:, nowildcards:: Enable/disable wildcards\n\n### Examples\n\n1. Find Python files modified today:\n `ext:py datemodified:today`\n\n2. Find large video files:\n `ext:mp4|mkv|avi size:>1gb`\n\n3. Find files in specific folder:\n `path:C:\\Projects *.js`\n\n</details>\n\n## Prerequisites\n\n1. Windows operating system (required - this server only works on Windows)\n2. [Everything](https://www.voidtools.com/) search utility:\n - Download and install from https://www.voidtools.com/\n - **Make sure the Everything service is running**\n3. Everything SDK:\n - Download from https://www.voidtools.com/support/everything/sdk/\n - Extract the SDK files to a location on your system\n\n## Installation\n\n### Using uv (recommended)\n\nWhen using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will\nuse [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-everything-search*.\n\n### Using PIP\n\nAlternatively you can install `mcp-server-everything-search` via pip:\n\n```\npip install mcp-server-everything-search\n```\n\nAfter installation, you can run it as a script using:\n\n```\npython -m mcp_server_everything_search\n```\n\n## Configuration\n\nThe server requires the Everything SDK DLL to be available:\n\nEnvironment variable:\n ```\n EVERYTHING_SDK_PATH=path\\to\\Everything-SDK\\dll\\Everything64.dll\n ```\n\n### Usage with Claude Desktop\n\nAdd this to your `claude_desktop_config.json`:\n\n<details>\n<summary>Using uvx</summary>\n\n```json\n\"mcpServers\": {\n \"everything-search\": {\n \"command\": \"uvx\",\n \"args\": [\"mcp-server-everything-search\"],\n \"env\": {\n \"EVERYTHING_SDK_PATH\": \"path/to/Everything-SDK/dll/Everything64.dll\"\n }\n }\n}\n```\n</details>\n\n<details>\n<summary>Using pip installation</summary>\n\n```json\n\"mcpServers\": {\n \"everything-search\": {\n \"command\": \"python\",\n \"args\": [\"-m\", \"mcp_server_everything_search\"],\n \"env\": {\n \"EVERYTHING_SDK_PATH\": \"path/to/Everything-SDK/dll/Everything64.dll\"\n }\n }\n}\n```\n</details>\n\n## Debugging\n\nYou can use the MCP inspector to debug the server. For uvx installations:\n\n```\nnpx @modelcontextprotocol/inspector uvx mcp-server-everything-search\n```\n\nOr if you've installed the package in a specific directory or are developing on it:\n\n```\ngit clone https://github.com/mamertofabian/mcp-everything-search.git\ncd mcp-everything-search/src/mcp_server_everything_search\nnpx @modelcontextprotocol/inspector uv run mcp-server-everything-search\n```\n\nUsing PowerShell, running `Get-Content -Path \"$env:APPDATA\\Claude\\logs\\mcp*.log\" -Tail 20 -Wait` will show the logs from the server and may help you debug any issues.\n\n## Development\n\nIf you are doing local development, there are two ways to test your changes:\n\n1. Run the MCP inspector to test your changes. See [Debugging](#debugging) for run instructions.\n\n2. Test using the Claude desktop app. Add the following to your `claude_desktop_config.json`:\n\n```json\n\"everything-search\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcp-everything-search/src/mcp_server_everything_search\",\n \"run\",\n \"mcp-server-everything-search\"\n ],\n \"env\": {\n \"EVERYTHING_SDK_PATH\": \"path/to/Everything-SDK/dll/Everything64.dll\"\n }\n}\n```\n\n## License\n\nThis MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.\n\n## Disclaimer\n\nThis project is not affiliated with, endorsed by, or sponsored by voidtools (the creators of Everything search utility). This is an independent project that utilizes the publicly available Everything SDK.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Everything Search MCP Server Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Model Context Protocol server providing fast file searching using Everything SDK",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"everything",
" llm",
" mcp",
" search"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c393536c9b6ecd3999ac97358168ca4b308140203d8cd711828c555fe6ceada7",
"md5": "adb88f290b37050fd6c44ea0cccc549b",
"sha256": "19dcbff9cd15a63cfc063f66ad790574bbf737a8d4a3c14d5ad80145b2d92176"
},
"downloads": -1,
"filename": "mcp_server_everything_search-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adb88f290b37050fd6c44ea0cccc549b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13259,
"upload_time": "2024-12-16T05:27:56",
"upload_time_iso_8601": "2024-12-16T05:27:56.200598Z",
"url": "https://files.pythonhosted.org/packages/c3/93/536c9b6ecd3999ac97358168ca4b308140203d8cd711828c555fe6ceada7/mcp_server_everything_search-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "328d508f6724ee69f7e851d62409f1ecbc043320125970441d35b7ab1122d49d",
"md5": "dfc34ca536dd01a984e043620ad948df",
"sha256": "93121ace914f62657d98c4df4cb8ddec77a2a66b7c0706b30c340e0807538bbe"
},
"downloads": -1,
"filename": "mcp_server_everything_search-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "dfc34ca536dd01a984e043620ad948df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 27948,
"upload_time": "2024-12-16T05:27:58",
"upload_time_iso_8601": "2024-12-16T05:27:58.654306Z",
"url": "https://files.pythonhosted.org/packages/32/8d/508f6724ee69f7e851d62409f1ecbc043320125970441d35b7ab1122d49d/mcp_server_everything_search-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 05:27:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcp-server-everything-search"
}
