directory-browser-mcp


Namedirectory-browser-mcp JSON
Version 0.1.5 PyPI version JSON
download
home_pageNone
SummaryA secure MCP server for browsing directories and files with access control
upload_time2025-10-11 08:42:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords mcp directory browser file server model-context-protocol
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Directory Browser MCP Server

一个用于浏览目录和文件的MCP (Model Context Protocol) 服务器。

## 功能特性

- 📁 **目录浏览** - 列出指定目录的内容
- 📄 **文件信息** - 获取文件/目录的详细信息
- 🔍 **权限检查** - 检查路径的访问权限
- 🛡️ **安全控制** - 基于白名单的目录访问控制

## 安装

```bash
cd directory_browser_mcp
pip install -e .
```

## 配置

编辑 `config.json` 文件来配置允许访问的目录：

```json
{
  "allowed_directories": [
    "/Users/用户名/Documents",
    "/Users/用户名/Desktop",
    "/项目根目录"
  ],
  "show_hidden_files": false,
  "max_entries": 1000
}
```

## 使用方法

### 作为MCP服务器运行

```bash
python -m directory_browser_mcp
```

### 可用工具

1. **list_directory** - 列出目录内容
   - `path`: 目录路径
   - `show_hidden`: 是否显示隐藏文件 (可选)

2. **get_file_info** - 获取文件详细信息
   - `path`: 文件或目录路径

3. **check_path_access** - 检查路径访问权限
   - `path`: 要检查的路径

## 安全特性

- ✅ 白名单目录访问控制
- ✅ 路径穿越攻击防护
- ✅ 文件系统权限检查
- ✅ 安全错误处理

## 示例

```python
# 列出目录
{
  "tool": "list_directory",
  "arguments": {
    "path": "/Users/username/Documents",
    "show_hidden": false
  }
}

# 获取文件信息
{
  "tool": "get_file_info",
  "arguments": {
    "path": "/Users/username/Documents/file.txt"
  }
}

# 检查访问权限
{
  "tool": "check_path_access",
  "arguments": {
    "path": "/Users/username/Documents"
  }
}
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "directory-browser-mcp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Your Name <your.email@example.com>",
    "keywords": "mcp, directory, browser, file, server, model-context-protocol",
    "author": null,
    "author_email": "Your Name <your.email@example.com>",
    "download_url": "https://files.pythonhosted.org/packages/e9/33/936618203533a701f97c884366033f2aa571200c7a575657d6c1c9fa1220/directory_browser_mcp-0.1.5.tar.gz",
    "platform": null,
    "description": "# Directory Browser MCP Server\n\n\u4e00\u4e2a\u7528\u4e8e\u6d4f\u89c8\u76ee\u5f55\u548c\u6587\u4ef6\u7684MCP (Model Context Protocol) \u670d\u52a1\u5668\u3002\n\n## \u529f\u80fd\u7279\u6027\n\n- \ud83d\udcc1 **\u76ee\u5f55\u6d4f\u89c8** - \u5217\u51fa\u6307\u5b9a\u76ee\u5f55\u7684\u5185\u5bb9\n- \ud83d\udcc4 **\u6587\u4ef6\u4fe1\u606f** - \u83b7\u53d6\u6587\u4ef6/\u76ee\u5f55\u7684\u8be6\u7ec6\u4fe1\u606f\n- \ud83d\udd0d **\u6743\u9650\u68c0\u67e5** - \u68c0\u67e5\u8def\u5f84\u7684\u8bbf\u95ee\u6743\u9650\n- \ud83d\udee1\ufe0f **\u5b89\u5168\u63a7\u5236** - \u57fa\u4e8e\u767d\u540d\u5355\u7684\u76ee\u5f55\u8bbf\u95ee\u63a7\u5236\n\n## \u5b89\u88c5\n\n```bash\ncd directory_browser_mcp\npip install -e .\n```\n\n## \u914d\u7f6e\n\n\u7f16\u8f91 `config.json` \u6587\u4ef6\u6765\u914d\u7f6e\u5141\u8bb8\u8bbf\u95ee\u7684\u76ee\u5f55\uff1a\n\n```json\n{\n  \"allowed_directories\": [\n    \"/Users/\u7528\u6237\u540d/Documents\",\n    \"/Users/\u7528\u6237\u540d/Desktop\",\n    \"/\u9879\u76ee\u6839\u76ee\u5f55\"\n  ],\n  \"show_hidden_files\": false,\n  \"max_entries\": 1000\n}\n```\n\n## \u4f7f\u7528\u65b9\u6cd5\n\n### \u4f5c\u4e3aMCP\u670d\u52a1\u5668\u8fd0\u884c\n\n```bash\npython -m directory_browser_mcp\n```\n\n### \u53ef\u7528\u5de5\u5177\n\n1. **list_directory** - \u5217\u51fa\u76ee\u5f55\u5185\u5bb9\n   - `path`: \u76ee\u5f55\u8def\u5f84\n   - `show_hidden`: \u662f\u5426\u663e\u793a\u9690\u85cf\u6587\u4ef6 (\u53ef\u9009)\n\n2. **get_file_info** - \u83b7\u53d6\u6587\u4ef6\u8be6\u7ec6\u4fe1\u606f\n   - `path`: \u6587\u4ef6\u6216\u76ee\u5f55\u8def\u5f84\n\n3. **check_path_access** - \u68c0\u67e5\u8def\u5f84\u8bbf\u95ee\u6743\u9650\n   - `path`: \u8981\u68c0\u67e5\u7684\u8def\u5f84\n\n## \u5b89\u5168\u7279\u6027\n\n- \u2705 \u767d\u540d\u5355\u76ee\u5f55\u8bbf\u95ee\u63a7\u5236\n- \u2705 \u8def\u5f84\u7a7f\u8d8a\u653b\u51fb\u9632\u62a4\n- \u2705 \u6587\u4ef6\u7cfb\u7edf\u6743\u9650\u68c0\u67e5\n- \u2705 \u5b89\u5168\u9519\u8bef\u5904\u7406\n\n## \u793a\u4f8b\n\n```python\n# \u5217\u51fa\u76ee\u5f55\n{\n  \"tool\": \"list_directory\",\n  \"arguments\": {\n    \"path\": \"/Users/username/Documents\",\n    \"show_hidden\": false\n  }\n}\n\n# \u83b7\u53d6\u6587\u4ef6\u4fe1\u606f\n{\n  \"tool\": \"get_file_info\",\n  \"arguments\": {\n    \"path\": \"/Users/username/Documents/file.txt\"\n  }\n}\n\n# \u68c0\u67e5\u8bbf\u95ee\u6743\u9650\n{\n  \"tool\": \"check_path_access\",\n  \"arguments\": {\n    \"path\": \"/Users/username/Documents\"\n  }\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A secure MCP server for browsing directories and files with access control",
    "version": "0.1.5",
    "project_urls": {
        "Changelog": "https://github.com/yourusername/directory-browser-mcp/releases",
        "Documentation": "https://github.com/yourusername/directory-browser-mcp#readme",
        "Homepage": "https://github.com/yourusername/directory-browser-mcp",
        "Issues": "https://github.com/yourusername/directory-browser-mcp/issues",
        "Repository": "https://github.com/yourusername/directory-browser-mcp"
    },
    "split_keywords": [
        "mcp",
        " directory",
        " browser",
        " file",
        " server",
        " model-context-protocol"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2c3d38108847add267ab5fa41a48002575388640cd155ca23a8d0cdf823fb1e2",
                "md5": "3d6599a16ed84c281e561a42d0392b2b",
                "sha256": "109a48f250837711a648c94b6721ce5dccaae69bde44bc868d34da426e559580"
            },
            "downloads": -1,
            "filename": "directory_browser_mcp-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3d6599a16ed84c281e561a42d0392b2b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 12469,
            "upload_time": "2025-10-11T08:42:31",
            "upload_time_iso_8601": "2025-10-11T08:42:31.596356Z",
            "url": "https://files.pythonhosted.org/packages/2c/3d/38108847add267ab5fa41a48002575388640cd155ca23a8d0cdf823fb1e2/directory_browser_mcp-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e933936618203533a701f97c884366033f2aa571200c7a575657d6c1c9fa1220",
                "md5": "fa6efcb8a4b7377261ad7ee474d71a12",
                "sha256": "921bc7e6201b4b98418a16c315216ea7e3ab35f5b6e6e0a75e1eeb945f20200d"
            },
            "downloads": -1,
            "filename": "directory_browser_mcp-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "fa6efcb8a4b7377261ad7ee474d71a12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 11926,
            "upload_time": "2025-10-11T08:42:33",
            "upload_time_iso_8601": "2025-10-11T08:42:33.341599Z",
            "url": "https://files.pythonhosted.org/packages/e9/33/936618203533a701f97c884366033f2aa571200c7a575657d6c1c9fa1220/directory_browser_mcp-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-11 08:42:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yourusername",
    "github_project": "directory-browser-mcp",
    "github_not_found": true,
    "lcname": "directory-browser-mcp"
}
None
Elapsed time: 2.14959s