A
securityA
licenseA
qualityProvides tools for collecting and documenting code from directories.
Last updated -
4
73
15
MIT License
Recognizes and automatically excludes Git directories (.git) during project exploration and file searches.
Provides reference to the project's GitHub repository, enabling users to find the source code and contribute to development.
Enables searching and analyzing Node.js projects, including checking for outdated npm packages and analyzing import/export statements in JavaScript files.
Provides tools for analyzing npm dependencies, checking for outdated packages, and offering detailed update recommendations with version information.
Supports analysis of TypeScript projects with specialized features for detecting import/export statements and searching through TypeScript files.
š Project Explorer MCP Server
A powerful Model Context Protocol server for exploring, analyzing, and managing project files with advanced search capabilities
š¦ Available on npm:
@team-jd/mcp-project-explorer
ā” Quick Start
{
"mcpServers": {
"project-explorer": {
"command": "npx",
"args": ["-y", "@team-jd/mcp-project-explorer", "/your/project/path"]
}
}
}
š Overview
The Project Explorer MCP Server provides comprehensive tools for analyzing project structures, searching through codebases, managing dependencies, and performing file operations. Perfect for developers who need intelligent project navigation and analysis capabilities.
š¦ Installation & Setup
š For MCP Users (Recommended)
Add this server to your MCP settings configuration:
{
"mcpServers": {
"project-explorer": {
"command": "npx",
"args": [
"-y",
"@team-jd/mcp-project-explorer",
"/path/to/your/project"
]
}
}
}
š Multiple Directory Access:
{
"mcpServers": {
"project-explorer": {
"command": "npx",
"args": [
"-y",
"@team-jd/mcp-project-explorer",
"/path/to/project1",
"/path/to/project2",
"/path/to/project3"
]
}
}
}
š ļø For Developers
# Clone and setup for development
git clone https://github.com/MausRundung362/mcp-explorer.git
cd mcp-explorer
# Install dependencies
npm install
# Build the project
npm run build
# Run the MCP inspector for testing
npm run inspector
š ļø Available Commands
š explore_project
Analyzes project structure with detailed file information and import/export analysis
// Basic usage
explore_project({
directory: "/path/to/project"
})
// Advanced usage
explore_project({
directory: "/path/to/project",
subDirectory: "src", // Optional: focus on specific subdirectory
includeHidden: false // Optional: include hidden files (default: false)
})
āØ Features:
š File size analysis with human-readable formatting
š Import/export statement detection for JS/TS files
š« Automatically excludes build directories (
node_modules,.git,dist,.vscode,.gradle,.idea, etc.)š Recursive directory traversal
šÆ Support for subdirectory analysis
š search_files
Advanced file and code search with comprehensive filtering capabilities
// Simple text search
search_files({
pattern: "your search term",
searchPath: "/path/to/search"
})
// Advanced search with filters
search_files({
pattern: "function.*async", // Regex pattern
searchPath: "/path/to/search",
regexMode: true, // Enable regex
caseSensitive: false, // Case sensitivity
extensions: [".js", ".ts"], // File types to include
excludeExtensions: [".min.js"], // File types to exclude
excludeComments: true, // Skip comments
excludeStrings: true, // Skip string literals
maxResults: 50, // Limit results
sortBy: "relevance" // Sort method
})
šļø Search Options:
Parameter | Type | Default | Description |
| string |
| Search pattern (text or regex) |
| string | first allowed dir | Directory to search in |
| string[] | all | Include only these file types |
| string[] |
| Exclude these file types |
| string[] |
| Exclude filename patterns |
| boolean |
| Treat pattern as regex |
| boolean |
| Case-sensitive search |
| boolean |
| Match whole words only |
| boolean |
| Multiline regex matching |
| number | unlimited | Directory recursion depth |
| boolean |
| Follow symbolic links |
| boolean |
| Search in binary files |
| number | none | Minimum file size (bytes) |
| number | none | Maximum file size (bytes) |
| string | none | Files modified after date (ISO 8601) |
| string | none | Files modified before date (ISO 8601) |
| number |
| Text snippet length around matches |
| number |
| Maximum number of results |
| string |
| Sort by: relevance, file, lineNumber, modified, size |
| boolean |
| Group results by file |
| boolean |
| Skip comments (language-aware) |
| boolean |
| Skip string literals |
| string |
| Output format: text, json, structured |
šÆ Use Cases:
š Find all TODO comments:
pattern: "TODO.*", excludeStrings: trueš Search for potential bugs:
pattern: "console\\.log", regexMode: trueš¦ Find import statements:
pattern: "import.*from", regexMode: trueš§ Recent changes:
modifiedAfter: "2024-01-01", extensions: [".js", ".ts"]
š check_outdated
Checks for outdated npm packages with detailed analysis
// Basic check
check_outdated({
projectPath: "/path/to/project"
})
// Detailed analysis
check_outdated({
projectPath: "/path/to/project",
includeDevDependencies: true, // Include dev dependencies
outputFormat: "detailed" // detailed, summary, or raw
})
š Output Formats:
detailed- Full package info with versions and update commandssummary- Count of outdated packages by typeraw- Raw npm outdated JSON output
š§ Requirements:
Node.js and npm must be installed
Valid
package.jsonin the specified directory
šļø delete_file
Safely delete files or directories with protection mechanisms
// Delete a file
delete_file({
path: "/path/to/file.txt"
})
// Delete a directory (requires recursive flag)
delete_file({
path: "/path/to/directory",
recursive: true, // Required for directories
force: false // Force deletion of read-only files
})
ā ļø Safety Features:
š Only works within allowed directories
š Requires
recursive: truefor non-empty directoriesš”ļø Protection against accidental deletions
ā” Optional force deletion for read-only files
āļø rename_file
Rename or move files and directories
// Simple rename
rename_file({
oldPath: "/path/to/old-name.txt",
newPath: "/path/to/new-name.txt"
})
// Move to different directory
rename_file({
oldPath: "/path/to/file.txt",
newPath: "/different/path/file.txt"
})
āØ Features:
š Works with both files and directories
š Can move between directories
š« Fails if destination already exists
š Both paths must be within allowed directories
š list_allowed_directories
Shows which directories the server can access
list_allowed_directories()
š§ Use Cases:
š Check access permissions before operations
š”ļø Security validation
š Directory discovery
šØ Usage Examples
š Project Analysis Workflow
// 1. Check what directories you can access
list_allowed_directories()
// 2. Explore the project structure
explore_project({
directory: "/your/project/path",
includeHidden: false
})
// 3. Search for specific patterns
search_files({
pattern: "useState",
searchPath: "/your/project/path",
extensions: [".jsx", ".tsx"],
excludeComments: true
})
// 4. Check for outdated dependencies
check_outdated({
projectPath: "/your/project/path",
outputFormat: "detailed"
})
š Advanced Search Scenarios
// Find all async functions
search_files({
pattern: "async\\s+function",
regexMode: true,
extensions: [".js", ".ts"]
})
// Find large files modified recently
search_files({
pattern: ".*",
minSize: 1000000, // 1MB+
modifiedAfter: "2024-01-01",
sortBy: "size"
})
// Find TODO comments excluding test files
search_files({
pattern: "TODO|FIXME|BUG",
regexMode: true,
excludePatterns: ["*test*", "*spec*"],
excludeStrings: true
})
š”ļø Security & Permissions
The server operates within allowed directories only, providing:
š Sandboxed access - Cannot access files outside allowed paths
š”ļø Safe operations - Built-in protections against dangerous operations
š Path validation - All paths are normalized and validated
ā ļø Error handling - Clear error messages for permission issues
š§ Development
š Project Structure
src/
āāā index.ts # Main server entry point
āāā explore-project.ts # Project analysis tool
āāā search.ts # Advanced search functionality
āāā check-outdated.ts # NPM dependency checker
āāā delete-file.ts # File deletion tool
āāā rename-file.ts # File rename/move tool
āāā list-allowed.ts # Directory permission checker
šļø Build Commands
npm run build # Compile TypeScript
npm run watch # Watch mode for development
npm run inspector # Test with MCP inspector
š¤ Contributing
š“ Fork the repository
š Create a feature branch
š» Make your changes
ā Test thoroughly
š Submit a pull request
š License
See LICENSE file for details.
Happy coding! š
Built with ā¤ļø using TypeScript and the Model Context Protocol
local-only server
The server can only run on the client's local machine because it depends on local resources.
Provides tools for analyzing project structures, searching through codebases, managing dependencies, and performing file operations with advanced filtering capabilities.
Related MCP Servers
- AsecurityAlicenseAqualityAnalyzes source code dependencies across multiple programming languages in the specified directory to identify file relationships, assisting in dependency management and project structure understanding.Last updated -11MIT License
- -securityFlicense-qualityA local server that provides powerful code analysis and search capabilities for software projects, helping AI assistants and development tools understand codebases for tasks like code generation and refactoring.Last updated -4
- AsecurityFlicenseAqualityEnables comprehensive directory analysis and file management operations including project structure exploration, intelligent file search, full CRUD operations on files and directories, batch operations with rollback capabilities, and Git integration.Last updated -134